Mercurial > libervia-backend
comparison doc/installation.rst @ 3558:d8581c83fef3
doc (installation): update instruction to use requirements + fix name in a few places
author | Goffi <goffi@goffi.org> |
---|---|
date | Wed, 09 Jun 2021 17:31:52 +0200 |
parents | 0985c47ffd96 |
children | 267e4987b58b |
comparison
equal
deleted
inserted
replaced
3557:940b6cfa17f1 | 3558:d8581c83fef3 |
---|---|
2 | 2 |
3 ============ | 3 ============ |
4 Installation | 4 Installation |
5 ============ | 5 ============ |
6 | 6 |
7 This are the instructions to install SàT using Python. | 7 This are the instructions to install Libervia using Python. |
8 Note that if you are using GNU/Linux, Libervia may already be present on your distribution. | 8 Note that if you are using GNU/Linux, Libervia may already be present on your distribution. |
9 | 9 |
10 Libervia is made of one backend, and several frontends. To use it, the first thing to do is to install the backend. | 10 Libervia is made of one backend, and several frontends. To use it, the first thing to do is to install the backend. |
11 | 11 |
12 We recommand to use development version for now, until the release of 0.8. | 12 We recommand to use development version for now, until the release of 0.8. |
40 Now go in a location where you can install Libervia, for | 40 Now go in a location where you can install Libervia, for |
41 instance your home directory:: | 41 instance your home directory:: |
42 | 42 |
43 $ cd | 43 $ cd |
44 | 44 |
45 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 Libervia with SVG support, which is needed to |
46 display SVG avatars on some frontends):: | 46 display SVG avatars on some frontends):: |
47 | 47 |
48 $ python3 -m venv sat | 48 $ python3 -m venv sat |
49 $ source sat/bin/activate | 49 $ source sat/bin/activate |
50 $ pip install wheel | 50 $ pip install -U pip wheel |
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]" | 51 $ pip install -r requirements.txt |
52 | 52 |
53 Don't worry if you see the following message, SàT should work anyway:: | 53 Don't worry if you see the following message, Libervia should work anyway:: |
54 | 54 |
55 Failed building wheel for pygobject | 55 Failed building wheel for pygobject |
56 | 56 |
57 After installing SàT, you need to install the media:: | 57 After installing Libervia, you need to install the media:: |
58 | 58 |
59 $ cd | 59 $ cd |
60 $ hg clone https://repos.goffi.org/sat_media | 60 $ hg clone https://repos.goffi.org/sat_media |
61 | 61 |
62 then, create the directory ``~/.config/sat``:: | 62 then, create the directory ``~/.config/sat``:: |
91 | 91 |
92 To know if backend is launched or not:: | 92 To know if backend is launched or not:: |
93 | 93 |
94 $ sat status | 94 $ sat status |
95 | 95 |
96 **NOTE**: since SàT v0.5.0, the backend is automatically launched when a frontend needs it. | 96 **NOTE**: if ``misc/org.libervia.Libervia.service`` is installed correctly (which should |
97 be done by during the installation), the backend is automatically launched when a frontend | |
98 needs it. | |
97 | 99 |
98 You can check that SàT is installed correctly by trying jp (the backend need to be launched first, check below):: | 100 You can check that Libervia is installed correctly by trying jp (the backend need to be |
101 launched first, check below):: | |
99 | 102 |
100 $ jp --version | 103 $ li --version |
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 | 104 Libervia CLI 0.8.0D « La Cecília » (rev 184c66256bbc [M] (default 2021-06-09 11:35 +0200) +524) Copyright (C) 2009-2021 Jérôme Poisson, Adrien Cossa |
102 This program comes with ABSOLUTELY NO WARRANTY; | 105 This program comes with ABSOLUTELY NO WARRANTY; |
103 This is free software, and you are welcome to redistribute it under certain conditions. | 106 This is free software, and you are welcome to redistribute it under certain conditions. |
104 | 107 |
105 If you have a similar output, SàT is working. | 108 If you have a similar output, Libervia is working. |
106 | 109 |
107 .. note:: | 110 .. note:: |
108 | 111 |
109 if you have the message ``/!\ D-Bus is not launched, please see README to see | 112 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 | 113 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 | 114 usually happens when launching Libervia on a server, without graphic interface like X.org or |
112 Wayland (in which case D-Bus service should be launcher automatically). | 115 Wayland (in which case D-Bus service should be launcher automatically). |
113 | 116 |
114 As the message states, instructions on how to launch the service are given in the README | 117 As the message states, instructions on how to launch the service are given in the README |
115 file of Libervia. | 118 file of Libervia. |
116 | 119 |
117 Frontends | 120 Frontends |
118 ========= | 121 ========= |
119 | 122 |
120 So far, the following frontends exist and are actively maintained: | 123 So far, the following frontends exist and are actively maintained: |
121 | 124 |
122 Cagou | 125 Libervia Desktop (aka Cagou) |
123 desktop/mobile (Android) frontend | 126 desktop/mobile (Android) frontend |
124 | 127 |
125 Libervia | 128 Libervia Web |
126 the web frontend | 129 the web frontend |
127 | 130 |
128 Primitivus | 131 Libervia TUI (aka Primitivus) |
129 Text User Interface | 132 Text User Interface |
130 | 133 |
131 jp | 134 Libervia CLI (aka jp or li) |
132 Command Line Interface | 135 Command Line Interface |
133 | 136 |
134 To launch Primitivus, just type:: | 137 To launch Libervia TUI, just type:: |
135 | 138 |
136 $ primitivus | 139 $ libervia-tui |
137 | 140 |
138 then create a profile (XMPP account must already exist). | 141 then create a profile (XMPP account must already exist). |
139 | 142 |
140 To use jp, follow its help:: | 143 To use Libervia CLI, follow its help (``li`` is a shortcut for ``libervia-cli``):: |
141 | 144 |
142 $ jp --help | 145 $ li --help |
143 | 146 |
144 | 147 |
145 There are some other frontends: | 148 There are some other frontends: |
146 | 149 |
147 Bellaciao | 150 Bellaciao |