Commit 34ec7b54 authored by Eliot Berriot's avatar Eliot Berriot
Browse files

Added documentation about music acquisition

parent c8696beb
Pipeline #62 passed with stages
in 1 minute and 51 seconds
......@@ -67,6 +67,7 @@ mailhog
# Api
......@@ -25,7 +25,8 @@ services:
- ./api/media:/app/funkwhale_api/media
- ./data/music:/music:ro
- ./api/media:/app/funkwhale_api/media
restart: unless-stopped
......@@ -42,6 +43,7 @@ services:
env_file: .env
command: ./compose/django/
- ./data/music:/music:ro
- ./data/media:/app/funkwhale_api/media
- ./data/static:/app/staticfiles
Importing music
From music directory on the server
You can import music files in funkwhale assuming they are located on the server
and readable by the funkwhale application.
Assuming your music is located at ``/music`` and your music files contains at
least an ``artist``, ``album`` and ``title`` tag, you can import those tracks as follows:
.. code-block:: bash
docker-compose --rm run api python import_files "/music/**/*.ogg" --recursive --noinput
.. note::
This command is idempotent, meaning you can run it multiple times on the same
files and already imported files will simply be skipped.
.. warning::
At the moment, only ogg files are supported. MP3 support will be implemented soon.
Getting demo tracks
If you do not have any music on your server but still want to test the import
process, you can call the following methods do download a few albums licenced
under creative commons (courtesy of Jamendo):
.. code-block:: bash
curl -L -o ""
curl -L -o music.txt ""
chmod +x
./ music.txt
This will download a bunch of zip archives (one per album) under the ``data/music`` directory and unzip their content.
......@@ -13,7 +13,7 @@ Funkwhale is a self-hosted, modern free and open-source music server, heavily in
Indices and tables
......@@ -47,3 +47,8 @@ Then launch the whole thing:
docker-compose up -d
Now, you just need to setup the :ref:`frontend files <frontend-setup>`, and configure your :ref:`reverse-proxy <reverse-proxy-setup>`. Don't worry, it's quite easy.
About music acquisition
If you want to :doc:`import music located on the server </importing-music>`, you can put it in the ``data/music`` directory and it will become readable by the importer.
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment