Added a new doc page about instance configuration

This commit is contained in:
Eliot Berriot 2018-03-06 18:47:30 +01:00
parent b277b16fad
commit 968423a6f8
No known key found for this signature in database
GPG Key ID: DD6965E2476E5C27
2 changed files with 36 additions and 0 deletions

35
docs/configuration.rst Normal file
View File

@ -0,0 +1,35 @@
Instance configuration
======================
General configuration is achieved using two type of settings.
Environment variables
---------------------
Those are located in your ``.env`` file, which you should have created
during installation.
Options from this file are heavily commented, and usually target lower level
and technical aspects of your instance, such as database credentials.
.. note::
You should restart all funwhale processes when you change the values
on environment variables.
Instance settings
-----------------
Those settings are stored in database and do not require a restart of your
instance after modification. They typically relate to higher level configuration,
such your instance description, signup policy and so on.
There is no polished interface for those settings, yet, but you can view update
them using the administration interface provided by Django (the framework funkwhale is built on).
The URL should be ``/api/admin/dynamic_preferences/globalpreferencemodel/`` (prepend your domain in front of it, of course).
If you plan to use acoustid and external imports
(e.g. with the youtube backends), you should edit the corresponding
settings in this interface.

View File

@ -13,6 +13,7 @@ Funkwhale is a self-hosted, modern free and open-source music server, heavily in
features
installation/index
configuration
importing-music
changelog