Importing music from the server
Funkwhale can import music files saved on the server
assuming they are readable by the Funkwhale application.
Your music files should contain at least
but we recommend you tag extensively using a proper tool,
such as Beets or Musicbrainz Picard.
Funkwhale supports two different import modes:
copy(default): files are copied into Funkwhale’s internal storage. This means importing a 1GB library will result in the same amount of space being used by Funkwhale.
--in-placeflag): files are referenced in Funkwhale’s DB but not copied or touched in anyway. This is useful if you have a huge library, or one that is updated by an external tool such as Beets.
Regardless of the mode you choose,
follow the below steps to import music,
assuming your files are located in
export LIBRARY_ID="<your_libary_id>" python api/manage.py import_files $LIBRARY_ID "/srv/funkwhale/data/music/" --recursive --noinput
You have to create a library in the Web UI to get your library ID. Simply visit https://yourdomain/content/libraries/ to create one.
Library IDs are part of the library url or sharing link. For example, the library ID of https://funkwhale.instance/content/libraries/769a2ae3-eb3d-4aff-9f94-2c4d80d5c2d1, is 769a2bc3-eb1d-4aff-9f84-2c4d80d5c2d1
You can use only the first characters of the ID when calling the command, like that:
When you use docker,
/srv/funkwhale/data/music is mounted from the host
/music directory on the container:
export LIBRARY_ID="<your_libary_id>" docker-compose run --rm api python manage.py import_files $LIBRARY_ID "/music/" --recursive --noinput
When you installed Funkwhale via ansible, you need to call a script instead of Python, and the folder path must be adapted accordingly:
export LIBRARY_ID="<your_libary_id>" /srv/funkwhale/manage import_files $LIBRARY_ID "/srv/funkwhale/data/music/" --recursive --noinput
The import command supports several options, check the help for details:
docker-compose run --rm api python manage.py import_files --help
We recommend tagging your music collection using Picard to have the best quality metadata.
This command is idempotent, meaning you can run it multiple times on the same files and already imported files are simply skipped.
At the moment, only Flac, OGG/Vorbis and MP3 or AIFF files with ID3 tags are supported.
By default, the CLI-importer will copy imported files to Funkwhale’s internal storage. This means importing a 1GB library will result in the same amount of space being used by Funkwhale.
While this behaviour has some benefits (easier backups and configuration), it is not always the best choice, especially if you have a huge library to import and don’t want to double your disk usage.
The CLI importer supports an additional
through which Funkwhale will store file paths rather than file content.
Because imported files are not managed by Funkwhale, we offer additional configuration options to ensure the webserver can serve them properly:
We recommend you symlink all your music directories into
and run the import_files command from that directory.
This will make it possible to use multiple music directories
without any additional configuration on the webserver side.
For instance, if you have an NFS share
with your music mounted at
you can create a symlink like this:
ln -s /media/mynfsshare /srv/funkwhale/data/music/nfsshare
And import music from the share:
export LIBRARY_ID="<your_libary_id>" python api/manage.py import_files $LIBRARY_ID "/srv/funkwhale/data/music/nfsshare/" --recursive --noinput --in-place
Docker setups require a bit more work,
because while the
/srv/funkwhale/data/music is mounted in containers,
symlinked directories are not.
To fix that, you can use bind mounts instead of symbolic links, as they replicate the source directory tree. With the previous NFS share, use this command:
mount --bind /media/mynfsshare /srv/funkwhale/data/music/nfsshare
If you want to go with symlinks,
ensure each symlinked directory is mounted as a volume
as well as in your
celeryworker: volumes: - ./data/music:/music:ro - ./data/media:/app/funkwhale_api/media # add your symlinked dirs here - /media/nfsshare:/media/nfsshare:ro api: volumes: - ./data/music:/music:ro - ./data/media:/app/funkwhale_api/media # add your symlinked dirs here - /media/nfsshare:/media/nfsshare:ro
When doing an import with in
the importer will also check and update existing entries found in the database.
For instance, if the ID3 Title tag of an existing song was updated since the last scan, Funkwhale picks up the new title.
The following fields can be updated this way:
Track position and disc number
Track license and copyright
Track genre (from version 1.2)
Album release date
Album artist name
Album artist mbid
Changes in artist name can lead to multiple artists with the same name in the database, this is a known issue and can be remedied by adding mbids.
React to filesystem events with
If you have a really big library or update it regularly,
import_files command by hand may not be practical.
For this use case,
import_files command supports a
through which it observes filesystem events instead of performing a full import.
File creation, move, update and removal
are handled when
--watch is provided:
Files created in the watched directory are imported immediately
in-placemode, files updates trigger a metadata update on the corresponding entries
in-placemode, files that are moved and known by Funkwhale will see their path updated in Funkwhale’s DB
in-placemode, files that are removed and known by Funkwhale will be removed from Funkwhale’s DB
Pruning dangling metadata with
Funkwhale is, by design, conservative with music metadata in its database. If you remove a file from Funkwhale’s DB, the corresponding artist, album and track object won’t be deleted by default.
If you want to prune dangling metadata from the database once the
import_files command is over, simply add the
This also works in with
Whenever possible, Funkwhale obtains album covers for tracks, with the following precedence:
The cover embedded in the audio files themeselves, if any (Flac/MP3 only)
Use a cover.jpg or a cover.png file from the imported track directory, if any
Fetch cover art from musicbrainz, assuming the file is tagged correctly
Getting demo tracks
If you do not have any music on your server but want to test the import process, you can call the following methods to download a few albums licenced under creative commons (courtesy of Jamendo):
curl -L -o download-tracks.sh "https://dev.funkwhale.audio/funkwhale/funkwhale/raw/1.2.10/demo/download-tracks.sh" curl -L -o music.txt "https://dev.funkwhale.audio/funkwhale/funkwhale/raw/1.2.10/demo/music.txt" chmod +x download-tracks.sh ./download-tracks.sh music.txt
This will download a bunch of zip archives (one per album)
data/music directory and unzip their content.