MirrorMirror
/
funkwhale
mirror of https://dev.funkwhale.audio/funkwhale/funkwhale.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge branch '562-import-library-id-doc' into 'develop' 

Fix # #562: Document how to find and use library id when importing files in CLI

Closes #562

See merge request funkwhale/funkwhale!452
This commit is contained in:
Eliot Berriot 2018-10-20 14:46:09 +00:00
parent a21db8d96a a5e5e547e1
commit fe7bcc2e37
2 changed files with 14 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
changes/changelog.d/562.doc Normal file
View File

@ -0,0 +1 @@
Document how to find and use library id when importing files in CLI (#562)

15
docs/importing-music.rst
View File

@ -14,14 +14,25 @@ You can import those tracks as follows, assuming they are located in
.. code-block:: bash
python api/manage.py import_files "/srv/funkwhale/data/music/**/*.ogg" --recursive --noinput
export LIBRARY_ID="<your_libary_id>"
python api/manage.py import_files $LIBRARY_ID "/srv/funkwhale/data/music/**/*.ogg" --recursive --noinput
When you use docker, the ``/srv/funkwhale/data/music`` is mounted from the host
to the ``/music`` directory on the container:
.. code-block:: bash
docker-compose run --rm api python manage.py import_files "/music/**/*.ogg" --recursive --noinput
export LIBRARY_ID="<your_libary_id>"
docker-compose run --rm api python manage.py import_files $LIBRARY_ID "/music/**/*.ogg" --recursive --noinput
.. note::
Library IDs are available in library urls or sharing link. In this example:
https://funkwhale.instance/content/libraries/769a2ae3-eb3d-4aff-9f94-2c4d80d5c2d1,
the library ID is 769a2bc3-eb1d-4aff-9f84-2c4d80d5c2d1
You can use only the first characters of the ID when calling the command, like that:
``export LIBRARY_ID="769a2bc3"``
The import command supports several options, and you can check the help to
get details::