github/supysonic
1
0
Fork 0
mirror of https://github.com/spl0k/supysonic.git synced 2024-12-22 08:56:17 +00:00
Code Issues Releases Wiki Activity

Moving the configuration doc

Browse Source
This commit is contained in:
Alban Féron 2021-01-09 17:10:56 +01:00
parent 15e5114cd9
commit 33d0739c4e
No known key found for this signature in database
GPG Key ID: 8CE0313646D16165
3 changed files with 13 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/configuration.rst → docs/setup/configuration.rst
View File

@ -1,15 +1,19 @@
Configuration
=============
*Supysonic* looks for four files for its configuration: ``/etc/supysonic``,
``~/.supysonic``, ``~/.config/supysonic/supysonic.conf`` and ``supysonic.conf``
in the current folder, merging values from all files.
Supysonic looks for four files for its configuration: :file:`/etc/supysonic`,
:file:`~/.supysonic`, :file:`~/.config/supysonic/supysonic.conf` and
:file:`supysonic.conf` in the current working directory, in this order, merging
values from all files.
Configuration files must respect a structure similar to Windows INI file, with
``[section]`` headers and using a ``KEY = VALUE`` or ``KEY: VALUE`` syntax.
You'll find a roughly documented configuration sample file at the root of the
project, file conveniently named ``config.sample``. More details below.
If you cloned Supysonic from its `GitHub repository`__ you'll find a roughly
documented configuration sample file at the root of the project, file
conveniently named :file:`config.sample`. More details below.
__ http://github.com/spl0k/supysonic
``[base]`` section
------------------
@ -197,7 +201,7 @@ library folders and providing the jukebox feature.
``jukebox_command``
Command used by the jukebox mode to play a single file.
See the :doc:`jukebox documentation <jukebox>` for more details.
See the :doc:`jukebox documentation <../jukebox>` for more details.
``log_file``
Rotating file where events generated by the file watcher are logged.
@ -277,7 +281,7 @@ This section defines command-line programs to be used to convert an audio file
to another format or change its bitrate. All configurations in the sample below
have **not** been thoroughly tested.
For more details, please refer to the
:doc:`transcoding configuration <transcoding>`.
:doc:`transcoding configuration <../transcoding>`.
.. code-block:: ini

2
docs/setup/database.rst
View File

@ -6,7 +6,7 @@ or PostgreSQL database.
If you absolutely have no clue about databases, you can go with SQLite as it
doesn't need any setup other than specifying a path for the database in the
:doc:`configuration <../configuration>`.
:doc:`configuration <configuration>`.
.. note::

1
docs/setup/index.rst
View File

@ -9,3 +9,4 @@ start serving your music.
install
database
configuration