Mercurial > libervia-backend

comparison doc/installation.rst @ 3353:7726916c1ba6

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: updated installation instructions
author Goffi <goffi@goffi.org>
date Sun, 13 Sep 2020 22:49:11 +0200
parents e9ecd133773b
children 96b2f84a685c
comparison
equal deleted inserted replaced
3352:a3f940e3d72e 3353:7726916c1ba6
19 19
20 You can install the latest development version using pip. You need to 20 You can install the latest development version using pip. You need to
21 have the following dependencies installed first: 21 have the following dependencies installed first:
22 22
23 - Python 3 with development headers 23 - Python 3 with development headers
24 - Python 3 "venv", which may be installed with Python 3
24 - Mercurial 25 - Mercurial
25 - libcairo 2 with development headers 26 - libcairo 2 with development headers
26 - libjpeg with development headers 27 - libjpeg with development headers
27 - libgirepository 1.0 with development headers 28 - libgirepository 1.0 with development headers
28 - libdbus-1 with development headers 29 - libdbus-1 with development headers
32 - D-Bus x11 tools (this doesn't needs X11, it is just needed for dbus-launch) 33 - D-Bus x11 tools (this doesn't needs X11, it is just needed for dbus-launch)
33 - cmake 34 - cmake
34 35
35 On Debian and derivatives, you can get all this with following command:: 36 On Debian and derivatives, you can get all this with following command::
36 37
37 $ 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 38 $ 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
38 39
39 Now go in a location where you can install Salut à Toi, for 40 Now go in a location where you can install Salut à Toi, for
40 instance your home directory:: 41 instance your home directory::
41 42
42 $ cd 43 $ cd
44 And enter the following commands (here we install SàT with SVG support, which is needed to 45 And enter the following commands (here we install SàT with SVG support, which is needed to
45 display SVG avatars on some frontends):: 46 display SVG avatars on some frontends)::
46 47
47 $ python3 -m venv sat 48 $ python3 -m venv sat
48 $ source sat/bin/activate 49 $ source sat/bin/activate
49 $ pip install hg+https://repos.goffi.org/sat_tmp hg+https://repos.goffi.org/sat#egg=sat[SVG] 50 $ pip install wheel
51 $ pip install hg+https://repos.goffi.org/sat_tmp "hg+https://repos.goffi.org/sat#egg=sat[SVG]"
50 52
51 Don't worry if you see the following message, SàT should work anyway:: 53 Don't worry if you see the following message, SàT should work anyway::
52 54
53 Failed building wheel for pygobject 55 Failed building wheel for pygobject
54 56
55 After installing SàT, you need to install the media:: 57 After installing SàT, you need to install the media::
56 58
57 $ cd 59 $ cd
58 $ hg clone https://repos.goffi.org/sat_media 60 $ hg clone https://repos.goffi.org/sat_media
59 61
60 then, create the file ~/.config/sat/sat.conf containing: 62 then, create the directory ``~/.config/sat``::
63
64 $ mkdir -p ~/.config/sat
65
66 and the file ``~/.config/sat/sat.conf`` containing:
61 67
62 .. sourcecode:: cfg 68 .. sourcecode:: cfg
63 69
64 [DEFAULT] 70 [DEFAULT]
65 media_dir = ~/sat_media 71 media_dir = ~/sat_media
96 This program comes with ABSOLUTELY NO WARRANTY; 102 This program comes with ABSOLUTELY NO WARRANTY;
97 This is free software, and you are welcome to redistribute it under certain conditions. 103 This is free software, and you are welcome to redistribute it under certain conditions.
98 104
99 If you have a similar output, SàT is working. 105 If you have a similar output, SàT is working.
100 106
107 .. note::
108
109 if you have the message ``/!\ D-Bus is not launched, please see README to see
110 instructions on how to launch it`` that mean that the D-Bus service is not launched, this
111 usually happens when launching SàT on a server, without graphic interface like X.org or
112 Wayland (in which case D-Bus service should be launcher automatically).
113
114 As the message states, instructions on how to launch the service are given in the README
115 file of Salut à Toi.
116
101 Frontends 117 Frontends
102 ========= 118 =========
103 119
104 So far, the following frontends exist and are actively maintained: 120 So far, the following frontends exist and are actively maintained:
105 121