Mercurial > libervia-backend

comparison doc/configuration.rst @ 3563:267e4987b58b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: fix remaining SàT references/typos + add `libervia-cli` missing commands
author Goffi <goffi@goffi.org>
date Fri, 11 Jun 2021 09:21:41 +0200
parents c80a0f864b5d
children bc043afedbac d685299645fa
comparison
equal deleted inserted replaced
3562:9f599ccbea4e 3563:267e4987b58b
4 Configuration 4 Configuration
5 ============= 5 =============
6 6
7 Libervia main configuration is set in a file named ``libervia.conf`` (which may be prefixed 7 Libervia main configuration is set in a file named ``libervia.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 Libervia Pubsub).
10 10
11 This file can be 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 - XDG directory for configuration (most of time it is 14 - XDG directory for configuration (most of time it is
15 ``~/.config/libervia/``) 15 ``~/.config/libervia/``)
16 - the parent directory of SàT installation path 16 - the parent directory of Libervia 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/libervia.conf`` and the same one set in ``~/.libervia.conf``, the one from ``~/.libervia.conf`` 20 ``/etc/libervia.conf`` and the same one set in ``~/.libervia.conf``, the one from ``~/.libervia.conf``
21 will be used because it is parsed after ``/etc``). 21 will be used because it is parsed after ``/etc``).
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
33 sensitive), and some backend plugin can use specific sections too (usually named ``plugin 33 sensitive), and some backend plugin can use specific sections too (usually named ``plugin
34 <plugin name>``). The ``pubsub`` section is used by ``SàT PubSub``. A section can also 34 <plugin name>``). The ``pubsub`` section is used by ``Libervia PubSub``. A section can also
35 have the name of a web site used with Libervia web framework. 35 have the name of a web site used with Libervia web framework.
36 36
37 37
38 To recapitulate, you can have the following sections in your ``libervia.conf``: 38 To recapitulate, you can have the following sections in your ``libervia.conf``:
39 39
51 51
52 - ``[plugin account]`` 52 - ``[plugin account]``
53 - ``[plugin muc]`` 53 - ``[plugin muc]``
54 - ``[plugin search]`` 54 - ``[plugin search]``
55 ``[pubsub]`` 55 ``[pubsub]``
56 SàT PubSub settings 56 Libervia PubSub settings
57 ``[<website name>]`` 57 ``[<website name>]``
58 the settings of a website for Libervia web framework 58 the settings of a website for Libervia web framework
59 59
60 .. _INI: https://en.wikipedia.org/wiki/INI_file 60 .. _INI: https://en.wikipedia.org/wiki/INI_file
61 .. _SafeConfigParser: https://docs.python.org/2/library/configparser.html 61 .. _SafeConfigParser: https://docs.python.org/2/library/configparser.html
81 the comments to get the meaning of each option. 81 the comments to get the meaning of each option.
82 82
83 .. sourcecode:: cfg 83 .. sourcecode:: cfg
84 84
85 [DEFAULT] 85 [DEFAULT]
86 ; where SàT media are located 86 ; where Libervia media are located
87 media_dir = ~/workspace/sat_media 87 media_dir = ~/workspace/sat_media
88 log_level = debug 88 log_level = debug
89 ; domain used for new accounts 89 ; domain used for new accounts
90 xmpp_domain = example.net 90 xmpp_domain = example.net
91 ; list of profiles with admin rights 91 ; list of profiles with admin rights