@@ -47,7 +47,7 @@ Funkwhale packages are available for the following platforms:
- `YunoHost 3 <https://yunohost.org/>`_: https://github.com/YunoHost-Apps/funkwhale_ynh (kindly maintained by `@Jibec <https://github.com/Jibec>`_)
- ArchLinux (as an AUR package): if you'd rather use a package, check out this alternative installation method on ArchLinux: https://wiki.archlinux.org/index.php/Funkwhale (package and wiki kindly maintained by getzee)
- `NixOS <https://github.com/mmai/funkwhale-nixos>`_ (kindly maintained by @mmai)
- `Helm chart <https://gitlab.com/ananace/charts/>`_ to install Funkwhale on Kubenertes (kindly maintained by @ananace)
- `Helm chart <https://gitlab.com/ananace/charts/>`_ to install Funkwhale on Kubernetes (kindly maintained by `@ananace <https://gitlab.com/ananace>`_)
Project architecture
--------------------
...
...
@@ -109,23 +109,23 @@ Running Funkwhale on the develop branch
---------------------------------------
Traditional deployments are done using tagged releases. However, you
may want to benefits from the latest change available, or the help detect
may want to benefit from the latest changes available, or to help detect
bugs before they are included in actual releases.
To do that, you'll need to run your instance on the develop branch,
which contains all the unreleased changes and features of the next version.
Please take into account that the develop branch
may be unstable and will contain bugs that may affect the wellbeing of your
may be unstable and will contain bugs that may affect the well-being of your
instance. If you are comfortable with that, you need to backup at least your database
before pulling latest changes from the develop branch.
before pulling the latest changes from the develop branch.
Otherwise, the deployment process is similar to deploying with releases.
You simply need to use ``export FUNKWHALE_VERSION=develop``
in the installation and upgrade process instead of a real version number,
as we build artifacts on the development branch the same way we do for releases.
It's also recommended to check out the `develop release notes <https://dev.funkwhale.audio/funkwhale/funkwhale/blob/develop/changes/notes.rst>_` before upgrading,
It's also recommended to check out the `develop release notes <https://dev.funkwhale.audio/funkwhale/funkwhale/blob/develop/changes/notes.rst>`_ before upgrading,
since you may have to apply manual actions for your instance to continue to work. Such actions are labelled with ``[manual action required]`` in the releases notes.
.. _frontend-setup:
...
...
@@ -216,7 +216,7 @@ On non-docker deployments, run the following commands:
.. note::
The resulting file should not contain any variable such as ``${FUNKWHALE_HOSTNAME}``.
The resulting file should not contain any variables such as ``${FUNKWHALE_HOSTNAME}``.