3022
+ − 1 .. _installation:
+ − 2
2946
+ − 3 ============
+ − 4 Installation
+ − 5 ============
+ − 6
+ − 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.
+ − 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.
+ − 11
+ − 12 We recommand to use development version for now, until the release of
+ − 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
+ − 17 Development version
+ − 18 -------------------
+ − 19
+ − 20 *Note for Arch users: a pkgbuild is available for your distribution on
+ − 21 AUR, check sat-xmpp-hg (as well as other sat-\* packages).*
+ − 22
+ − 23 You can install the latest development version using pip. You need to
+ − 24 have the following dependencies installed first:
+ − 25
+ − 26 - Python 2 with development headers
+ − 27 - Mercurial
+ − 28 - VirtualEnv
+ − 29 - libcairo 2 with development headers
+ − 30 - libjpeg with development headers
+ − 31 - libgirepository 1.0 with development headers
+ − 32 - libdbus-1 with development headers
+ − 33 - libdbus-glib-1 with development headers
+ − 34 - libxml2 with development headers
+ − 35 - libxlt2 with development headers
+ − 36 - D-Bus x11 tools (this doesn't needs X11, it is just needed for dbus-launch)
+ − 37 - cmake
+ − 38
+ − 39 On Debian and derivatives, you can get all this with following command::
+ − 40
+ − 41 $ sudo apt-get install python-dev mercurial virtualenv libxml2-dev libxslt-dev libcairo2-dev libjpeg-dev libgirepository1.0-dev libdbus-1-dev libdbus-glib-1-dev dbus-x11 cmake
+ − 42
+ − 43 Now go in a location where you can install Salut à Toi, for
+ − 44 instance your home directory::
+ − 45
+ − 46 $ cd
+ − 47
+ − 48 And enter the following commands (note that *virtualenv2* may be named
+ − 49 *virtualenv* on some distributions, just be sure it's Python **2** version)::
+ − 50
+ − 51 $ virtualenv2 env
+ − 52 $ source env/bin/activate
+ − 53 $ pip install hg+https://repos.goffi.org/sat
+ − 54
+ − 55 Don't worry if you see the following message, SàT should work anyway::
+ − 56
+ − 57 Failed building wheel for pygobject
+ − 58
+ − 59 After installing SàT, you need to install the media::
+ − 60
+ − 61 $ cd
+ − 62 $ hg clone https://repos.goffi.org/sat_media
+ − 63
+ − 64 then, create the file ~/.config/sat/sat.conf containing:
+ − 65
+ − 66 .. sourcecode :: cfg
+ − 67
+ − 68 [DEFAULT]
+ − 69 media_dir = ~/sat_media
+ − 70
+ − 71 Of course, replace ``~/sat_media`` with the actual path you have used.
+ − 72
+ − 73 .. following part is currently hidden until v0.7 is released
+ − 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
+ − 123 Usage
+ − 124 =====
+ − 125
+ − 126 To launch the sat backend, enter::
+ − 127
+ − 128 $ sat
+ − 129
+ − 130 …or, if you want to launch it in foreground::
+ − 131
+ − 132 $ sat fg
+ − 133
+ − 134 You can stop it with::
+ − 135
+ − 136 $ sat stop
+ − 137
+ − 138 To know if backend is launched or not::
+ − 139
+ − 140 $ sat status
+ − 141
+ − 142 **NOTE** : since SàT v0.5.0, the backend is automatically launched when a frontend needs it.
+ − 143
+ − 144 You can check that SàT is installed correctly by trying jp (the backend need to be launched first, check below)::
+ − 145
+ − 146 $ 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
+ − 148 This program comes with ABSOLUTELY NO WARRANTY;
+ − 149 This is free software, and you are welcome to redistribute it under certain conditions.
+ − 150
+ − 151 If you have a similar output, SàT is working.
+ − 152
+ − 153 Frontends
+ − 154 =========
+ − 155
+ − 156 So far, the following frontends exist and are actively maintained:
+ − 157
+ − 158 Cagou
+ − 159 desktop/mobile (Android) frontend
+ − 160
+ − 161 Libervia
+ − 162 the web frontend
+ − 163
+ − 164 Primitivus
+ − 165 Text User Interface
+ − 166
+ − 167 jp
+ − 168 Command Line Interface
+ − 169
+ − 170 To launch Primitivus, just type::
+ − 171
+ − 172 $ primitivus
+ − 173
+ − 174 then create a profile (XMPP account must already exist).
+ − 175
+ − 176 To use jp, follow its help::
+ − 177
+ − 178 $ jp --help
+ − 179
+ − 180
+ − 181 There are some other frontends:
+ − 182
+ − 183 Bellaciao
+ − 184 based on Qt, a rich desktop frontend (currently on hold)
+ − 185
+ − 186 Wix
+ − 187 former desktop frontend based on WxWidgets (deprecated with version 0.6.0)
+ − 188
+ − 189 Sententia
+ − 190 Emacs frontend developed by a third party (development is currently stalled)
