Mercurial > libervia-backend
diff doc/configuration.rst @ 3488:c80a0f864b5d
doc: updated doc following global renaming
author | Goffi <goffi@goffi.org> |
---|---|
date | Sun, 21 Mar 2021 18:23:58 +0100 |
parents | f21412896620 |
children | 267e4987b58b |
line wrap: on
line diff
--- a/doc/configuration.rst Sun Mar 21 18:16:52 2021 +0100 +++ b/doc/configuration.rst Sun Mar 21 18:23:58 2021 +0100 @@ -4,7 +4,7 @@ Configuration ============= -Salut à Toi main configuration is set in a file named ``sat.conf`` (which may be prefixed +Libervia main configuration is set in a file named ``libervia.conf`` (which may be prefixed by a ``.`` if you want to hide it on suitable platforms). It is a common file used both by backend and all frontends (and even related project like SàT Pubsub). @@ -12,18 +12,18 @@ - ``/etc`` - ``~`` (``$HOME`` or your home directory) - XDG directory for configuration (most of time it is - ``~/.config/sat/``) + ``~/.config/libervia/``) - the parent directory of SàT installation path If several configurations files are found, they are merged. In case of conflict, the option parsed last is the one used (in other words: if you have an option set in -``/etc/sat.conf`` and the same one set in ``~/.sat.conf``, the one from ``~/.sat.conf`` +``/etc/libervia.conf`` and the same one set in ``~/.libervia.conf``, the one from ``~/.libervia.conf`` will be used because it is parsed after ``/etc``). Format ====== -``sat.conf`` is using the `INI`_ file format as understood by Python's `SafeConfigParser`_ +``libervia.conf`` is using the `INI`_ file format as understood by Python's `SafeConfigParser`_ (meaning that you can use interpolation). The ``DEFAULT`` section is used for global options, this is where you specify where are @@ -35,17 +35,17 @@ have the name of a web site used with Libervia web framework. -To recapitulate, you can have the following sections in your ``sat.conf``: +To recapitulate, you can have the following sections in your ``libervia.conf``: ``[DEFAULT]`` the main, global section frontend name (in lower case) frontend specific settings. Some examples: - - ``[cagou]`` - - ``[jp]`` - - ``[primitivus]`` - - ``[libervia]`` + - ``[desktop]`` + - ``[cli]`` + - ``[tui]`` + - ``[web]`` ``[plugin <plugin name>]`` backend plugin specific settings. Some examples: @@ -116,7 +116,7 @@ ; default room to use in the "Join room" menu default_muc = sat@chat.jabberfr.org - [primitivus] + [tui] log_level = debug ; how the logs are formatted ; note that "%" must be doubled here @@ -124,15 +124,15 @@ ; use bracketed paste mode bracketed_paste = true - [jp] - ; how to use xdotool to refresh Firefox when doing "jp blog edit" + [cli] + ; how to use xdotool to refresh Firefox when doing "li blog edit" blog_preview_open_cmd = firefox -new-tab {url} blog_preview_update_cmd = /bin/sh -c "WID=$(xdotool search --name 'Mozilla Firefox' | head -1); xdotool windowactivate $WID; xdotool key F5" ; and below the equivalent with Konqueror # blog_preview_open_cmd = konqueror {url} # blog_preview_update_cmd = /bin/sh -c "qdbus $(qdbus org.kde.konqueror\*) /konqueror/MainWindow_1 reload" - [libervia] + [web] ; do we want "http", "https" or "both"? connection_type = both port = 8080