Update docker.rst
Use `parsed-literal` where substitution is needed.
This commit is contained in:
parent
45132dea75
commit
dc1d9ae4ad
|
@ -0,0 +1 @@
|
||||||
|
Simplify Docker mono-container installation and upgrade documentation
|
|
@ -42,30 +42,19 @@ Mono-container installation
|
||||||
Basically, you need to pull the new container image, stop and delete your existing container,
|
Basically, you need to pull the new container image, stop and delete your existing container,
|
||||||
and relaunch a new one:
|
and relaunch a new one:
|
||||||
|
|
||||||
.. parsed-literal::
|
To upgrade your service, change the version number of the image in ``docker-compose.yml`` with the latest release (i.e. |version|).
|
||||||
# this assumes you want to upgrade to version "|version|"
|
|
||||||
export FUNKWHALE_VERSION="|version|"
|
Pull the new images:
|
||||||
|
|
||||||
.. code-block:: shell
|
.. code-block:: shell
|
||||||
|
|
||||||
docker pull funkwhale/all-in-one:$FUNKWHALE_VERSION
|
docker-compose pull
|
||||||
docker stop funkwhale
|
|
||||||
docker rm funkwhale
|
|
||||||
docker run \
|
|
||||||
--name=funkwhale \
|
|
||||||
--restart=unless-stopped \
|
|
||||||
--env-file=/srv/funkwhale/.env \
|
|
||||||
-v /srv/funkwhale/data:/data \
|
|
||||||
-v /path/to/your/music/dir:/music:ro \
|
|
||||||
-e PUID=$UID \
|
|
||||||
-e PGID=$GID \
|
|
||||||
-p 5000:80 \
|
|
||||||
-d \
|
|
||||||
funkwhale/all-in-one:$FUNKWHALE_VERSION
|
|
||||||
|
|
||||||
If you are not managing the container directly by hand, but use a third party tool such as Portainer,
|
Restart the service:
|
||||||
instructions will vary, but, as a rule of thumb, pulling the new version of the image, and relaunch
|
|
||||||
a new container with the same arguments as the previous one (except for the image version) is enough.
|
.. code-block:: shell
|
||||||
|
|
||||||
|
docker-compose up -d
|
||||||
|
|
||||||
Multi-container installation
|
Multi-container installation
|
||||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
|
@ -55,9 +55,7 @@ Log in as the newly created user from now on:
|
||||||
Create ``.env`` file
|
Create ``.env`` file
|
||||||
~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
Export the `version you want <https://hub.docker.com/r/funkwhale/all-in-one/tags>`_ to deploy (e.g., ``0.21``):
|
Create a ``.env`` file to store a few important configuration options:
|
||||||
|
|
||||||
Create an env file to store a few important configuration options:
|
|
||||||
|
|
||||||
.. code-block:: shell
|
.. code-block:: shell
|
||||||
|
|
||||||
|
@ -83,7 +81,9 @@ Create an env file to store a few important configuration options:
|
||||||
Create ``docker-compose.yml`` file
|
Create ``docker-compose.yml`` file
|
||||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||||
|
|
||||||
.. code-block:: yaml
|
Create a ``docker-compose.yml`` file to set up the containers:
|
||||||
|
|
||||||
|
.. parsed-literal::
|
||||||
|
|
||||||
version: "3"
|
version: "3"
|
||||||
services:
|
services:
|
||||||
|
@ -105,6 +105,7 @@ Create ``docker-compose.yml`` file
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
|
|
||||||
|
- The version can be changed (after ``funkwhale/all-in-one:``), `select the version <https://hub.docker.com/r/funkwhale/all-in-one/tags>`_ you want to deploy.
|
||||||
- ``PUID`` and ``PGID`` are optional but useful to prevent permission issues with docker volumes
|
- ``PUID`` and ``PGID`` are optional but useful to prevent permission issues with docker volumes
|
||||||
- ``/path/to/your/music/dir`` should point to a path on your host where music you would like to import is located. You can safely remove the volume if you don't want to import music that way.
|
- ``/path/to/your/music/dir`` should point to a path on your host where music you would like to import is located. You can safely remove the volume if you don't want to import music that way.
|
||||||
|
|
||||||
|
@ -129,12 +130,6 @@ Useful commands:
|
||||||
|
|
||||||
Now, you just need to configure your :ref:`reverse-proxy <reverse-proxy-setup>`. Don't worry, it's quite easy.
|
Now, you just need to configure your :ref:`reverse-proxy <reverse-proxy-setup>`. Don't worry, it's quite easy.
|
||||||
|
|
||||||
.. note::
|
|
||||||
|
|
||||||
To upgrade your service, change the version number in ``docker-compose.yml`` and re-run ``docker-compose up -d``.
|
|
||||||
|
|
||||||
Don't forget you might have manual changes to do when upgrading to a newer version.
|
|
||||||
|
|
||||||
.. _docker-multi-container:
|
.. _docker-multi-container:
|
||||||
|
|
||||||
Multi-container installation
|
Multi-container installation
|
||||||
|
|
Loading…
Reference in New Issue