changeset 3021:8ec35cf13f66

doc: added, overview, configuration and Primitivus documentation + some small modifications
author Goffi <>
date Sun, 21 Jul 2019 22:14:30 +0200
parents af9d71303605
children 03fe31effa7f
files doc/configuration.rst doc/index.rst doc/jp/blog.rst doc/jp/common_arguments.rst doc/jp/index.rst doc/overview.rst doc/primitivus/index.rst
diffstat 7 files changed, 614 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/configuration.rst	Sun Jul 21 22:14:30 2019 +0200
@@ -0,0 +1,150 @@
+Salut à Toi main configuration is set in a file named ``sat.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).
+This file can located in the following paths (in order of parsing):
+  - ``/etc``
+  - ``~`` (``$HOME`` or your home directory)
+  - the directory where you are launching the backend or frontend from
+  - XDG directory for configuration (most of time it is
+    ``~/.config/sat/sat.conf``)
+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``
+will be used because it is parsed after ``/etc``).
+``sat.conf`` is a 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
+your media.
+Each frontend can have specific section with its name in lowercase (sections are case
+sensitive), and some backend plugin can use specific sections too (usually named ``plugin
+<plugin name>``). The ``pubsub`` section is used by ``SàT PubSub``. A section can also
+have the name of a web site used with Libervia web framework.
+To recapitulate, you can have the following sections in your ``sat.conf``:
+  the main, global section
+frontend name (in lower case)
+  frontend specific settings. Some examples:
+  - ``[cagou]``
+  - ``[jp]``
+  - ``[primitivus]``
+  - ``[libervia]``
+``[plugin <plugin name>]``
+  backend plugin specific settings. Some examples:
+  - ``[plugin account]``
+  - ``[plugin muc]``
+  - ``[plugin search]``
+  SàT PubSub settings
+``[<website name>]``
+  the settings of a website for Libervia web framework
+.. _INI:
+.. _SafeConfigParser:
+In the section, the option names suffixes are used to identify the type of settings:
+- ``_dir`` is used to indicate a path to a directory
+- ``_path`` is used to indicate a path (generally to a file, ``_dir`` being used for
+  directories)
+- ``_int`` indicate a integer
+- ``_list`` indicate a list comma-separated values
+- ``_dict`` indicate a dictionary
+- ``_json`` is used for complex data, represented with JSON format
+Remember that if you want to span your data on several lines (which is often used with
+``*_dict`` or ``*_json`` options), you need to indent the extra lines and keep the same
+Here is a configuration that you can use as a model to specify your own settings. Check
+the comments to get the meaning of each option.
+.. sourcecode:: cfg
+    [DEFAULT]
+    ; where SàT media are located
+    media_dir = ~/workspace/sat_media
+    log_level = debug
+    ; domain used for new accounts
+    xmpp_domain =
+    ; list of profiles with admin rights
+    admins_list = toto,titi
+    ; settings to let the backend send emails
+    email_from =
+    email_server = localhost
+    # email_port =
+    # email_username =
+    # email_password =
+    # email_starttls = true
+    # email_auth = true
+    # email_admins_list =,
+    ; override DNS records
+    hosts_dict = {
+        "": {"host": ""}
+        }
+    [plugin account]
+    ; where a new account must be created
+    new_account_server = localhost
+    new_account_domain =
+    [plugin muc]
+    ; default room to use in the "Join room" menu
+    default_muc =
+    [primitivus]
+    log_level = debug
+    ; how the logs are formatted
+    ; note that "%" must be doubled here
+    log_fmt = %%(levelname)s: %%(message)s
+    ; use bracketed paste mode
+    bracketed_paste = true
+    [jp]
+    ; how to use xdotool to refresh Firefox when doing "jp 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]
+    ; do we want "http", "https" or "both"?
+    connection_type = both
+    port = 8080
+    port_https = 8443
+    ; external port used for HTTPS (0 to use "port_https" value)
+    port_https_ext = 443
+    ; TLS public certificate or private key
+    ; and public certificate combined (PEM format)
+    tls_certificate = libervia.pem
+    ; TLS certificate private key (PEM format)
+    tls_private_key
+    ; if true (or 1), HTTP will redirect to HTTPS
+    redirect_to_https = 1
+    ; passphrase for libervia profile
+    passphrase = something_secure
+    ; here we redirect main libervia page
+    ; to the blog of a profile named "some_profile"
+    url_redirections_dict = {
+      "/": "/u/some_profile"
+      }
--- a/doc/index.rst	Sun Jul 21 10:16:32 2019 +0200
+++ b/doc/index.rst	Sun Jul 21 22:14:30 2019 +0200
@@ -24,7 +24,10 @@
    :maxdepth: 3
+   overview.rst
+   configuration.rst
+   /primitivus/index.rst
 Indices and tables
--- a/doc/jp/blog.rst	Sun Jul 21 10:16:32 2019 +0200
+++ b/doc/jp/blog.rst	Sun Jul 21 22:14:30 2019 +0200
@@ -33,7 +33,11 @@
 get command retrieves one or more blog post(s) from specified location (by default the
 personal blog of the profile).
-output can be customised to only retrieve some keys, or to use a specific template.
+output can be customised to only retrieve some keys, or to use a specific template. For
+instance, the following command retrieves only the title and publication date of the
+personal blog of the profile::
+  $ jp blog get -k title -k published
 :ref:`pubsub_common` commands are used to specify the blog location.
--- a/doc/jp/common_arguments.rst	Sun Jul 21 10:16:32 2019 +0200
+++ b/doc/jp/common_arguments.rst	Sun Jul 21 22:14:30 2019 +0200
@@ -176,6 +176,8 @@
   file. In other words, it's similar to ``-D, --current`` except that you specify the file
   to use instead of using the last available draft.
+.. _jp-output:
--- a/doc/jp/index.rst	Sun Jul 21 10:16:32 2019 +0200
+++ b/doc/jp/index.rst	Sun Jul 21 22:14:30 2019 +0200
@@ -1,3 +1,5 @@
+.. _jp-documentation:
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/overview.rst	Sun Jul 21 22:14:30 2019 +0200
@@ -0,0 +1,302 @@
+Salut à Toi Overview
+To have a better understanding of Salut a Toi, this page gives a global view of what it is
+and what are the important concepts linked to it. You don't need to read this to use it, but you
+can if you wish to understand "who is doing what".
+Salut à Toi (or SàT) is a XMPP client. `XMPP`_ is an open standard used
+for communication (notably instant messaging but not only). XMPP is a solid standard,
+which is decentralised and federated.
+SàT is not only focusing on instant messaging, and aims to be a universal communication
+tools. In other words, you can use SàT to chat, but also to blog publicly or privately, to
+share file, photo albums, to create events, to have discussion forum, etc.
+SàT is actually a whole ecosystem, and is made in a way that you can use it with many
+different interfaces (or "frontends"). There is a common central part which is called the
+"backend", it handles most of the work, while frontends are mostly about the interactions
+with user(s).
+To work, as SàT is a XMPP **client**, a XMPP **server** is needed. You can either run your
+own, or use an existing one (either public, or run by an organisation you belong to, like
+family server, run by a friend, your company, university, association, etc.). If you want
+to run your own server, there are already plenty of them and happily most of which are
+`libre <>`_, you can check an `up-to-date list
+on the XSF website <>`_ (the XSF or *XMPP Standards
+Foundation* being the non-profit organisation taking care of the XMPP standard).
+So to summarise, Salut à Toi, or SàT, is a communication ecosystem. Technically, it is a
+**XMPP client** which connect to an **XMPP server**. SàT itself works with a **backend**
+and one or many **frontends**.
+.. _XMPP:
+The backend is a daemon, that means that it's a service running in the background.
+It takes its main configuration from a file named ``sat.conf`` and can be in different
+locations (see below). It uses data in a directory called ``local_dir``, and which
+default, on suitable platforms, to the corresponding `XDG directory`_, which is most of
+time ``~/.local/share/sat``. In this directory, you'll find the main database in the
+``sat.db`` file, which is a `SQLite`_ database.
+The backend is run and stopped with the ``sat`` binary. Running it without argument launch
+the backend in the background, with ``sat fg`` you run it in the foreground (you'll see
+log directly and can stop the backend with ``Ctrl + c``). The ``sat status`` commands help
+you discover if the backend is running or stopped.
+.. _XDG directory:
+.. _SQLite:
+Frontends are used to make the interface between user and the backend. Frontends are
+adapted to different use cases, and must be started after the backend (if the backend is
+not started, you'll see a message telling you so). In most installations, the backend
+should be started automatically when you want to use a frontend.
+Bellow you'll see a list of the official frontends currently maintained:
+Cagou is the desktop/mobile frontend. It's probably the main interface for most users. It
+is based on the `Kivy`_ framework and should run of most platforms (for now it is
+officially tested only on GNU/Linux and Android phones and tablets).
+.. _Kivy:
+Libervia is the web frontend, and is the second main interface for most users. This
+frontend has the particularity to be in 2 parts: a server which serves HTTP content, and a
+client which runs in the browser. So you have Libervia server which connect to SàT backend
+which itself connect to the XMPP server, and your browser will connect to Libervia server.
+In the browser, you can access the server in two ways: either directly with what we call
+**Libervia pages**, or with a JavaScript code in `single-page application`_ which is the
+**Libervia client** (or **Libervia web app**) that we have mentioned above.
+The **Libervia pages** are web pages managing a single feature. They can work without
+JavaScript when it's possible (it's not the case for instant messaging or similar highly
+dynamic contents). They aims to be simple and straightforward to use.
+The **Libervia client** is a highly dynamic web application, used to access more features.
+It's more complete and may be well adapted if you want to let SàT running in a browser tab
+for an extended period.
+Please note that the current web application (SàT 0.7) will be completely rewritten for next 0.8 release.
+Last but not least, Libervia is also the central part of the new **web framework** of
+Salut à Toi. Indeed, in addition of being a frontend to SàT features (which is built with
+this framework), you can create totally different websites which are integrated in SàT
+(and so XMPP) ecosystem. This framework uses SàT template engine (based on `Jinja2`_) and
+makes the creation of decentralised and federated websites simple. Thanks to this framework,
+it's easy to experiment new ideas/features, or to change completely the look and feel of
+the Libervia frontend.
+The `official SàT website`_ is made with Libervia web framework.
+.. _single-page application:
+.. _Jinja2:
+.. _official SàT website:
+Primitivus is the Terminal User Interface (TUI). In other words, it works in console and
+is intended for people at ease with it. Its text only interface has several advantages:
+you get rid of many distracting things (like images), it works without graphical
+environment installed (which is often the case on servers) and it works on distant shell
+(like `ssh`_) while staying gentle with your bandwidth.
+Primitivus is shipped with the backend, so it should be always available once SàT is
+installed (but some distributions may provide it separately).
+You can check :ref:`primitivus-documentation` documentation for more details.
+.. _ssh:
+Jp is the Command Line Interface (CLI). It's a powerful tool which allows to do nearly
+everything you can do with other frontends. Particularly useful if you want to check
+something quickly, or if you want to do some automation.
+You can check :ref:`jp-documentation` documentation for more details.
+While using SàT you may see some terms or concept. This section explain the most important
+A profile is the name linked to an account data. Usually a profile correspond to an XMPP
+account, but you can have several profiles using the same XMPP account (with different
+parameters) even if this is not usual.
+On a SàT installation used by a single user, the profiles are usually used for multiple
+accounts. On a multi-users installations, there is usually one profile per user.
+When you connect to a SàT frontend, you need to specify a profile and the associated password. The profile password is not the same as the password of the XMPP account. While this may sounds confusing, there are several reason why we use this notion of profile instead of directly the XMPP account/password:
+- SàT needs to know the plain XMPP password to connect, and it is encrypted in database.
+  The profile password is used to encrypt/decrypt it, this way only a `password hash`_ is
+  stored and the XMPP password is encrypted `at rest`_.
+- As a further benefit, several passwords could be associated to the same profile (this
+  feature is currently not used in SàT).
+- profile password can be empty, in which case no password is requested when a profile is
+  used
+  .. note::
+   if you use an empty profile password, the XMPP password won't be encrypted in database
+   (or more precisely, will be trivial to decrypt).
+- a profile is a simple name associated with an account, it's easier to remember than a
+  whole XMPP identifier (also named "JID" for *Jabber ID*)
+You always have a *default* profile which is the profile used when you don't select any
+(notably used in jp). This is the first profile that you have created except if you have
+changed it using a frontend (you can change it with jp).
+.. _password hash:
+.. _at rest:
+profile key
+A profile **key** is a special name used as a way to select automatically one profile. The
+most important one is ``@DEFAULT@`` which, as you can guess, means the default profile.
+The "bridge" is the name used to design Salut à Toi's `IPC`_, or in other words the way
+the backend communicate with frontends. Several bridges can be used, the default one being
+The other available bridges are:
+  `Perspective Broker`_ is a part of `Twisted`_ (the framework used by the backend and some
+  frontends)
+  this embeds the backend into the frontend. The frontend is then using the backend as a
+  library.
+.. _IPC:
+.. _D-Bus:
+.. _Perspective Broker:
+.. _Twisted:
+SàT Media
+Most of the frontends use images or other media. To avoid duplication and to make the code
+repositories lighter, those media are grouped in a separate repository. The SàT media
+repository is available at You can also download media
+at The path where SàT media are
+installed must be specified in ``sat.conf`` in ``media_dir`` option of the ``[DEFAULT``
+SàT Templates
+SàT embeds a `Jinja2`_ template engine (see `Libervia`_ above). "SàT templates" refers to
+the default templates (i.e. the official templates, the ones used in default Libervia pages). Those template may also be used by other frontends than Libervia (jp can use them with the :ref:`jp-output` arguments).
+SàT templates repository is available at, they can
+also be downloaded at `PyPI <>`_ and will be
+installed automatically if you install Libervia.
+Related projects
+Some project are closely related to Salut à Toi, here is a list of official related
+SàT PubSub
+Numerous features of Salut à Toi are taking profit of `PubSub`_ functionalities of XMPP.
+Because PubSub implementations in the wild are not all on the same level, and some
+experimental features are sometimes explored, a PubSub service as been written
+specifically for the needs of SàT (but it's not depending on SàT and any XMPP software can
+use it).
+SàT PubSub aims to be a feature complete, server-independent PubSub implementation, and
+try to be up-to-date with latest XMPP PubSub extensions. It is the privileged service to
+use with SàT because it supports everything needed (but SàT can work with any XMPP PubSub
+service, it will adapt itself to available features).
+SàT PubSub can also be used as a `PEP`_ service, if some XMPP extensions are supported by
+your server (see below).
+.. _PubSub:
+.. _PEP:
+XMPP Extension Protocols
+For the needs of SàT or SàT PubSub, some `XMPP Extension Protocols`_ (or XEP) have been
+proposed and got an official number. The current list of extensions is:
+`XEP-0355`_: Namespace Delegation
+  This has been proposed for the needs of SàT PubSub, and allows the XMPP server to
+  "delegate" some features management to a third party service. It is needed to use SàT
+  Pubsub as a PEP service.
+`XEP-0356`_: Privileged Entity
+  In the same spirit as previous one, this has been done so SàT PubSub could be used as a
+  PEP service. This extensions allows a "component" (which is more or less a server
+  generic plugin) to gain some privileged access to data such as presence information,
+  roster or to send a message like if it was sent by the server.
+`XEP-0413`_: Order-By
+  This extension is used to specify the sorting order in which a client wishes to retrieve
+  some results. It is notably used by SàT and SàT PubSub to retrieve items like blog posts
+  or tickets in creation order or order of last modification.
+.. _XEP-0355:
+.. _XEP-0356:
+.. _XEP-0413:
+.. _XMPP Extension Protocols:
+Prosody's `mod_delegation`_ and `mod_privilege`_
+Prosody modules have been created to implement the *Namespace Delegation* and *Privileged
+Entity* extensions mentioned above. If you use Prosody, you'll have to activate those 2
+modules to use SàT PubSub as a PEP service.
+.. _mod_privilege:
+.. _mod_delegation:
+SàT official website
+The official website is made with Libervia web framework. You'll find it at
+Probably the smaller side project used by SàT, it is a simple users directory (registration must be done explicitly by users) using `XEP-0055`_ (Jabber Search).
+You'll find it at
+.. _XEP-0055:
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/primitivus/index.rst	Sun Jul 21 22:14:30 2019 +0200
@@ -0,0 +1,150 @@
+.. _primitivus-documentation:
+``Primitivus`` is the TUI (Terminal User Interface) frontend of Salut à Toi
+``Primitivus`` is a text based frontend. It is specially adapted for systems without
+graphical environments (e.g. servers), for low bandwidth remote shells (e.g. ssh) or for
+people who like straightforward interfaces without distracting images or animations.
+For the moment, Primitivus implements one 2 one chat, group chat (also called *MUC* for
+Multi-Users Chat), and some related features (end 2 end encryption, bookmarks, gateways
+interaction, file sending, etc.).
+Primitivus is modal (vi-like), one can switch from one mode to another
+in the same way as in vi/vim:
+-  From any mode, press ``[Esc]`` to switch to normal mode.
+-  From normal mode, press ``:`` to switch to command mode.
+-  From normal mode, press ``i`` to switch to insert mode – the one you
+   use to write messages to your contacts.
+Primitivus can be handled either with the mouse, in a very intuitive way, or with the
+keyboard. Below, the keyboard shortcuts are explained.
+Keyboard handling
+-  ``C`` stands for ``Ctrl``
+-  ``M`` means *Meta*, on a PC it is usually the ``Alt`` key
+-  ``S`` stands for ``Shift``
+Main keys
+``[tab]`` and/or ``C-up/down arrows``
+  change focus
+  quit Primitivus
+``C-f 1`` or ``C-f m``
+  focus on the menu
+``C-f 2`` or ``C-f b``
+  focus on the roster or the chat window
+``C-f 3`` or ``C-f e``
+  focus on the edition line
+  display/hide the menu
+  show the next notification
+  hide/redisplay a pop-up window temporarily
+  enter debug mode (development versions only)
+  hide/display the roster
+  refresh the screen
+Chat rooms
+To use those keyboard shortcuts, your cursor must be in a chat room.
+  join a chat room
+  hide/display the list of participants
+  hide/display timestamps
+  use/don't use short nicks
+  hide/display frame decorations
+  change the room's topic appearance by switching between:
+    - one single line (the topic is cut if it's too long)
+    - the full topic
+    - topic hidden
+  go to the end (bottom) of your history (note that this is UPPERCASE ``G``)
+Edition line
+``C-a`` or ``[home]``
+  move the cursor at the beginning of the line
+``C-e`` or ``[end]``
+  move the cursor at the end of the line
+  erase the line, starting at the cursor's position
+  erase the last word
+  invoke completion (dependent on the context)
+``up/down arrows``
+  browse sent messages history
+  hide/display offline contacts
+  hide/display contacts' status messages
+Card game
+  select a card
+The following commands must be typed in command mode (type ``[Esc]`` to switch to normal
+mode, then the ``:`` at the beginning of the command will switch to command mode).
+  quit Primitivus
+  display log messages (see also the logging configuration)
+  FIXME: :presence and :status are currently disabled in Primitivus
+  ``:presence [status]``
+    set your presence status. Invoked without argument, a pop-up will allow you to choose your presence status; otherwise, you can use the following arguments:
+    - ``online``
+    - ``chat`` (free to chat)
+    - ``away`` (away from keyboard)
+    - ``dnd`` (do not disturb)
+    - ``xa`` (extended away)
+  ``:status [message]``
+    set your status message. Invoked without argument, a pop-up will allow you to enter a message.
+``:history <size>``
+  set the number of lines of history to display in the chat window (``:history 0`` to clear the window)
+``:search <filter>``
+  do a full text search in this conversation/room. The room will be cleared an only
+  messages corresponding to ``<filter>`` will be show. Use ``:history <size>`` to
+  restore normal history