From ee5e7f5f05e5603b1c9e51816055b5755035452e Mon Sep 17 00:00:00 2001 From: Nathanael <roipoussiere@protonmail.com> Date: Sun, 25 Nov 2018 16:53:44 +0000 Subject: [PATCH] Update docker.rst --- docs/installation/docker.rst | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/docs/installation/docker.rst b/docs/installation/docker.rst index 8b594eaa..185e7438 100644 --- a/docs/installation/docker.rst +++ b/docs/installation/docker.rst @@ -3,18 +3,30 @@ Docker installation Docker is the easiest way to get a Funkwhale instance up and running. -First, ensure you have `Docker <https://docs.docker.com/engine/installation/>`_ and `docker-compose <https://github.com/docker/compose/releases>`_ installed. +First, ensure you have `Docker <https://docs.docker.com/engine/installation/>`_ and `docker-compose <https://docs.docker.com/compose/install/>`_ installed. Download the sample docker-compose file: .. parsed-literal:: + mkdir /srv/funkwhale cd /srv/funkwhale mkdir nginx curl -L -o nginx/funkwhale.template "https://code.eliotberriot.com/funkwhale/funkwhale/raw/develop/deploy/docker.nginx.template" curl -L -o nginx/funkwhale_proxy.conf "https://code.eliotberriot.com/funkwhale/funkwhale/raw/develop/deploy/funkwhale_proxy.conf" curl -L -o docker-compose.yml "https://code.eliotberriot.com/funkwhale/funkwhale/raw/develop/deploy/docker-compose.yml" +At this point, the archticture of ``/srv/funkwhale`` should look like that: + +:: + + . + ├── docker-compose.yml + ├── .env + └── nginx + ├── funkwhale_proxy.conf + └── funkwhale.template + Create your env file: .. parsed-literal:: @@ -22,8 +34,10 @@ Create your env file: export FUNKWHALE_VERSION="|version|" curl -L -o .env "https://code.eliotberriot.com/funkwhale/funkwhale/raw/develop/deploy/env.prod.sample" sed -i "s/FUNKWHALE_VERSION=latest/FUNKWHALE_VERSION=$FUNKWHALE_VERSION/" .env + sudo nano .env -Ensure to edit it to match your needs (this file is heavily commented) +Ensure to edit it to match your needs (this file is heavily commented), in particular ``DJANGO_SECRET_KEY`` and ``FUNKWHALE_HOSTNAME``. +You should take a look at the `configuration reference <https://docs.funkwhale.audio/configuration.html#configuration-reference>`_ for more detailed information regarding each setting. Then, you should be able to pull the required images: -- GitLab