diff doc/overview.rst @ 3488:c80a0f864b5d

doc: updated doc following global renaming
author Goffi <goffi@goffi.org>
date Sun, 21 Mar 2021 18:23:58 +0100
parents 7726916c1ba6
children 0985c47ffd96
line wrap: on
line diff
--- a/doc/overview.rst	Sun Mar 21 18:16:52 2021 +0100
+++ b/doc/overview.rst	Sun Mar 21 18:23:58 2021 +0100
@@ -2,24 +2,24 @@
 Overview
 ========
 
-To have a better understanding of Salut a Toi, this page gives a global view of what it is
+To have a better understanding of Libervia, 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.
+Libervia 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
+Libervia is not only focusing on instant messaging, and aims to be a universal communication
+tools. In other words, you can use Libervia 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
+Libervia 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
+To work, as Libervia 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
@@ -27,9 +27,9 @@
 on the XSF website <https://xmpp.org/software/servers.html>`_ (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**.
+So to summarise, Libervia is a communication ecosystem. Technically, it is a **XMPP
+client** which connect to an **XMPP server**. Libervia itself works with a **backend** and
+one or many **frontends**.
 
 .. _XMPP: https://xmpp.org
 
@@ -62,22 +62,23 @@
 
 Bellow you'll see a list of the official frontends currently maintained:
 
-Cagou
------
+Libervia Deskop/Mobile (Cagou)
+------------------------------
 
-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 on most platforms (for now it is
-officially tested only on GNU/Linux and Android phones and tablets).
+Libervia Desktop (alias ``Libervia Mobile`` or ``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 on most platforms (for now it is officially tested only on GNU/Linux and
+Android phones and tablets).
 
 .. _Kivy: https://kivy.org
 
-Libervia
---------
+Libervia Web
+------------
 
-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.
+The Web frontend 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 Libervia 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
@@ -88,56 +89,55 @@
 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
+It's more complete and may be well adapted if you want to let Libervia 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
+Libervia. Indeed, in addition of being a frontend to Libervia features (which is built with
+this framework), you can create totally different websites which are integrated in Libervia
+(and so XMPP) ecosystem. This framework uses Libervia 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.
+The `official Libervia website`_ is made with Libervia web framework.
 
 .. _single-page application: https://en.wikipedia.org/wiki/Single-page_application
 .. _Jinja2: http://jinja.pocoo.org/
-.. _official SàT website: https://salut-a-toi.org
+.. _official Libervia website: https://salut-a-toi.org
 
-Primitivus
-----------
+Libervia TUI (Primitivus)
+-------------------------
 
-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.
+Libervia TUI (alias ``Primitivus``) is the Terminal User Interface. 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
+Primitivus is shipped with the backend, so it should be always available once Libervia is
 installed (but some distributions may provide it separately).
 
-You can check :doc:`Primitivus documentation <primitivus/index>` for more details.
+You can check :doc:`Libervia TUI documentation <libervia-tui/index>` for more details.
 
 .. _ssh: https://en.wikipedia.org/wiki/Secure_Shell
 
-jp
---
+Libervia CLI (jp)
+-----------------
 
-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.
+Libervia CLI (alias ``li`` or ``jp``)  is the Command Line Interface. 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 :doc:`jp documentation <jp/index>` documentation for more details.
+You can check :doc:`Libervia CLI documentation <libervia-cli/index>` documentation for more details.
 
 .. _glossary:
 
 Glossary
 ========
 
-While using SàT you may see some terms or concept. This section explain the most important
+While using Libervia you may see some terms or concept. This section explain the most important
 ones.
 
 profile
@@ -147,17 +147,17 @@
 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
+On a Libervia 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:
+When you connect to a Libervia 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.
+- Libervia 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).
+  feature is currently not used in Libervia).
 
 - profile password can be empty, in which case no password is requested when a profile is
   used
@@ -186,7 +186,7 @@
 bridge
 ------
 
-The "bridge" is the name used to design Salut à Toi's `IPC`_, or in other words the way
+The "bridge" is the name used to design Libervia's `IPC`_, or in other words the way
 the backend communicate with frontends. Several bridges can be used, the default one being
 `D-Bus`_.
 
@@ -205,47 +205,47 @@
 .. _Perspective Broker: https://twistedmatrix.com/documents/current/core/howto/pb-intro.html
 .. _Twisted: https://twistedmatrix.com
 
-SàT Media
----------
+Libervia 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
+repositories lighter, those media are grouped in a separate repository. The Libervia media
 repository is available at https://repos.goffi.org/sat_media. You can also download media
-at https://ftp.goffi.org/sat_media/sat_media.tar.bz2. The path where SàT media are
+at https://ftp.goffi.org/sat_media/sat_media.tar.bz2. The path where Libervia media are
 installed must be specified in ``sat.conf`` in ``media_dir`` option of the ``[DEFAULT``
 section.
 
-SàT Templates
--------------
+Libervia 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).
+Libervia embeds a `Jinja2`_ template engine (see `Libervia Web`_ above). "Libervia 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:`libervia-cli_output` arguments).
 
-SàT templates repository is available at https://repos.goffi.org/sat_templates, they can
+Libervia templates repository is available at https://repos.goffi.org/sat_templates, they can
 also be downloaded at `PyPI <https://pypi.org/project/sat-templates/>`_ 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
+Some project are closely related to Libervia, here is a list of official related
 project.
 
-SàT PubSub
-----------
+Libervia PubSub
+---------------
 
-Numerous features of Salut à Toi are taking profit of `PubSub`_ functionalities of XMPP.
+Numerous features of Libervia 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
+specifically for the needs of Libervia (but it's not depending on Libervia and any XMPP software can
 use it).
 
-SàT PubSub aims to be a feature complete, server-independent PubSub implementation, and
+Libervia 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
+use with Libervia because it supports everything needed (but Libervia 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
+Libervia PubSub can also be used as a `PEP`_ service, if some XMPP extensions are supported by
 your server (see below).
 
 .. _PubSub: https://xmpp.org/about/technology-overview.html#pubsub
@@ -254,23 +254,23 @@
 XMPP Extension Protocols
 ------------------------
 
-For the needs of SàT or SàT PubSub, some `XMPP Extension Protocols`_ (or XEP) have been
+For the needs of Libervia or Libervia 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
+  This has been proposed for the needs of Libervia PubSub, and allows the XMPP server to
+  "delegate" some features management to a third party service. It is needed to use Libervia
   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
+  In the same spirit as previous one, this has been done so Libervia 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
+  some results. It is notably used by Libervia and Libervia PubSub to retrieve items like blog posts
   or tickets in creation order or order of last modification.
 
 .. _XEP-0355: https://xmpp.org/extensions/xep-0355.html
@@ -284,19 +284,19 @@
 
 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.
+modules to use Libervia PubSub as a PEP service.
 
 .. _mod_privilege: https://modules.prosody.im/mod_privilege.html
 .. _mod_delegation: https://modules.prosody.im/mod_delegation.html
 
-SàT official website
---------------------
+Libervia official website
+-------------------------
 
 The official website is made with Libervia web framework. You'll find it at https://repos.goffi.org/sat_web_site
 
 Salut
 -----
-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).
+Probably the smaller side project used by Libervia, it is a simple users directory (registration must be done explicitly by users) using `XEP-0055`_ (Jabber Search).
 
 You'll find it at https://repos.goffi.org/salut/