docs: adjust changes to behavior at current version

This commit is contained in:
xeruf 2021-11-22 11:50:40 +01:00
parent 98c6c60b6e
commit a6f7e49fb3
2 changed files with 32 additions and 14 deletions

View file

@ -2,7 +2,7 @@ Importing music from the server
=============================== ===============================
Funkwhale can import music files saved on the server Funkwhale can import music files saved on the server
assuming they are readable by the `funkwhale` user. assuming they are readable by the Funkwhale application.
Your music files should contain at least Your music files should contain at least
``artist``, ``album`` and ``title`` tags, ``artist``, ``album`` and ``title`` tags,
but we recommend you tag extensively using a proper tool, but we recommend you tag extensively using a proper tool,
@ -10,11 +10,11 @@ such as Beets or Musicbrainz Picard.
Funkwhale supports two different import modes: Funkwhale supports two different import modes:
- copy(only before 1.0): 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. - 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.
- :ref:`in-place <in-place-import>` (default): 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. - :ref:`in-place <in-place-import>` (with ``--in-place`` flag): 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're choosing, Regardless of the mode you choose,
import works as described below, follow the below steps to import music,
assuming your files are located in assuming your files are located in
``/srv/funkwhale/data/music``: ``/srv/funkwhale/data/music``:
@ -76,6 +76,21 @@ check the help for details::
In-place import In-place import
^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^
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 ``--in-place`` option
through which Funkwhale will store file paths rather than file content.
Structure
*********
Because imported files are not managed by Funkwhale, Because imported files are not managed by Funkwhale,
we offer additional configuration options we offer additional configuration options
to ensure the webserver can serve them properly: to ensure the webserver can serve them properly:
@ -85,7 +100,7 @@ to ensure the webserver can serve them properly:
We recommend you symlink all your music directories into ``/srv/funkwhale/data/music`` We recommend you symlink all your music directories into ``/srv/funkwhale/data/music``
and run the `import_files` command from that directory. and run the `import_files` command from that directory.
This will make it possible to use multiple music directories, This will make it possible to use multiple music directories
without any additional configuration on the webserver side. without any additional configuration on the webserver side.
For instance, if you have an NFS share For instance, if you have an NFS share
@ -99,6 +114,9 @@ And import music from the share::
export LIBRARY_ID="<your_libary_id>" export LIBRARY_ID="<your_libary_id>"
python api/manage.py import_files $LIBRARY_ID "/srv/funkwhale/data/music/nfsshare/" --recursive --noinput --in-place python api/manage.py import_files $LIBRARY_ID "/srv/funkwhale/data/music/nfsshare/" --recursive --noinput --in-place
Docker
******
Docker setups require a bit more work, Docker setups require a bit more work,
because while the ``/srv/funkwhale/data/music`` is mounted in containers, because while the ``/srv/funkwhale/data/music`` is mounted in containers,
symlinked directories are not. symlinked directories are not.
@ -139,7 +157,7 @@ The following fields can be updated this way:
- Track title - Track title
- Track position and disc number - Track position and disc number
- Track license and copyright - Track license and copyright
- Track genre - Track genre (`from version 1.2 <https://dev.funkwhale.audio/funkwhale/funkwhale/-/merge_requests/1225>`_)
- Album cover - Album cover
- Album title - Album title
- Album mbid - Album mbid
@ -149,6 +167,9 @@ The following fields can be updated this way:
- Album artist name - Album artist name
- Album artist mbid - Album artist mbid
Changes in artist name can lead to multiple artists with the same name in the database,
`this is a known issue <https://dev.funkwhale.audio/funkwhale/funkwhale/-/issues/1318>`_
and can be remedied by adding mbids.
React to filesystem events with ``--watch`` React to filesystem events with ``--watch``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

View file

@ -327,12 +327,12 @@ load the new configuration with ``service apache2 restart``.
Caddy Caddy
^^^^^ ^^^^^
For a pure Caddy setup, see the WIP Caddyfile on GitLab: We currently do not support a Caddy-only setup, but you can
https://dev.funkwhale.audio/funkwhale/funkwhale/-/merge_requests/1384 `help develop it <https://dev.funkwhale.audio/funkwhale/funkwhale/-/merge_requests/1384>`_!
When using Caddy as a reverse proxy in front of your docker containers To employ Caddy as a reverse proxy in front of your docker containers
(either mono- or multi-container setup), (either mono- or multi-container setup),
employ the following Caddyfile configuration: use the following Caddyfile configuration:
Caddy v2:: Caddy v2::
@ -382,6 +382,3 @@ a certificate, as shown below. These instructions are provided by `certbot <http
sudo certbot --apache -d yourfunkwhale.domain sudo certbot --apache -d yourfunkwhale.domain
This creates a valid certificate and edit the nginx or Apache2 configuration to use the new certificate. The certificate will be automatically renewed when they expire. This creates a valid certificate and edit the nginx or Apache2 configuration to use the new certificate. The certificate will be automatically renewed when they expire.