Updated mono-container documentation with compose file and NESTED_PROXY

This commit is contained in:
Eliot Berriot 2019-03-21 10:07:14 +01:00
parent 7d3b9717ea
commit 5f9df61e7e
No known key found for this signature in database
GPG Key ID: DD6965E2476E5C27
3 changed files with 41 additions and 0 deletions

View File

@ -0,0 +1 @@
Avoid mixed content when deploying mono-container behind HTTPS proxy (thetarkus/docker-funkwhale#19)

View File

@ -5,3 +5,16 @@ Next release notes
Those release notes refer to the current development branch and are reset Those release notes refer to the current development branch and are reset
after each release. after each release.
Avoid mixed content when deploying mono-container behind proxy [Manual action required]
---------------------------------------------------------------------------------------------
*You are only concerned if you use the mono-container docker deployment behind a reverse proxy*
Because of `an issue in our mono-container configuration <https://github.com/thetarkus/docker-funkwhale/issues/19>`_, users deploying Funkwhale via docker
using our `funkwhale/all-in-one` image could face some mixed content warnings (and possibly other troubles)
when browsing the Web UI.
This is fixed in this release, but on existing deployments, you'll need to add ``NESTED_PROXY=1`` in your container
environment (either in your ``.env`` file, or via your container management tool), then recreate your funkwhale container.

View File

@ -53,6 +53,8 @@ Create an env file to store a few important configuration options:
echo "FUNKWHALE_HOSTNAME=yourdomain.funkwhale" >> .env echo "FUNKWHALE_HOSTNAME=yourdomain.funkwhale" >> .env
echo "FUNKWHALE_PROTOCOL=https" >> .env # or http echo "FUNKWHALE_PROTOCOL=https" >> .env # or http
echo "DJANGO_SECRET_KEY=$(openssl rand -hex 45)" >> .env # generate and store a secure secret key for your instance echo "DJANGO_SECRET_KEY=$(openssl rand -hex 45)" >> .env # generate and store a secure secret key for your instance
# Remove this if you expose the container directly on ports 80/443
echo "NESTED_PROXY=1" >> .env
Then start the container: Then start the container:
@ -112,6 +114,31 @@ Useful commands:
-d \ -d \
funkwhale/all-in-one:$FUNKWHALE_VERSION funkwhale/all-in-one:$FUNKWHALE_VERSION
You can use the following docker-compose file to make the management process easier:
.. code-block:: yaml
version: "3"
services:
funkwhale:
container_name: funkwhale
restart: unless-stopped
# add the version number in your .env file, or hardcode it
image: funkwhale/all-in-one:${FUNKWHALE_VERSION}
env_file: .env
environment:
# adapt to the pid/gid that own /srv/funkwhale/data
- PUID=1000
- PGID=1000
volumes:
- /srv/funkwhale/data:/data
- /path/to/your/music/dir:/music:ro
ports:
- "5000:80"
.. _docker-multi-container: .. _docker-multi-container:
Multi-container installation Multi-container installation