Mercurial > libervia-backend

comparison doc/configuration.rst @ 3488:c80a0f864b5d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: updated doc following global renaming
author Goffi <goffi@goffi.org>
date Sun, 21 Mar 2021 18:23:58 +0100
parents f21412896620
children 267e4987b58b
comparison
equal deleted inserted replaced
3487:75427f0a5445 3488:c80a0f864b5d
2 2
3 ============= 3 =============
4 Configuration 4 Configuration
5 ============= 5 =============
6 6
7 Salut à Toi main configuration is set in a file named ``sat.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 SàT 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/sat/``) 15 ``~/.config/libervia/``)
16 - the parent directory of SàT installation path 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/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``).
22 22
23 Format 23 Format
24 ====== 24 ======
25 25
26 ``sat.conf`` is using the `INI`_ file format as understood by Python's `SafeConfigParser`_ 26 ``libervia.conf`` is using the `INI`_ file format as understood by Python's `SafeConfigParser`_
27 (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
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 ``SàT 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 ``sat.conf``: 38 To recapitulate, you can have the following sections in your ``libervia.conf``:
39 39
40 ``[DEFAULT]`` 40 ``[DEFAULT]``
41 the main, global section 41 the main, global section
42 frontend name (in lower case) 42 frontend name (in lower case)
43 frontend specific settings. Some examples: 43 frontend specific settings. Some examples:
44 44
45 - ``[cagou]`` 45 - ``[desktop]``
46 - ``[jp]`` 46 - ``[cli]``
47 - ``[primitivus]`` 47 - ``[tui]``
48 - ``[libervia]`` 48 - ``[web]``
49 ``[plugin <plugin name>]`` 49 ``[plugin <plugin name>]``
50 backend plugin specific settings. Some examples: 50 backend plugin specific settings. Some examples:
51 51
52 - ``[plugin account]`` 52 - ``[plugin account]``
53 - ``[plugin muc]`` 53 - ``[plugin muc]``
114 114
115 [plugin muc] 115 [plugin muc]
116 ; default room to use in the "Join room" menu 116 ; default room to use in the "Join room" menu
117 default_muc = sat@chat.jabberfr.org 117 default_muc = sat@chat.jabberfr.org
118 118
119 [primitivus] 119 [tui]
120 log_level = debug 120 log_level = debug
121 ; how the logs are formatted 121 ; how the logs are formatted
122 ; note that "%" must be doubled here 122 ; note that "%" must be doubled here
123 log_fmt = %%(levelname)s: %%(message)s 123 log_fmt = %%(levelname)s: %%(message)s
124 ; use bracketed paste mode 124 ; use bracketed paste mode
125 bracketed_paste = true 125 bracketed_paste = true
126 126
127 [jp] 127 [cli]
128 ; how to use xdotool to refresh Firefox when doing "jp blog edit" 128 ; how to use xdotool to refresh Firefox when doing "li blog edit"
129 blog_preview_open_cmd = firefox -new-tab {url} 129 blog_preview_open_cmd = firefox -new-tab {url}
130 blog_preview_update_cmd = /bin/sh -c "WID=$(xdotool search --name 'Mozilla Firefox' | head -1); xdotool windowactivate $WID; xdotool key F5" 130 blog_preview_update_cmd = /bin/sh -c "WID=$(xdotool search --name 'Mozilla Firefox' | head -1); xdotool windowactivate $WID; xdotool key F5"
131 ; and below the equivalent with Konqueror 131 ; and below the equivalent with Konqueror
132 # blog_preview_open_cmd = konqueror {url} 132 # blog_preview_open_cmd = konqueror {url}
133 # blog_preview_update_cmd = /bin/sh -c "qdbus $(qdbus org.kde.konqueror\*) /konqueror/MainWindow_1 reload" 133 # blog_preview_update_cmd = /bin/sh -c "qdbus $(qdbus org.kde.konqueror\*) /konqueror/MainWindow_1 reload"
134 134
135 [libervia] 135 [web]
136 ; do we want "http", "https" or "both"? 136 ; do we want "http", "https" or "both"?
137 connection_type = both 137 connection_type = both
138 port = 8080 138 port = 8080
139 port_https = 8443 139 port_https = 8443
140 ; external port used for HTTPS (0 to use "port_https" value) 140 ; external port used for HTTPS (0 to use "port_https" value)