Mercurial > libervia-backend
changeset 3353:7726916c1ba6
doc: updated installation instructions
author | Goffi <goffi@goffi.org> |
---|---|
date | Sun, 13 Sep 2020 22:49:11 +0200 |
parents | a3f940e3d72e |
children | aafb53248872 |
files | doc/installation.rst doc/overview.rst |
diffstat | 2 files changed, 22 insertions(+), 6 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/installation.rst Sun Sep 13 22:49:10 2020 +0200 +++ b/doc/installation.rst Sun Sep 13 22:49:11 2020 +0200 @@ -21,6 +21,7 @@ have the following dependencies installed first: - Python 3 with development headers +- Python 3 "venv", which may be installed with Python 3 - Mercurial - libcairo 2 with development headers - libjpeg with development headers @@ -34,7 +35,7 @@ On Debian and derivatives, you can get all this with following command:: - $ sudo apt-get install python-dev mercurial virtualenv libxml2-dev libxslt-dev libcairo2-dev libjpeg-dev libgirepository1.0-dev libdbus-1-dev libdbus-glib-1-dev dbus-x11 cmake + $ sudo apt-get install python3-dev python3-venv python3-wheel mercurial libxml2-dev libxslt-dev libcairo2-dev libjpeg-dev libgirepository1.0-dev libdbus-1-dev libdbus-glib-1-dev dbus-x11 cmake Now go in a location where you can install Salut à Toi, for instance your home directory:: @@ -46,7 +47,8 @@ $ python3 -m venv sat $ source sat/bin/activate - $ pip install hg+https://repos.goffi.org/sat_tmp hg+https://repos.goffi.org/sat#egg=sat[SVG] + $ pip install wheel + $ pip install hg+https://repos.goffi.org/sat_tmp "hg+https://repos.goffi.org/sat#egg=sat[SVG]" Don't worry if you see the following message, SàT should work anyway:: @@ -57,7 +59,11 @@ $ cd $ hg clone https://repos.goffi.org/sat_media -then, create the file ~/.config/sat/sat.conf containing: +then, create the directory ``~/.config/sat``:: + + $ mkdir -p ~/.config/sat + +and the file ``~/.config/sat/sat.conf`` containing: .. sourcecode:: cfg @@ -98,6 +104,16 @@ If you have a similar output, SàT is working. +.. note:: + + if you have the message ``/!\ D-Bus is not launched, please see README to see + instructions on how to launch it`` that mean that the D-Bus service is not launched, this + usually happens when launching SàT on a server, without graphic interface like X.org or + Wayland (in which case D-Bus service should be launcher automatically). + + As the message states, instructions on how to launch the service are given in the README + file of Salut à Toi. + Frontends =========
--- a/doc/overview.rst Sun Sep 13 22:49:10 2020 +0200 +++ b/doc/overview.rst Sun Sep 13 22:49:11 2020 +0200 @@ -162,10 +162,10 @@ - profile password can be empty, in which case no password is requested when a profile is used - .. note:: +.. 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). + 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*)