# HG changeset patch
# User Goffi <goffi@goffi.org>
# Date 1616270325 -3600
# Node ID aada5471d6bc957bdf1f48c6b32d977850792cdf
# Parent  4117f1b63765efec57536a60e1bc2a41c81c3ae7
doc: update installation instruction following renaming and new `requirements.txt`:

- `requirements.txt` are now used in installation instruction for dev version
- renamed config files, config section, executable according to recent changes
- added requirements section

diff -r 4117f1b63765 -r aada5471d6bc doc/installation.rst
--- a/doc/installation.rst	Sat Mar 20 18:23:18 2021 +0100
+++ b/doc/installation.rst	Sat Mar 20 20:58:45 2021 +0100
@@ -13,39 +13,56 @@
 We recommend to use development version for now, until the release of
 0.8 version.
 
+Requirements
+------------
+
+- Python 3.7+
+- Python 3 "venv", which may be installed with Python 3
+- Mercurial
+
+To install them on a Debian distribution or derivative, you can enter::
+
+    sudo apt-get install python3-dev python3-venv python3-wheel mercurial
+
 Development Version
 -------------------
 
 *Note for Arch users: a pkgbuild is available for your distribution on
 AUR, check sat-libervia-hg (as well as other sat-\* packages).*
 
-You can install the latest development version using pip. Please check backend documentation
-to see the system dependencies needed.
+You can install the latest development version using Mercurial and pip.
+
+Select the location where you want to install libervia and virtual environment, for
+instance your ``$HOME`` directory::
 
-You can use the same virtual environment as the one used for installing the backend. If
-you haven't installed it yet, just select a location when you want to install it, for
-instance your home directory::
+    $ cd
+
+You can use the same virtual environment as the one used for installing the backend.
+Otherwise, create a new one (backend will be installed automatically if it's not already
+there)::
 
-  $ cd
+    $ python3 -m venv libervia_venv
+    $ source libervia_venv/bin/activate
+    $ pip install -U pip wheel
 
-And enter the following commands (note that *virtualenv3* may be named
-*virtualenv* on some distributions, just be sure it's Python **3** version)::
+Then you need to clone the repository::
 
-  $ python3 -m venv sat
-  $ source sat/bin/activate
-  $ pip install wheel
-  $ pip install hg+https://repos.goffi.org/libervia
+    $ hg clone https://repos.goffi.org/libervia libervia-web && cd libervia-web
+
+Now you can install the requirements::
+
+    $ pip install -r requirements.txt
 
 If you haven't done it for the backend, you need to install the media::
 
   $ cd
   $ hg clone https://repos.goffi.org/sat_media
 
-then, create the directory ``~/.config/sat``::
+then, create the directory ``~/.config/libervia``::
 
-  $ mkdir -p ~/.config/sat
+  $ mkdir -p ~/.config/libervia
 
-and the file ``~/.config/sat/sat.conf`` containing:
+and the file ``~/.config/libervia/libervia.conf`` containing:
 
 .. sourcecode:: cfg
 
@@ -90,15 +107,15 @@
    remove the password from history.
 
 Finally, you need to specify to specify the password of this ``libervia`` profile in your
-configuration. To do so, edit your ``sat.conf`` and edit ``[libervia]`` and set the
+configuration. To do so, edit your ``libervia.conf`` and edit ``[libervia]`` and set the
 ``passphrase`` option to the profile password you have used in the command above:
 
 .. sourcecode:: cfg
 
-    [libervia]
+    [libervia_web]
     passphrase = <libervia_password>
 
-You should now be good to run the Libervia server.
+You should now be good to run the Libervia Web server.
 
 .. _Prosody: https://prosody.im
 
@@ -106,21 +123,21 @@
 Usage
 =====
 
-To launch the Libervia server, enter::
+To launch the Libervia Web server, enter::
 
-  $ libervia
+  $ libervia-web
 
 …or, if you want to launch it in foreground::
 
-  $ libervia fg
+  $ libervia-web fg
 
 You can stop it with::
 
-  $ libervia stop
+  $ libervia-web stop
 
 To know if backend is launched or not::
 
-  $ libervia status
+  $ libervia-web status
 
 
 SàT Pubsub