Funkwhale

From the Linux and Unix Users Group at Virginia Teck Wiki
Jump to: navigation, search

Funkwhale is a self-hosted music streaming service. VTLUUG currently runs a dockerized instance located at https://funkwhale.vtluug.org on sczi. LDAP, invite codes, and the admin account are the only available login methods.

All music on Funkwhale is organized into user-specific libraries, and users may grant access to other users, the public, or to everyone on the instance. A big part of Funkwhale is the social aspect of sharing music with others.

Docker-compose configuration files are located on GitHub.

Importing Music

Funkwhale already has a pretty good guide located here, so this guide is specific to VTLUUG's configuration.


  1. Music must be located at /nfs/cistern/share/media/music/$username and must have proper metadata. Currently only FLAC, OGG/Vorbis, and MP3 files are supported but check here in case this guide is out of date.
  2. Create a library by going to https://funkwhale.vtluug.org/content/libraries/.
  3. Record the library ID of the library you want to add music too, located in the URL bar when you click on 'Detail' for a given library.
  4. On sczi:
    1. Become root (ask an officer for help)
    2. Go to /nfs/cistern/docker/apps/sczi/funkwhale
    3. Run export LIBRARY_ID="<your_libary_id>"
    4. Run docker-compose run --rm api python manage.py import_files $LIBRARY_ID "/nfs/cistern/share/media/music/$username/**/*.flac" --recursive --noinput
      1. Adjust the music type depending on your filetypes.