Verified Commit 1c251ac7 authored by Eliot Berriot's avatar Eliot Berriot
Browse files

Fix #127: Added upgrade documentation

parent 2cfe4fa3
Pipeline #592 passed with stage
in 1 minute and 32 seconds
......@@ -15,6 +15,7 @@ Funkwhale is a self-hosted, modern free and open-source music server, heavily in
Indices and tables
Upgrading your funkwhale instance to a newer version
.. note::
Before upgrading your instance, we strongly advise you to make a database
backup. We're commited to make upgrade as easy and straightforward as possible,
however, funkwhale is still in development and you'll be safer with a backup.
Reading the release notes
Please take a few minutes to read the :doc:`changelog`: updates should work
similarly from version to version, but some of them may require additional steps.
Those steps would be described in the version release notes.
Upgrade the static files
Regardless of your deployment choice (docker/non-docker) the front-end app
is updated separately from the API. This is as simple as downloading
the zip with the static files and extracting it in the correct place.
The following example assume your setup match :ref:`frontend-setup`.
.. parsed-literal::
# this assumes you want to upgrade to version "|version|"
export FUNKWHALE_VERSION="|version|"
cd /srv/funkwhale
curl -L -o "$FUNKWHALE_VERSION/download?job=build_front"
unzip -o
Upgrading the API
Docker setup
If you've followed the setup instructions in :doc:`Docker`, upgrade path is
.. parsed-literal::
cd /srv/funkwhale
# hardcode the targeted version your env file
# (look for the FUNKWHALE_VERSION variable)
nano .env
# Pull the new version containers
docker-compose pull
# Apply the database migrations
docker-compose run --rm api python migrate
# Relaunch the containers
docker-compose up -d
Non-docker setup
On non docker-setup, upgrade involves a few more commands. We assume your setup
match what is described in :doc:`debian`:
.. parsed-literal::
# this assumes you want to upgrade to version "|version|"
export FUNKWALE_VERSION="|version|"
cd /srv/funkwhale
# download more recent API files
curl -L -o "api-|version|.zip" "|version|/download?job=build_api"
unzip "api-|version|.zip" -d extracted
mv extracted/api/* api/
rm -rf extracted
# update os dependencies
sudo api/ install
# update python dependencies
source /srv/funkwhale/load_env
source /srv/funkwhale/virtualenv/bin/activate
pip install -r api/requirements.txt
# apply database migrations
python api/ migrate
# collect static files
python api/ collectstatic --no-input
# restart the services
sudo systemctl restart
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment