Mercurial > libervia-web
comparison doc/installation.rst @ 1521:0d517b596568
doc: update installation instruction
author | Goffi <goffi@goffi.org> |
---|---|
date | Wed, 07 Jun 2023 09:35:36 +0200 |
parents | e1ccba0d2b71 |
children | c62027660ec1 |
comparison
equal
deleted
inserted
replaced
1520:88f99488e604 | 1521:0d517b596568 |
---|---|
1 ============ | 1 ============ |
2 Installation | 2 Installation |
3 ============ | 3 ============ |
4 | 4 |
5 This are the instructions to install Libervia (SàT) using Python. | 5 This are the instructions to install Libervia Web using Python. |
6 Note that if you are using GNU/Linux, Libervia may already be present on your distribution. | 6 Note that if you are using GNU/Linux, Libervia Web may already be present on your |
7 distribution. | |
7 | 8 |
8 Libervia is a Salut à Toi frontend, the SàT backend must be installed first (if you | 9 This is the web frontend of Libervia, the Libervia 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 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 Libervia Web). Libervia Web and Libervia Backend must always have the same version |
11 start if the version backend has not the same version). | 12 (Libervia Web won't start if the version backend differs). |
12 | 13 |
13 We recommend to use development version for now, until the release of | 14 We recommend to use development version for now, until the release of |
14 0.8 version. | 15 0.8 version. |
15 | 16 |
16 Requirements | 17 Requirements |
47 | 48 |
48 Then you need to clone the repository:: | 49 Then you need to clone the repository:: |
49 | 50 |
50 $ hg clone https://repos.goffi.org/libervia libervia-web && cd libervia-web | 51 $ hg clone https://repos.goffi.org/libervia libervia-web && cd libervia-web |
51 | 52 |
52 Now you can install the requirements:: | 53 Now you can install the frontend and its requirements:: |
53 | 54 |
54 $ pip install -r requirements.txt | 55 $ pip install . |
55 | 56 |
56 If you haven't done it for the backend, you need to install the media:: | 57 If you haven't done it for the backend, you need to install the media:: |
57 | 58 |
58 $ cd | 59 $ cd |
59 $ hg clone https://repos.goffi.org/libervia-media | 60 $ hg clone https://repos.goffi.org/libervia-media |
92 | 93 |
93 $ prosodyctl adduser libervia@example.net | 94 $ prosodyctl adduser libervia@example.net |
94 | 95 |
95 Where you'll obviously change ``libervia@example.net`` for the JID you want to use, with | 96 Where you'll obviously change ``libervia@example.net`` for the JID you want to use, with |
96 your domain name. You'll then be prompted for a password. You can now create the | 97 your domain name. You'll then be prompted for a password. You can now create the |
97 associated SàT profile:: | 98 associated Libervia profile:: |
98 | 99 |
99 $ jp profile create libervia -j libervia@example.net -p <libervia_password> | 100 $ li profile create libervia -j libervia@example.net -p <libervia_password> |
100 | 101 |
101 .. note:: | 102 .. note:: |
102 | 103 |
103 jp doesn't prompt for password yet, this means that the password is visible to anybody | 104 Libervia CLI doesn't prompt for password yet, this means that the password is visible |
104 looking at your screen and will stay in your shell history, and the password will be | 105 to anybody looking at your screen and will stay in your shell history, and the password |
105 visible for a few seconds in process list. If this is a concern for you (e.g. you use a | 106 will be visible for a few seconds in process list. If this is a concern for you (e.g. |
106 shared machine), use an other frontend to create the profile, or do the necessary to | 107 you use a shared machine), use an other frontend to create the profile, or do the |
107 remove the password from history. | 108 necessary to remove the password from history. In most shells, you can add a space in |
109 front of the command so that it doesn't appear in the history. | |
108 | 110 |
109 Finally, you need to specify to specify the password of this ``libervia`` profile in your | 111 Finally, you need to specify to specify the password of this ``libervia`` profile in your |
110 configuration. To do so, edit your ``libervia.conf`` and edit ``[libervia]`` and set the | 112 configuration. To do so, edit your ``libervia.conf`` and edit ``[libervia]`` and set the |
111 ``passphrase`` option to the profile password you have used in the command above: | 113 ``passphrase`` option to the profile password you have used in the command above: |
112 | 114 |
113 .. sourcecode:: cfg | 115 .. sourcecode:: cfg |
114 | 116 |
115 [libervia_web] | 117 [web] |
116 passphrase = <libervia_password> | 118 passphrase = <libervia_password> |
117 | 119 |
118 You should now be good to run the Libervia Web server. | 120 You should now be good to run the Libervia Web server. |
119 | 121 |
120 .. _Prosody: https://prosody.im | 122 .. _Prosody: https://prosody.im |
138 To know if backend is launched or not:: | 140 To know if backend is launched or not:: |
139 | 141 |
140 $ libervia-web status | 142 $ libervia-web status |
141 | 143 |
142 | 144 |
143 SàT Pubsub | 145 Libervia Pubsub |
144 ========== | 146 =============== |
145 | 147 |
146 Some functionalities use advanced or experimental features of XMPP PubSub. We recommend to | 148 Some functionalities use advanced or experimental features of XMPP PubSub. We recommend to |
147 use the SàT PubSub service that is a side project developed for the needs of Salut à Toi, | 149 use the Libervia PubSub service that is a side project developed for the needs of |
148 and consequently implements everything needed. Please refer to SàT PubSub documentation to | 150 Libervia, and consequently implements everything needed. Please refer to Libervia PubSub |
149 know how to install and use it. | 151 documentation to know how to install and use it. |