Mercurial > libervia-backend
annotate doc/installation.rst @ 3472:e12e9e1535d3
tools (xml_tools): new `dataForm2dataDict` and `dataDict2dataForm`:
those methods convert a serialisable dict format to `wokkel.data_form.Form` and vice versa
author | Goffi <goffi@goffi.org> |
---|---|
date | Sat, 27 Feb 2021 18:36:38 +0100 |
parents | dea30b1eb166 |
children | 4705f80b6e23 |
rev | line source |
---|---|
3022 | 1 .. _installation: |
2 | |
2946 | 3 ============ |
4 Installation | |
5 ============ | |
6 | |
7 This are the instructions to install SàT using Python. | |
8 Note that if you are using GNU/Linux, Salut à Toi may already be present on your distribution. | |
9 | |
10 Salut à Toi is made of one backend, and several frontends. To use it, the first thing to do is to install the backend. | |
11 | |
3260
e9ecd133773b
doc (installation): updated instructions for backend
Goffi <goffi@goffi.org>
parents:
3022
diff
changeset
|
12 We recommand to use development version for now, until the release of 0.8. |
2946 | 13 |
14 Development version | |
15 ------------------- | |
16 | |
17 *Note for Arch users: a pkgbuild is available for your distribution on | |
18 AUR, check sat-xmpp-hg (as well as other sat-\* packages).* | |
19 | |
20 You can install the latest development version using pip. You need to | |
21 have the following dependencies installed first: | |
22 | |
3260
e9ecd133773b
doc (installation): updated instructions for backend
Goffi <goffi@goffi.org>
parents:
3022
diff
changeset
|
23 - Python 3 with development headers |
3383 | 24 - Python 3 "venv", which may already be installed with Python 3 |
2946 | 25 - Mercurial |
3383 | 26 - libcairo 2 with development header |
2946 | 27 - libjpeg with development headers |
28 - libgirepository 1.0 with development headers | |
29 - libdbus-1 with development headers | |
30 - libdbus-glib-1 with development headers | |
31 - libxml2 with development headers | |
32 - libxlt2 with development headers | |
33 - D-Bus x11 tools (this doesn't needs X11, it is just needed for dbus-launch) | |
34 - cmake | |
35 | |
36 On Debian and derivatives, you can get all this with following command:: | |
37 | |
3353
7726916c1ba6
doc: updated installation instructions
Goffi <goffi@goffi.org>
parents:
3260
diff
changeset
|
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 |
2946 | 39 |
40 Now go in a location where you can install Salut à Toi, for | |
41 instance your home directory:: | |
42 | |
43 $ cd | |
44 | |
3260
e9ecd133773b
doc (installation): updated instructions for backend
Goffi <goffi@goffi.org>
parents:
3022
diff
changeset
|
45 And enter the following commands (here we install SàT with SVG support, which is needed to |
e9ecd133773b
doc (installation): updated instructions for backend
Goffi <goffi@goffi.org>
parents:
3022
diff
changeset
|
46 display SVG avatars on some frontends):: |
2946 | 47 |
3260
e9ecd133773b
doc (installation): updated instructions for backend
Goffi <goffi@goffi.org>
parents:
3022
diff
changeset
|
48 $ python3 -m venv sat |
e9ecd133773b
doc (installation): updated instructions for backend
Goffi <goffi@goffi.org>
parents:
3022
diff
changeset
|
49 $ source sat/bin/activate |
3353
7726916c1ba6
doc: updated installation instructions
Goffi <goffi@goffi.org>
parents:
3260
diff
changeset
|
50 $ pip install wheel |
3369
96b2f84a685c
doc (installation): added instruction to download dev version of `sat_template`
Goffi <goffi@goffi.org>
parents:
3353
diff
changeset
|
51 $ pip install hg+https://repos.goffi.org/sat_tmp hg+https://repos.goffi.org/sat_templates "hg+https://repos.goffi.org/sat#egg=sat[SVG]" |
2946 | 52 |
53 Don't worry if you see the following message, SàT should work anyway:: | |
54 | |
55 Failed building wheel for pygobject | |
56 | |
57 After installing SàT, you need to install the media:: | |
58 | |
59 $ cd | |
60 $ hg clone https://repos.goffi.org/sat_media | |
61 | |
3353
7726916c1ba6
doc: updated installation instructions
Goffi <goffi@goffi.org>
parents:
3260
diff
changeset
|
62 then, create the directory ``~/.config/sat``:: |
7726916c1ba6
doc: updated installation instructions
Goffi <goffi@goffi.org>
parents:
3260
diff
changeset
|
63 |
7726916c1ba6
doc: updated installation instructions
Goffi <goffi@goffi.org>
parents:
3260
diff
changeset
|
64 $ mkdir -p ~/.config/sat |
7726916c1ba6
doc: updated installation instructions
Goffi <goffi@goffi.org>
parents:
3260
diff
changeset
|
65 |
7726916c1ba6
doc: updated installation instructions
Goffi <goffi@goffi.org>
parents:
3260
diff
changeset
|
66 and the file ``~/.config/sat/sat.conf`` containing: |
2946 | 67 |
68 .. sourcecode:: cfg | |
69 | |
70 [DEFAULT] | |
71 media_dir = ~/sat_media | |
72 | |
73 Of course, replace ``~/sat_media`` with the actual path you have used. | |
74 | |
3260
e9ecd133773b
doc (installation): updated instructions for backend
Goffi <goffi@goffi.org>
parents:
3022
diff
changeset
|
75 You can check :ref:`configuration` for details |
2946 | 76 |
77 Usage | |
78 ===== | |
79 | |
80 To launch the sat backend, enter:: | |
81 | |
82 $ sat | |
83 | |
84 …or, if you want to launch it in foreground:: | |
85 | |
86 $ sat fg | |
87 | |
88 You can stop it with:: | |
89 | |
90 $ sat stop | |
91 | |
92 To know if backend is launched or not:: | |
93 | |
94 $ sat status | |
95 | |
96 **NOTE**: since SàT v0.5.0, the backend is automatically launched when a frontend needs it. | |
97 | |
98 You can check that SàT is installed correctly by trying jp (the backend need to be launched first, check below):: | |
99 | |
100 $ jp --version | |
3260
e9ecd133773b
doc (installation): updated instructions for backend
Goffi <goffi@goffi.org>
parents:
3022
diff
changeset
|
101 jp 0.8.0D « La Cecília » (rev df26f1a9020a [M] (default 2020-04-14 21:01 +0200) +231) Copyright (C) 2009-2020 Jérôme Poisson, Adrien Cossa |
2946 | 102 This program comes with ABSOLUTELY NO WARRANTY; |
103 This is free software, and you are welcome to redistribute it under certain conditions. | |
104 | |
105 If you have a similar output, SàT is working. | |
106 | |
3353
7726916c1ba6
doc: updated installation instructions
Goffi <goffi@goffi.org>
parents:
3260
diff
changeset
|
107 .. note:: |
7726916c1ba6
doc: updated installation instructions
Goffi <goffi@goffi.org>
parents:
3260
diff
changeset
|
108 |
7726916c1ba6
doc: updated installation instructions
Goffi <goffi@goffi.org>
parents:
3260
diff
changeset
|
109 if you have the message ``/!\ D-Bus is not launched, please see README to see |
7726916c1ba6
doc: updated installation instructions
Goffi <goffi@goffi.org>
parents:
3260
diff
changeset
|
110 instructions on how to launch it`` that mean that the D-Bus service is not launched, this |
7726916c1ba6
doc: updated installation instructions
Goffi <goffi@goffi.org>
parents:
3260
diff
changeset
|
111 usually happens when launching SàT on a server, without graphic interface like X.org or |
7726916c1ba6
doc: updated installation instructions
Goffi <goffi@goffi.org>
parents:
3260
diff
changeset
|
112 Wayland (in which case D-Bus service should be launcher automatically). |
7726916c1ba6
doc: updated installation instructions
Goffi <goffi@goffi.org>
parents:
3260
diff
changeset
|
113 |
7726916c1ba6
doc: updated installation instructions
Goffi <goffi@goffi.org>
parents:
3260
diff
changeset
|
114 As the message states, instructions on how to launch the service are given in the README |
7726916c1ba6
doc: updated installation instructions
Goffi <goffi@goffi.org>
parents:
3260
diff
changeset
|
115 file of Salut à Toi. |
7726916c1ba6
doc: updated installation instructions
Goffi <goffi@goffi.org>
parents:
3260
diff
changeset
|
116 |
2946 | 117 Frontends |
118 ========= | |
119 | |
120 So far, the following frontends exist and are actively maintained: | |
121 | |
122 Cagou | |
123 desktop/mobile (Android) frontend | |
124 | |
125 Libervia | |
126 the web frontend | |
127 | |
128 Primitivus | |
129 Text User Interface | |
130 | |
131 jp | |
132 Command Line Interface | |
133 | |
134 To launch Primitivus, just type:: | |
135 | |
136 $ primitivus | |
137 | |
138 then create a profile (XMPP account must already exist). | |
139 | |
140 To use jp, follow its help:: | |
141 | |
142 $ jp --help | |
143 | |
144 | |
145 There are some other frontends: | |
146 | |
147 Bellaciao | |
148 based on Qt, a rich desktop frontend (currently on hold) | |
149 | |
150 Wix | |
151 former desktop frontend based on WxWidgets (deprecated with version 0.6.0) | |
152 | |
153 Sententia | |
154 Emacs frontend developed by a third party (development is currently stalled) |