Mercurial > libervia-backend
annotate doc/installation.rst @ 3340:2ad14b834730
component file sharing: added `Access-Control-Expose-Headers` CORS header:
without this header, the range header in response was not exposed to client. This could
cause trouble is a javascript application was needing to access it.
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Sat, 15 Aug 2020 20:28:07 +0200 |
| parents | e9ecd133773b |
| children | 7726916c1ba6 |
| 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 |
| 2946 | 24 - Mercurial |
| 25 - libcairo 2 with development headers | |
| 26 - libjpeg with development headers | |
| 27 - libgirepository 1.0 with development headers | |
| 28 - libdbus-1 with development headers | |
| 29 - libdbus-glib-1 with development headers | |
| 30 - libxml2 with development headers | |
| 31 - libxlt2 with development headers | |
| 32 - D-Bus x11 tools (this doesn't needs X11, it is just needed for dbus-launch) | |
| 33 - cmake | |
| 34 | |
| 35 On Debian and derivatives, you can get all this with following command:: | |
| 36 | |
| 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 | |
| 39 Now go in a location where you can install Salut à Toi, for | |
| 40 instance your home directory:: | |
| 41 | |
| 42 $ cd | |
| 43 | |
|
3260
e9ecd133773b
doc (installation): updated instructions for backend
Goffi <goffi@goffi.org>
parents:
3022
diff
changeset
|
44 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
|
45 display SVG avatars on some frontends):: |
| 2946 | 46 |
|
3260
e9ecd133773b
doc (installation): updated instructions for backend
Goffi <goffi@goffi.org>
parents:
3022
diff
changeset
|
47 $ python3 -m venv sat |
|
e9ecd133773b
doc (installation): updated instructions for backend
Goffi <goffi@goffi.org>
parents:
3022
diff
changeset
|
48 $ source sat/bin/activate |
|
e9ecd133773b
doc (installation): updated instructions for backend
Goffi <goffi@goffi.org>
parents:
3022
diff
changeset
|
49 $ pip install hg+https://repos.goffi.org/sat_tmp hg+https://repos.goffi.org/sat#egg=sat[SVG] |
| 2946 | 50 |
| 51 Don't worry if you see the following message, SàT should work anyway:: | |
| 52 | |
| 53 Failed building wheel for pygobject | |
| 54 | |
| 55 After installing SàT, you need to install the media:: | |
| 56 | |
| 57 $ cd | |
| 58 $ hg clone https://repos.goffi.org/sat_media | |
| 59 | |
| 60 then, create the file ~/.config/sat/sat.conf containing: | |
| 61 | |
| 62 .. sourcecode:: cfg | |
| 63 | |
| 64 [DEFAULT] | |
| 65 media_dir = ~/sat_media | |
| 66 | |
| 67 Of course, replace ``~/sat_media`` with the actual path you have used. | |
| 68 | |
|
3260
e9ecd133773b
doc (installation): updated instructions for backend
Goffi <goffi@goffi.org>
parents:
3022
diff
changeset
|
69 You can check :ref:`configuration` for details |
| 2946 | 70 |
| 71 Usage | |
| 72 ===== | |
| 73 | |
| 74 To launch the sat backend, enter:: | |
| 75 | |
| 76 $ sat | |
| 77 | |
| 78 …or, if you want to launch it in foreground:: | |
| 79 | |
| 80 $ sat fg | |
| 81 | |
| 82 You can stop it with:: | |
| 83 | |
| 84 $ sat stop | |
| 85 | |
| 86 To know if backend is launched or not:: | |
| 87 | |
| 88 $ sat status | |
| 89 | |
| 90 **NOTE**: since SàT v0.5.0, the backend is automatically launched when a frontend needs it. | |
| 91 | |
| 92 You can check that SàT is installed correctly by trying jp (the backend need to be launched first, check below):: | |
| 93 | |
| 94 $ jp --version | |
|
3260
e9ecd133773b
doc (installation): updated instructions for backend
Goffi <goffi@goffi.org>
parents:
3022
diff
changeset
|
95 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 | 96 This program comes with ABSOLUTELY NO WARRANTY; |
| 97 This is free software, and you are welcome to redistribute it under certain conditions. | |
| 98 | |
| 99 If you have a similar output, SàT is working. | |
| 100 | |
| 101 Frontends | |
| 102 ========= | |
| 103 | |
| 104 So far, the following frontends exist and are actively maintained: | |
| 105 | |
| 106 Cagou | |
| 107 desktop/mobile (Android) frontend | |
| 108 | |
| 109 Libervia | |
| 110 the web frontend | |
| 111 | |
| 112 Primitivus | |
| 113 Text User Interface | |
| 114 | |
| 115 jp | |
| 116 Command Line Interface | |
| 117 | |
| 118 To launch Primitivus, just type:: | |
| 119 | |
| 120 $ primitivus | |
| 121 | |
| 122 then create a profile (XMPP account must already exist). | |
| 123 | |
| 124 To use jp, follow its help:: | |
| 125 | |
| 126 $ jp --help | |
| 127 | |
| 128 | |
| 129 There are some other frontends: | |
| 130 | |
| 131 Bellaciao | |
| 132 based on Qt, a rich desktop frontend (currently on hold) | |
| 133 | |
| 134 Wix | |
| 135 former desktop frontend based on WxWidgets (deprecated with version 0.6.0) | |
| 136 | |
| 137 Sententia | |
| 138 Emacs frontend developed by a third party (development is currently stalled) |