Mercurial > libervia-web
diff doc/installation.rst @ 1521:0d517b596568
doc: update installation instruction
author | Goffi <goffi@goffi.org> |
---|---|
date | Wed, 07 Jun 2023 09:35:36 +0200 |
parents | e1ccba0d2b71 |
children | c62027660ec1 |
line wrap: on
line diff
--- a/doc/installation.rst Wed Jun 07 09:17:05 2023 +0200 +++ b/doc/installation.rst Wed Jun 07 09:35:36 2023 +0200 @@ -2,13 +2,14 @@ Installation ============ -This are the instructions to install Libervia (SàT) using Python. -Note that if you are using GNU/Linux, Libervia may already be present on your distribution. +This are the instructions to install Libervia Web using Python. +Note that if you are using GNU/Linux, Libervia Web may already be present on your +distribution. -Libervia is a Salut à Toi frontend, the SàT backend must be installed first (if you +This is the web frontend of Libervia, the Libervia backend must be installed first (if you haven't installed it yet, it will be downloaded automatically as it is a dependency of -Libervia). Libervia and SàT backend must always have the same version (Libervia won't -start if the version backend has not the same version). +Libervia Web). Libervia Web and Libervia Backend must always have the same version +(Libervia Web won't start if the version backend differs). We recommend to use development version for now, until the release of 0.8 version. @@ -49,9 +50,9 @@ $ hg clone https://repos.goffi.org/libervia libervia-web && cd libervia-web -Now you can install the requirements:: +Now you can install the frontend and its requirements:: - $ pip install -r requirements.txt + $ pip install . If you haven't done it for the backend, you need to install the media:: @@ -94,17 +95,18 @@ Where you'll obviously change ``libervia@example.net`` for the JID you want to use, with your domain name. You'll then be prompted for a password. You can now create the -associated SàT profile:: +associated Libervia profile:: - $ jp profile create libervia -j libervia@example.net -p <libervia_password> + $ li profile create libervia -j libervia@example.net -p <libervia_password> .. note:: - jp doesn't prompt for password yet, this means that the password is visible to anybody - looking at your screen and will stay in your shell history, and the password will be - visible for a few seconds in process list. If this is a concern for you (e.g. you use a - shared machine), use an other frontend to create the profile, or do the necessary to - remove the password from history. + Libervia CLI doesn't prompt for password yet, this means that the password is visible + to anybody looking at your screen and will stay in your shell history, and the password + will be visible for a few seconds in process list. If this is a concern for you (e.g. + you use a shared machine), use an other frontend to create the profile, or do the + necessary to remove the password from history. In most shells, you can add a space in + front of the command so that it doesn't appear in the history. Finally, you need to specify to specify the password of this ``libervia`` profile in your configuration. To do so, edit your ``libervia.conf`` and edit ``[libervia]`` and set the @@ -112,7 +114,7 @@ .. sourcecode:: cfg - [libervia_web] + [web] passphrase = <libervia_password> You should now be good to run the Libervia Web server. @@ -140,10 +142,10 @@ $ libervia-web status -SàT Pubsub -========== +Libervia Pubsub +=============== Some functionalities use advanced or experimental features of XMPP PubSub. We recommend to -use the SàT PubSub service that is a side project developed for the needs of Salut à Toi, -and consequently implements everything needed. Please refer to SàT PubSub documentation to -know how to install and use it. +use the Libervia PubSub service that is a side project developed for the needs of +Libervia, and consequently implements everything needed. Please refer to Libervia PubSub +documentation to know how to install and use it.