Funkwhale Docker

This repo is here to help installing Funkwhale using Docker. It follows the multi-container installation documentation.

Usage

Prerequisites:

• docker-compose

Install Funkwhale

To set up your instance, clone this repo and enter the directory, then run the script ./install.sh.

This script will ask for the needed information, but it is also possible to pass them to it directly. See the help with this command:

./install.sh --help

Upgrade Funkwhale

To upgrade your instance, define the new version in FUNKWHALE_VERSION environment variable and run the script ./upgrade.sh.

Example:

FUNKWHALE_VERSION=1.2.9 ./upgrade.sh

Clean

If you are doing tests, you might want to start from a blank slate each time.

The clean.sh script cleans the Docker containers, their volumes and the residual files. Since running the containers needs to create volume bindings, this script needs sudo rights in order to clean the files created with root access.

Because of the security risk, please take a look at the script to understand what it does: clean.sh

Developer

Prerequisites:

• spellchecker