Mercurial > libervia-backend

comparison doc/configuration.rst @ 3251:f21412896620

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc (config): fixed documentation about configuration file possible paths + minor corrections.
author Goffi <goffi@goffi.org>
date Tue, 14 Apr 2020 20:26:47 +0200
parents d9f328374473
children c80a0f864b5d
comparison
equal deleted inserted replaced
3250:e4d3ba75b1b2 3251:f21412896620
6 6
7 Salut à Toi main configuration is set in a file named ``sat.conf`` (which may be prefixed 7 Salut à Toi main configuration is set in a file named ``sat.conf`` (which may be prefixed
8 by a ``.`` if you want to hide it on suitable platforms). It is a common file used both by 8 by a ``.`` if you want to hide it on suitable platforms). It is a common file used both by
9 backend and all frontends (and even related project like SàT Pubsub). 9 backend and all frontends (and even related project like SàT Pubsub).
10 10
11 This file can located in the following paths (in order of parsing): 11 This file can be located in the following paths (in order of parsing):
12 - ``/etc`` 12 - ``/etc``
13 - ``~`` (``$HOME`` or your home directory) 13 - ``~`` (``$HOME`` or your home directory)
14 - the directory where you are launching the backend or frontend from
15 - XDG directory for configuration (most of time it is 14 - XDG directory for configuration (most of time it is
16 ``~/.config/sat/sat.conf``) 15 ``~/.config/sat/``)
16 - the parent directory of SàT installation path
17 17
18 If several configurations files are found, they are merged. In case of conflict, the 18 If several configurations files are found, they are merged. In case of conflict, the
19 option parsed last is the one used (in other words: if you have an option set in 19 option parsed last is the one used (in other words: if you have an option set in
20 ``/etc/sat.conf`` and the same one set in ``~/.sat.conf``, the one from ``~/.sat.conf`` 20 ``/etc/sat.conf`` and the same one set in ``~/.sat.conf``, the one from ``~/.sat.conf``
21 will be used because it is parsed after ``/etc``). 21 will be used because it is parsed after ``/etc``).
22 22
23 Format 23 Format
24 ====== 24 ======
25 25
26 ``sat.conf`` is a using the `INI`_ file format as understood by Python's 26 ``sat.conf`` is using the `INI`_ file format as understood by Python's `SafeConfigParser`_
27 `SafeConfigParser`_ (meaning that you can use interpolation). 27 (meaning that you can use interpolation).
28 28
29 The ``DEFAULT`` section is used for global options, this is where you specify where are 29 The ``DEFAULT`` section is used for global options, this is where you specify where are
30 your media. 30 your media.
31 31
32 Each frontend can have specific section with its name in lowercase (sections are case 32 Each frontend can have specific section with its name in lowercase (sections are case