index.rst 6.76 KB
Newer Older
Reg's avatar
Reg committed
1
Upgrading your Funkwhale instance to a newer version
2
3
4
5
====================================================

.. note::

6
7
8
9
    Before upgrading your instance, we strongly advise you to make at least a database backup. Ideally, you should make a full backup, including
    the database and the media files.

    We're commited to make upgrade as easy and straightforward as possible,
Reg's avatar
Reg committed
10
    however, Funkwhale is still in development and you'll be safer with a backup.
11

12

13
14
15
16
17
18
19
20
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.


21
22
23
24
25
26
27
28
29
30
31
32
Insights about new versions
---------------------------

Some versions may be bigger than usual, and we'll try to detail the changes
when possible.

.. toctree::
   :maxdepth: 1

   0.17


33
Docker setup
34
------------
35
36
37
38

If you've followed the setup instructions in :doc:`Docker`, upgrade path is
easy:

39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
Mono-container installation
^^^^^^^^^^^^^^^^^^^^^^^^^^^

Basically, you need to pull the new container image, stop and delete your existing container,
and relaunch a new one:

.. parsed-literal::
    export FUNKWHALE_VERSION="|version|"

.. code-block:: shell

    docker pull funkwhale/all-in-one:$FUNKWHALE_VERSION
    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,
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.

Multi-container installation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

72
73
74
75
76
77
.. parsed-literal::

    cd /srv/funkwhale
    # hardcode the targeted version your env file
    # (look for the FUNKWHALE_VERSION variable)
    nano .env
78
79
80
    # Load your environment variables
    source .env
    # Download newest nginx configuration file
Eliot Berriot's avatar
Eliot Berriot committed
81
82
    curl -L -o nginx/funkwhale.template "https://dev.funkwhale.audio/funkwhale/funkwhale/raw/develop/deploy/docker.nginx.template"
    curl -L -o nginx/funkwhale_proxy.conf "https://dev.funkwhale.audio/funkwhale/funkwhale/raw/develop/deploy/funkwhale_proxy.conf"
83
84
85
86
87
88
89
    # Pull the new version containers
    docker-compose pull
    # Apply the database migrations
    docker-compose run --rm api python manage.py migrate
    # Relaunch the containers
    docker-compose up -d

90
91
92
93
94
95
96
97
.. warning::

    You may sometimes get the following warning while applying migrations::

        "Your models have changes that are not yet reflected in a migration, and so won't be applied."

    This is a warning, not an error, and it can be safely ignored.
    Never run the ``makemigrations`` command yourself.
98

99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
Upgrading the Postgres container
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

With some Funkwhale releases, it is recommended to upgrade the version of the
Postgres database server container. For example, Funkwhale 0.17 recommended
Postgres 9.4, but Funkwhale 0.18 recommends Postgres 11. When upgrading
Postgres, it is not sufficient to change the container referenced in
``docker-compose.yml``. New major versions of Postgres cannot read the databases
created by older major versions. The data has to be exported from a running
instance of the old version and imported by the new version.

Thankfully, there is a Docker container available to automate this process. You
can use the following snippet to upgrade your database in ``./postgres``,
keeping a backup of the old version in ``./postgres-old``:

114
.. code-block:: shell
115
116
117
118
119
120

    # Replace "9.4" and "11" with the versions you are migrating between.
    export OLD_POSTGRES=9.4
    export NEW_POSTGRES=11
    docker-compose stop postgres
    docker run --rm \
121
122
      -v $(pwd)/data/postgres:/var/lib/postgresql/${OLD_POSTGRES}/data \
      -v $(pwd)/data/postgres-new:/var/lib/postgresql/${NEW_POSTGRES}/data \
123
124
      tianon/postgres-upgrade:${OLD_POSTGRES}-to-${NEW_POSTGRES}
    # Add back the access control rule that doesn't survive the upgrade
125
    echo "host all all all trust" | sudo tee -a ./data/postgres-new/pg_hba.conf
126
127
128
    # Swap over to the new database
    mv ./data/postgres ./data/postgres-old
    mv ./data/postgres-new ./data/postgres
129
130


131
Non-docker setup
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
----------------

Upgrade the static files
^^^^^^^^^^^^^^^^^^^^^^^^

On non-docker setups, 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
Eliot Berriot's avatar
Eliot Berriot committed
148
    sudo -u funkwhale curl -L -o front.zip "https://dev.funkwhale.audio/funkwhale/funkwhale/builds/artifacts/$FUNKWHALE_VERSION/download?job=build_front"
149
150
    sudo -u funkwhale unzip -o front.zip
    sudo -u funkwhale rm front.zip
151
152
153

Upgrading the API
^^^^^^^^^^^^^^^^^
154

155
On non-docker, upgrade involves a few more commands. We assume your setup
156
match what is described in :doc:`/installation/debian`:
157
158
159
160

.. parsed-literal::

    # this assumes you want to upgrade to version "|version|"
161
    export FUNKWHALE_VERSION="|version|"
162
163
164
    cd /srv/funkwhale

    # download more recent API files
Eliot Berriot's avatar
Eliot Berriot committed
165
    sudo -u funkwhale curl -L -o "api-$FUNKWHALE_VERSION.zip" "https://dev.funkwhale.audio/funkwhale/funkwhale/-/jobs/artifacts/$FUNKWHALE_VERSION/download?job=build_api"
166
    sudo -u funkwhale unzip "api-$FUNKWHALE_VERSION.zip" -d extracted
167
168
    sudo -u funkwhale rm -rf api/ && mv extracted/api .
    sudo -u funkwhale rm -rf extracted
169
170
171

    # update os dependencies
    sudo api/install_os_dependencies.sh install
172
    sudo -u funkwhale -H -E /srv/funkwhale/virtualenv/bin/pip install -r api/requirements.txt
173
174

    # collect static files
175
    sudo -u funkwhale -H -E /srv/funkwhale/virtualenv/bin/python api/manage.py collectstatic --no-input
176
177
178
179
180

    # stop the services
    sudo systemctl stop funkwhale.target

    # apply database migrations
181
    sudo -u funkwhale -H -E /srv/funkwhale/virtualenv/bin/python api/manage.py migrate
182
183

    # restart the services
184
    sudo systemctl start funkwhale.target
185
186
187
188
189
190
191
192
193

.. warning::

    You may sometimes get the following warning while applying migrations::

        "Your models have changes that are not yet reflected in a migration, and so won't be applied."

    This is a warning, not an error, and it can be safely ignored.
    Never run the ``makemigrations`` command yourself.