Mercurial > libervia-web
annotate doc/installation.rst @ 1353:d1032f9ece5b
doc: updated installation instructions
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Sun, 13 Sep 2020 15:01:22 +0200 |
| parents | 13447f785ba1 |
| children | aada5471d6bc |
| rev | line source |
|---|---|
| 1209 | 1 ============ |
| 2 Installation | |
| 3 ============ | |
| 4 | |
| 5 This are the instructions to install Libervia (SàT) using Python. | |
| 6 Note that if you are using GNU/Linux, Libervia may already be present on your distribution. | |
| 7 | |
| 8 Libervia is a Salut à Toi frontend, the SàT backend must be installed first (if you | |
| 9 haven't installed it yet, it will be downloaded automatically as it is a dependency of | |
| 10 Libervia). Libervia and SàT backend must always have the same version (Libervia won't | |
| 11 start if the version backend has not the same version). | |
| 12 | |
| 13 We recommend to use development version for now, until the release of | |
|
1353
d1032f9ece5b
doc: updated installation instructions
Goffi <goffi@goffi.org>
parents:
1209
diff
changeset
|
14 0.8 version. |
| 1209 | 15 |
| 16 Development Version | |
| 17 ------------------- | |
| 18 | |
| 19 *Note for Arch users: a pkgbuild is available for your distribution on | |
| 20 AUR, check sat-libervia-hg (as well as other sat-\* packages).* | |
| 21 | |
| 22 You can install the latest development version using pip. Please check backend documentation | |
| 23 to see the system dependencies needed. | |
| 24 | |
| 25 You can use the same virtual environment as the one used for installing the backend. If | |
| 26 you haven't installed it yet, just select a location when you want to install it, for | |
| 27 instance your home directory:: | |
| 28 | |
| 29 $ cd | |
| 30 | |
|
1353
d1032f9ece5b
doc: updated installation instructions
Goffi <goffi@goffi.org>
parents:
1209
diff
changeset
|
31 And enter the following commands (note that *virtualenv3* may be named |
|
d1032f9ece5b
doc: updated installation instructions
Goffi <goffi@goffi.org>
parents:
1209
diff
changeset
|
32 *virtualenv* on some distributions, just be sure it's Python **3** version):: |
| 1209 | 33 |
|
1353
d1032f9ece5b
doc: updated installation instructions
Goffi <goffi@goffi.org>
parents:
1209
diff
changeset
|
34 $ python3 -m venv sat |
|
d1032f9ece5b
doc: updated installation instructions
Goffi <goffi@goffi.org>
parents:
1209
diff
changeset
|
35 $ source sat/bin/activate |
|
d1032f9ece5b
doc: updated installation instructions
Goffi <goffi@goffi.org>
parents:
1209
diff
changeset
|
36 $ pip install wheel |
| 1209 | 37 $ pip install hg+https://repos.goffi.org/libervia |
| 38 | |
| 39 If you haven't done it for the backend, you need to install the media:: | |
| 40 | |
| 41 $ cd | |
| 42 $ hg clone https://repos.goffi.org/sat_media | |
| 43 | |
|
1353
d1032f9ece5b
doc: updated installation instructions
Goffi <goffi@goffi.org>
parents:
1209
diff
changeset
|
44 then, create the directory ``~/.config/sat``:: |
|
d1032f9ece5b
doc: updated installation instructions
Goffi <goffi@goffi.org>
parents:
1209
diff
changeset
|
45 |
|
d1032f9ece5b
doc: updated installation instructions
Goffi <goffi@goffi.org>
parents:
1209
diff
changeset
|
46 $ mkdir -p ~/.config/sat |
|
d1032f9ece5b
doc: updated installation instructions
Goffi <goffi@goffi.org>
parents:
1209
diff
changeset
|
47 |
|
d1032f9ece5b
doc: updated installation instructions
Goffi <goffi@goffi.org>
parents:
1209
diff
changeset
|
48 and the file ``~/.config/sat/sat.conf`` containing: |
|
d1032f9ece5b
doc: updated installation instructions
Goffi <goffi@goffi.org>
parents:
1209
diff
changeset
|
49 |
|
d1032f9ece5b
doc: updated installation instructions
Goffi <goffi@goffi.org>
parents:
1209
diff
changeset
|
50 .. sourcecode:: cfg |
|
d1032f9ece5b
doc: updated installation instructions
Goffi <goffi@goffi.org>
parents:
1209
diff
changeset
|
51 |
|
d1032f9ece5b
doc: updated installation instructions
Goffi <goffi@goffi.org>
parents:
1209
diff
changeset
|
52 [DEFAULT] |
|
d1032f9ece5b
doc: updated installation instructions
Goffi <goffi@goffi.org>
parents:
1209
diff
changeset
|
53 media_dir = ~/sat_media |
|
d1032f9ece5b
doc: updated installation instructions
Goffi <goffi@goffi.org>
parents:
1209
diff
changeset
|
54 |
|
d1032f9ece5b
doc: updated installation instructions
Goffi <goffi@goffi.org>
parents:
1209
diff
changeset
|
55 Of course, replace ``~/sat_media`` with the actual path you have used. |
|
d1032f9ece5b
doc: updated installation instructions
Goffi <goffi@goffi.org>
parents:
1209
diff
changeset
|
56 |
|
d1032f9ece5b
doc: updated installation instructions
Goffi <goffi@goffi.org>
parents:
1209
diff
changeset
|
57 Please check backend documentation for more details on the settings. |
|
d1032f9ece5b
doc: updated installation instructions
Goffi <goffi@goffi.org>
parents:
1209
diff
changeset
|
58 |
|
d1032f9ece5b
doc: updated installation instructions
Goffi <goffi@goffi.org>
parents:
1209
diff
changeset
|
59 You'll also need the ``yarn`` packager, please check your distribution documentation for |
|
d1032f9ece5b
doc: updated installation instructions
Goffi <goffi@goffi.org>
parents:
1209
diff
changeset
|
60 instructions to install it. |
|
d1032f9ece5b
doc: updated installation instructions
Goffi <goffi@goffi.org>
parents:
1209
diff
changeset
|
61 |
|
d1032f9ece5b
doc: updated installation instructions
Goffi <goffi@goffi.org>
parents:
1209
diff
changeset
|
62 .. note:: |
|
d1032f9ece5b
doc: updated installation instructions
Goffi <goffi@goffi.org>
parents:
1209
diff
changeset
|
63 |
|
d1032f9ece5b
doc: updated installation instructions
Goffi <goffi@goffi.org>
parents:
1209
diff
changeset
|
64 On Debian and derivatives, the ``yarn`` packager is installed with the ``yarnpkg`` |
|
d1032f9ece5b
doc: updated installation instructions
Goffi <goffi@goffi.org>
parents:
1209
diff
changeset
|
65 package (and not ``yarn`` only), you can install it with ``apt install yarnpkg`` as |
|
d1032f9ece5b
doc: updated installation instructions
Goffi <goffi@goffi.org>
parents:
1209
diff
changeset
|
66 root (or with ``sudo``). |
|
d1032f9ece5b
doc: updated installation instructions
Goffi <goffi@goffi.org>
parents:
1209
diff
changeset
|
67 |
| 1209 | 68 Post Installation |
| 69 ----------------- | |
| 70 | |
| 71 Libervia uses its own XMPP account to fetch public data. You need to create a profile | |
| 72 named `libervia` linked to this account to launch Libervia. First create an account | |
| 73 dedicated to this on your XMPP server. For instance with `Prosody`_ you would enter | |
| 74 something like:: | |
| 75 | |
| 76 $ prosodyctl adduser libervia@example.net | |
| 77 | |
| 78 Where you'll obviously change ``libervia@example.net`` for the JID you want to use, with | |
| 79 your domain name. You'll then be prompted for a password. You can now create the | |
| 80 associated SàT profile:: | |
| 81 | |
| 82 $ jp profile create libervia -j libervia@example.net -p <libervia_password> | |
| 83 | |
| 84 .. note:: | |
| 85 | |
| 86 jp doesn't prompt for password yet, this means that the password is visible to anybody | |
| 87 looking at your screen and will stay in your shell history, and the password will be | |
| 88 visible for a few seconds in process list. If this is a concern for you (e.g. you use a | |
| 89 shared machine), use an other frontend to create the profile, or do the necessary to | |
| 90 remove the password from history. | |
| 91 | |
| 92 Finally, you need to specify to specify the password of this ``libervia`` profile in your | |
| 93 configuration. To do so, edit your ``sat.conf`` and edit ``[libervia]`` and set the | |
| 94 ``passphrase`` option to the profile password you have used in the command above: | |
| 95 | |
| 96 .. sourcecode:: cfg | |
| 97 | |
| 98 [libervia] | |
| 99 passphrase = <libervia_password> | |
| 100 | |
| 101 You should now be good to run the Libervia server. | |
| 102 | |
| 103 .. _Prosody: https://prosody.im | |
| 104 | |
| 105 | |
| 106 Usage | |
| 107 ===== | |
| 108 | |
| 109 To launch the Libervia server, enter:: | |
| 110 | |
| 111 $ libervia | |
| 112 | |
| 113 …or, if you want to launch it in foreground:: | |
| 114 | |
| 115 $ libervia fg | |
| 116 | |
| 117 You can stop it with:: | |
| 118 | |
| 119 $ libervia stop | |
| 120 | |
| 121 To know if backend is launched or not:: | |
| 122 | |
| 123 $ libervia status | |
| 124 | |
| 125 | |
| 126 SàT Pubsub | |
| 127 ========== | |
| 128 | |
| 129 Some functionalities use advanced or experimental features of XMPP PubSub. We recommend to | |
| 130 use the SàT PubSub service that is a side project developed for the needs of Salut à Toi, | |
| 131 and consequently implements everything needed. Please refer to SàT PubSub documentation to | |
| 132 know how to install and use it. |