MirrorMirror
/
funkwhale
mirror of https://dev.funkwhale.audio/funkwhale/funkwhale.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix #132: better upgrading instructions for frontend files on docker

This commit is contained in:
Eliot Berriot 2018-05-07 00:17:42 +02:00
parent 60608c0390
commit a8e436101c
No known key found for this signature in database
GPG Key ID: DD6965E2476E5C27
3 changed files with 34 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
changes/changelog.d/132.doc Normal file
View File

@ -0,0 +1 @@
Up-to-date documentation for upgrading front-end files on docker setup (#132)

6
docs/installation/index.rst
View File

@ -74,6 +74,12 @@ We also maintain an installation guide for Debian 9.
Frontend setup Frontend setup
--------------- ---------------
.. note::
You do not need to do this if you are deploying using Docker, as frontend files
are already included in the docker image.
Files for the web frontend are purely static and can simply be downloaded, unzipped and served from any webserver: Files for the web frontend are purely static and can simply be downloaded, unzipped and served from any webserver:
.. parsed-literal:: .. parsed-literal::

51
docs/upgrading.rst
View File

@ -17,29 +17,9 @@ 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. similarly from version to version, but some of them may require additional steps.
Those steps would be described in the version release notes. 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 front.zip "https://code.eliotberriot.com/funkwhale/funkwhale/builds/artifacts/$FUNKWHALE_VERSION/download?job=build_front"
unzip -o front.zip
rm front.zip
Upgrading the API
-----------------
Docker setup Docker setup
^^^^^^^^^^^^ ------------
If you've followed the setup instructions in :doc:`Docker`, upgrade path is If you've followed the setup instructions in :doc:`Docker`, upgrade path is
easy: easy:
@ -57,10 +37,33 @@ easy:
# Relaunch the containers # Relaunch the containers
docker-compose up -d docker-compose up -d
Non-docker setup
^^^^^^^^^^^^^^^^
On non docker-setup, upgrade involves a few more commands. We assume your setup
Non-docker setup
----------------
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
curl -L -o front.zip "https://code.eliotberriot.com/funkwhale/funkwhale/builds/artifacts/$FUNKWHALE_VERSION/download?job=build_front"
unzip -o front.zip
rm front.zip
Upgrading the API
^^^^^^^^^^^^^^^^^
On non-docker, upgrade involves a few more commands. We assume your setup
match what is described in :doc:`debian`: match what is described in :doc:`debian`:
.. parsed-literal:: .. parsed-literal::