sieboldianus/iris-funkwhale repository overview

⁠iris-funkwhale

This repository is a fork from Iris⁠, an extension for the Mopidy music server, which extends the iris docker image with mopidy-funkwhale⁠.

⁠Usage

1. You can use this repository to build the image locally

e.g.

git clone [email protected]:Grom/iris-funkwhale.git
cd iris-funkwhale
cp docker-compose.example.yml docker-compose.yml # edit settings
docker-compose build --no-cache \
    && docker-compose up --detach  \
    && docker-compose logs --follow

1. Or you can refer to the public docker image

• use the original docker-compose.example.yml as a starting point
• replace jaedb/iris with sieboldianus/iris-funkwhale e.g.

version: "3"
services:
  ...
  mopidy:
    image: sieboldianus/iris-funkwhale
    ...

• start up the service with docker-compose up --detach

⁠Settings

Then in your mopidy.conf, add

[funkwhale]
enabled = true
# URL of your funkwhale instance
url = https://funkwhale.example.com
# Application credentials (leave empty for anonymous access)
# If you don't now what to put here, just run `mopidy funkwhale login` for
# the instructions
# If for some reason, you want to use the legacy password-based auth,
# uncomment the variables below
# username = example-user
# password = example-password

# duration of cache entries before they are removed, in seconds
# 0 to cache forever, empty to disable cache
cache_duration = 600

Note that username and password are deprecated after Funkwhale 1.1.2.

Also note that currently, this image does not support OAuth connections to the funkwhale instance (see the notes here⁠).

You can allow anonymous access by disabling "API Requires authentication" (Security section) in https://funkwhale.example.com/manage/settings⁠ and setting your libraries in Funkwhale to public access (e.g. on private networks).

⁠Developers

This image slightly diverges from its original repository.

• Dependencies for funkwhale-mopidy⁠ are added to the Dockerfile.
• A number of pre-installed mopidy extensions are added to the Docker image by default. PIP_PACKAGES can be used to add more on runtime.