Mercurial > libervia-backend

comparison doc/installation.rst @ 3260:e9ecd133773b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc (installation): updated instructions for backend
author Goffi <goffi@goffi.org>
date Sun, 19 Apr 2020 16:54:13 +0200
parents 03fe31effa7f
children 7726916c1ba6
comparison
equal deleted inserted replaced
3259:f300d78f08f3 3260:e9ecd133773b
7 This are the instructions to install SàT using Python. 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. 8 Note that if you are using GNU/Linux, Salut à Toi may already be present on your distribution.
9 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. 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 11
12 We recommand to use development version for now, until the release of 12 We recommand to use development version for now, until the release of 0.8.
13 0.7 version which will be "general public" version.
14
15 Also note that SàT is still using Python 2 (this will change for 0.8 version which will be Python 3 only), so all instructions below have to be made using python 2.
16 13
17 Development version 14 Development version
18 ------------------- 15 -------------------
19 16
20 *Note for Arch users: a pkgbuild is available for your distribution on 17 *Note for Arch users: a pkgbuild is available for your distribution on
21 AUR, check sat-xmpp-hg (as well as other sat-\* packages).* 18 AUR, check sat-xmpp-hg (as well as other sat-\* packages).*
22 19
23 You can install the latest development version using pip. You need to 20 You can install the latest development version using pip. You need to
24 have the following dependencies installed first: 21 have the following dependencies installed first:
25 22
26 - Python 2 with development headers 23 - Python 3 with development headers
27 - Mercurial 24 - Mercurial
28 - VirtualEnv
29 - libcairo 2 with development headers 25 - libcairo 2 with development headers
30 - libjpeg with development headers 26 - libjpeg with development headers
31 - libgirepository 1.0 with development headers 27 - libgirepository 1.0 with development headers
32 - libdbus-1 with development headers 28 - libdbus-1 with development headers
33 - libdbus-glib-1 with development headers 29 - libdbus-glib-1 with development headers
43 Now go in a location where you can install Salut à Toi, for 39 Now go in a location where you can install Salut à Toi, for
44 instance your home directory:: 40 instance your home directory::
45 41
46 $ cd 42 $ cd
47 43
48 And enter the following commands (note that *virtualenv2* may be named 44 And enter the following commands (here we install SàT with SVG support, which is needed to
49 *virtualenv* on some distributions, just be sure it's Python **2** version):: 45 display SVG avatars on some frontends)::
50 46
51 $ virtualenv2 env 47 $ python3 -m venv sat
52 $ source env/bin/activate 48 $ source sat/bin/activate
53 $ pip install hg+https://repos.goffi.org/sat 49 $ pip install hg+https://repos.goffi.org/sat_tmp hg+https://repos.goffi.org/sat#egg=sat[SVG]
54 50
55 Don't worry if you see the following message, SàT should work anyway:: 51 Don't worry if you see the following message, SàT should work anyway::
56 52
57 Failed building wheel for pygobject 53 Failed building wheel for pygobject
58 54
68 [DEFAULT] 64 [DEFAULT]
69 media_dir = ~/sat_media 65 media_dir = ~/sat_media
70 66
71 Of course, replace ``~/sat_media`` with the actual path you have used. 67 Of course, replace ``~/sat_media`` with the actual path you have used.
72 68
73 .. following part is currently hidden until v0.7 is released 69 You can check :ref:`configuration` for details
74
75 Last release
76 ------------
77
78 This release is really old and code has changed a lot since it.
79 Furthermore, stable version is currently not maintained. We recommend to use current dev version until version 0.7 is released.
80
81 If you are willing to install last release anyway, here are the instructions.
82
83 You can automatically install SàT and its dependencies using
84 easy_install or pip. You will however need to install Python's headers
85 (needed to build some packages),
86 `PyGObject <http://ftp.gnome.org/pub/GNOME/sources/pygobject/>`__ and
87 developments version of libxml2 and libxslt (to compile lxml python
88 library). On some ARM systems like Raspberry Pi or OLinuXino, it is also
89 required to install libjpeg-dev and libffi-dev beforehand.
90
91 The environment variable SAT_INSTALL customises the installation, it
92 contains flags separated by spaces:
93
94 - "nopreinstall" skip all preinstallation checks
95 - "autodeb" automatically install missing packages on Debian based
96 distributions
97
98 PyGobject is automatically installed on Debian based distributions if
99 "autodeb" option is set. Indeed, on Debian based distribution, you can
100 type:
101
102 | ``sudo apt-get install python-pip python-virtualenv python-dev libxml2-dev libxslt-dev libjpeg-dev libffi-dev zlib1g-dev``
103 | ``virtualenv --system-site-packages sat``
104 | ``source sat/bin/activate``
105 | ``pip2 install -U setuptools``
106 | ``SAT_INSTALL="autodeb" pip2 install sat``
107
108 After installing SàT, you need to install the media:
109
110 | ``mkdir -p /path/to/sat_media``
111 | ``cd /path/to/sat_media``
112 | ``wget ``\ ```ftp://ftp.goffi.org/sat_media/sat_media.tar.bz2`` <ftp://ftp.goffi.org/sat_media/sat_media.tar.bz2>`__
113 | ``tar -jxvf sat_media.tar.bz2``
114
115 then, create a ~/.sat.conf file which contains:
116
117 | ``[DEFAULT]``
118 | ``media_dir=/path/to/sat_media``
119
120 Of course, replace /path/to/sat_media with the actual path you want to
121 use.
122 70
123 Usage 71 Usage
124 ===== 72 =====
125 73
126 To launch the sat backend, enter:: 74 To launch the sat backend, enter::
142 **NOTE**: since SàT v0.5.0, the backend is automatically launched when a frontend needs it. 90 **NOTE**: since SàT v0.5.0, the backend is automatically launched when a frontend needs it.
143 91
144 You can check that SàT is installed correctly by trying jp (the backend need to be launched first, check below):: 92 You can check that SàT is installed correctly by trying jp (the backend need to be launched first, check below)::
145 93
146 $ jp --version 94 $ jp --version
147 jp 0.7.0D « La Commune » (rev 2dd53ffa4781 (default 2019-02-22 18:58 +0100) +110) Copyright (C) 2009-2019 Jérôme Poisson, Adrien Cossa 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
148 This program comes with ABSOLUTELY NO WARRANTY; 96 This program comes with ABSOLUTELY NO WARRANTY;
149 This is free software, and you are welcome to redistribute it under certain conditions. 97 This is free software, and you are welcome to redistribute it under certain conditions.
150 98
151 If you have a similar output, SàT is working. 99 If you have a similar output, SàT is working.
152 100