diff --git a/changes/changelog.d/2050.doc b/changes/changelog.d/2050.doc new file mode 100644 index 000000000..f452eefb0 --- /dev/null +++ b/changes/changelog.d/2050.doc @@ -0,0 +1 @@ +Added Nginx regeneration instructions to Debian update guide (#2050) diff --git a/docs/administrator/upgrade/debian.md b/docs/administrator/upgrade/debian.md index b7e14c745..b7fba957e 100644 --- a/docs/administrator/upgrade/debian.md +++ b/docs/administrator/upgrade/debian.md @@ -31,9 +31,48 @@ If you installed Funkwhale following the [Debian guide](../installation/debian.m ``` 2. Follow the [Download Funkwhale](../installation/debian.md#3-download-funkwhale) instructions in the installation guide. - 3. Follow the [Install the Funkwhale API](../installation/debian.md#4-install-the-funkwhale-api) instructions in the installation guide. + +## Update your reverse proxy configuration + +To ensure your reverse proxy is up-to-date with changes, you should regenerate your Nginx configuration with each upgrade. To do this: + +1. Log in to a root shell to make changes to the config files + + ```console + $ sudo su + ``` + +2. Download the new Nginx templates from Funkwhale + + ```console + # curl -L -o /etc/nginx/funkwhale_proxy.conf "https://dev.funkwhale.audio/funkwhale/funkwhale/raw/$FUNKWHALE_VERSION/deploy/funkwhale_proxy.conf" + # curl -L -o /etc/nginx/sites-available/funkwhale.template "https://dev.funkwhale.audio/funkwhale/funkwhale/raw/$FUNKWHALE_VERSION/deploy/nginx.template" + ``` + +3. Update the Nginx configuration with details from your {file}`.env` file + + ```console + # set -a && source /srv/funkwhale/config/.env && set +a + envsubst "`env | awk -F = '{printf \" $%s\", $$1}'`" \ + < /etc/nginx/sites-available/funkwhale.template \ + > /etc/nginx/sites-available/funkwhale.conf + ``` + +4. Check the configuration file to make sure the template values have been updated properly + + ```console + # grep '${' /etc/nginx/sites-enabled/funkwhale.conf + ``` + +5. Restart Nginx + + ```console + # systemctl restart nginx + ``` + + ## Update your Funkwhale instance Once you have downloaded the new files, you can update your Funkwhale instance. To do this: