comparison 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
comparison
equal deleted inserted replaced
1352:d100d3a07dd7 1353:d1032f9ece5b
9 haven't installed it yet, it will be downloaded automatically as it is a dependency of 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 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). 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.7 version which will be "general public" version. 14 0.8 version.
15
16 Also note that Libervia as all SàT ecosystem is still using Python 2 (this will change for
17 0.8 version which will be Python 3 only), so all instructions below have to be made using
18 python 2.
19 15
20 Development Version 16 Development Version
21 ------------------- 17 -------------------
22 18
23 *Note for Arch users: a pkgbuild is available for your distribution on 19 *Note for Arch users: a pkgbuild is available for your distribution on
30 you haven't installed it yet, just select a location when you want to install it, for 26 you haven't installed it yet, just select a location when you want to install it, for
31 instance your home directory:: 27 instance your home directory::
32 28
33 $ cd 29 $ cd
34 30
35 And enter the following commands (note that *virtualenv2* may be named 31 And enter the following commands (note that *virtualenv3* may be named
36 *virtualenv* on some distributions, just be sure it's Python **2** version):: 32 *virtualenv* on some distributions, just be sure it's Python **3** version)::
37 33
38 $ virtualenv2 env 34 $ python3 -m venv sat
39 $ source env/bin/activate 35 $ source sat/bin/activate
36 $ pip install wheel
40 $ pip install hg+https://repos.goffi.org/libervia 37 $ pip install hg+https://repos.goffi.org/libervia
41 38
42 If you haven't done it for the backend, you need to install the media:: 39 If you haven't done it for the backend, you need to install the media::
43 40
44 $ cd 41 $ cd
45 $ hg clone https://repos.goffi.org/sat_media 42 $ hg clone https://repos.goffi.org/sat_media
43
44 then, create the directory ``~/.config/sat``::
45
46 $ mkdir -p ~/.config/sat
47
48 and the file ``~/.config/sat/sat.conf`` containing:
49
50 .. sourcecode:: cfg
51
52 [DEFAULT]
53 media_dir = ~/sat_media
54
55 Of course, replace ``~/sat_media`` with the actual path you have used.
56
57 Please check backend documentation for more details on the settings.
58
59 You'll also need the ``yarn`` packager, please check your distribution documentation for
60 instructions to install it.
61
62 .. note::
63
64 On Debian and derivatives, the ``yarn`` packager is installed with the ``yarnpkg``
65 package (and not ``yarn`` only), you can install it with ``apt install yarnpkg`` as
66 root (or with ``sudo``).
46 67
47 Post Installation 68 Post Installation
48 ----------------- 69 -----------------
49 70
50 Libervia uses its own XMPP account to fetch public data. You need to create a profile 71 Libervia uses its own XMPP account to fetch public data. You need to create a profile