Mercurial > libervia-web

comparison doc/installation.rst @ 1401:aada5471d6bc

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: update installation instruction following renaming and new `requirements.txt`: - `requirements.txt` are now used in installation instruction for dev version - renamed config files, config section, executable according to recent changes - added requirements section
author Goffi <goffi@goffi.org>
date Sat, 20 Mar 2021 20:58:45 +0100
parents d1032f9ece5b
children e1ccba0d2b71
comparison
equal deleted inserted replaced
1400:4117f1b63765 1401:aada5471d6bc
11 start if the version backend has not the same version). 11 start if the version backend has not the same version).
12 12
13 We recommend to use development version for now, until the release of 13 We recommend to use development version for now, until the release of
14 0.8 version. 14 0.8 version.
15 15
16 Requirements
17 ------------
18
19 - Python 3.7+
20 - Python 3 "venv", which may be installed with Python 3
21 - Mercurial
22
23 To install them on a Debian distribution or derivative, you can enter::
24
25 sudo apt-get install python3-dev python3-venv python3-wheel mercurial
26
16 Development Version 27 Development Version
17 ------------------- 28 -------------------
18 29
19 *Note for Arch users: a pkgbuild is available for your distribution on 30 *Note for Arch users: a pkgbuild is available for your distribution on
20 AUR, check sat-libervia-hg (as well as other sat-\* packages).* 31 AUR, check sat-libervia-hg (as well as other sat-\* packages).*
21 32
22 You can install the latest development version using pip. Please check backend documentation 33 You can install the latest development version using Mercurial and pip.
23 to see the system dependencies needed.
24 34
25 You can use the same virtual environment as the one used for installing the backend. If 35 Select the location where you want to install libervia and virtual environment, for
26 you haven't installed it yet, just select a location when you want to install it, for 36 instance your ``$HOME`` directory::
27 instance your home directory::
28 37
29 $ cd 38 $ cd
30 39
31 And enter the following commands (note that *virtualenv3* may be named 40 You can use the same virtual environment as the one used for installing the backend.
32 *virtualenv* on some distributions, just be sure it's Python **3** version):: 41 Otherwise, create a new one (backend will be installed automatically if it's not already
42 there)::
33 43
34 $ python3 -m venv sat 44 $ python3 -m venv libervia_venv
35 $ source sat/bin/activate 45 $ source libervia_venv/bin/activate
36 $ pip install wheel 46 $ pip install -U pip wheel
37 $ pip install hg+https://repos.goffi.org/libervia 47
48 Then you need to clone the repository::
49
50 $ hg clone https://repos.goffi.org/libervia libervia-web && cd libervia-web
51
52 Now you can install the requirements::
53
54 $ pip install -r requirements.txt
38 55
39 If you haven't done it for the backend, you need to install the media:: 56 If you haven't done it for the backend, you need to install the media::
40 57
41 $ cd 58 $ cd
42 $ hg clone https://repos.goffi.org/sat_media 59 $ hg clone https://repos.goffi.org/sat_media
43 60
44 then, create the directory ``~/.config/sat``:: 61 then, create the directory ``~/.config/libervia``::
45 62
46 $ mkdir -p ~/.config/sat 63 $ mkdir -p ~/.config/libervia
47 64
48 and the file ``~/.config/sat/sat.conf`` containing: 65 and the file ``~/.config/libervia/libervia.conf`` containing:
49 66
50 .. sourcecode:: cfg 67 .. sourcecode:: cfg
51 68
52 [DEFAULT] 69 [DEFAULT]
53 media_dir = ~/sat_media 70 media_dir = ~/sat_media
88 visible for a few seconds in process list. If this is a concern for you (e.g. you use a 105 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 106 shared machine), use an other frontend to create the profile, or do the necessary to
90 remove the password from history. 107 remove the password from history.
91 108
92 Finally, you need to specify to specify the password of this ``libervia`` profile in your 109 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 110 configuration. To do so, edit your ``libervia.conf`` and edit ``[libervia]`` and set the
94 ``passphrase`` option to the profile password you have used in the command above: 111 ``passphrase`` option to the profile password you have used in the command above:
95 112
96 .. sourcecode:: cfg 113 .. sourcecode:: cfg
97 114
98 [libervia] 115 [libervia_web]
99 passphrase = <libervia_password> 116 passphrase = <libervia_password>
100 117
101 You should now be good to run the Libervia server. 118 You should now be good to run the Libervia Web server.
102 119
103 .. _Prosody: https://prosody.im 120 .. _Prosody: https://prosody.im
104 121
105 122
106 Usage 123 Usage
107 ===== 124 =====
108 125
109 To launch the Libervia server, enter:: 126 To launch the Libervia Web server, enter::
110 127
111 $ libervia 128 $ libervia-web
112 129
113 …or, if you want to launch it in foreground:: 130 …or, if you want to launch it in foreground::
114 131
115 $ libervia fg 132 $ libervia-web fg
116 133
117 You can stop it with:: 134 You can stop it with::
118 135
119 $ libervia stop 136 $ libervia-web stop
120 137
121 To know if backend is launched or not:: 138 To know if backend is launched or not::
122 139
123 $ libervia status 140 $ libervia-web status
124 141
125 142
126 SàT Pubsub 143 SàT Pubsub
127 ========== 144 ==========
128 145