annotate INSTALL @ 2448:637ac234424f

plugin merge requests: first draft: this plugin allows to handle merge requests (i.e. requests to include a contribution in a project) by extendings tickets management. This plugin is made to be generic, independent from end user tools and from the kind of project where the contribution is requested to be merged.
author Goffi <goffi@goffi.org>
date Thu, 30 Nov 2017 20:44:25 +0100
parents 1128feb54180
children e7bd2945518f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
885
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
1 You can install SàT automatically using easy_install or pip, and it is available in several GNU/Linux distributions. The full instructions are available on the wiki: http://wiki.goffi.org/wiki/Salut_%C3%A0_Toi
1202
101c06fbda31 misc: fixed typos in README
Matteo Cypriani <mcy@lm7.fr>
parents: 1191
diff changeset
2 Below is are installation instructions, but please check the wiki which may be more up-to-date.
885
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
3
587
952322b1d490 Remove trailing whitespaces.
Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
parents: 548
diff changeset
4 ***
885
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
5
1202
101c06fbda31 misc: fixed typos in README
Matteo Cypriani <mcy@lm7.fr>
parents: 1191
diff changeset
6 You can automatically install SàT and its dependencies using easy_install or pip. You will however need to install Python's headers (needed to build some packages), WxPython which is available in most Gnu/Linux distributions, PyGObject and developments version of libxml2 and libxslt (to compile lxml python library).
885
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
7
1191
4c6bc3454780 misc: INSTALL note for pyfeed/xe
Goffi <goffi@goffi.org>
parents: 1100
diff changeset
8
1202
101c06fbda31 misc: fixed typos in README
Matteo Cypriani <mcy@lm7.fr>
parents: 1191
diff changeset
9 The environment variable SAT_INSTALL customises the installation, it contains flags separated by spaces:
101c06fbda31 misc: fixed typos in README
Matteo Cypriani <mcy@lm7.fr>
parents: 1191
diff changeset
10 - "nopreinstall" skips all preinstallation checks
101c06fbda31 misc: fixed typos in README
Matteo Cypriani <mcy@lm7.fr>
parents: 1191
diff changeset
11 - "autodeb" automatically installs missing packages on Debian-based distributions
101c06fbda31 misc: fixed typos in README
Matteo Cypriani <mcy@lm7.fr>
parents: 1191
diff changeset
12 - "nox" disables installation of X-based packages (WxWidgets), this is useful for servers
885
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
13
1935
1128feb54180 core: removed pyfeed and xe dependencies:
Goffi <goffi@goffi.org>
parents: 1410
diff changeset
14 PyGobject is automatically installed on Debian-based distributions if "autodeb" option is set. Indeed, on Debian-based distribution, you can type (with the root account):
885
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
15
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
16 # apt-get install python-pip python-dev libxml2-dev libxslt-dev
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
17 # SAT_INSTALL=autodeb pip install .
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
18
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
19 On a *buntu, same commands with sudo:
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
20
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
21 $ sudo apt-get install python-pip python-dev libxml2-dev libxslt-dev
1100
2be46f391cfa setup: SAT_INSTALL environment variable handles "clean" and "purge" options
souliane <souliane@mailoo.org>
parents: 885
diff changeset
22 $ sudo SAT_INSTALL=autodeb pip install .
885
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
23
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
24
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
25 After installing SàT, you need to install the media:
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
26
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
27 $ mkdir -p ~/sat/media/destination/path
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
28 $ cd ~/sat/media/destination/path
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
29 wget ftp://ftp.goffi.org/sat_media/sat_media.tar.bz2
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
30 tar -jxvf sat_media.tar.bz2
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
31
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
32 then, create a ~/.sat.conf file which contains:
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
33
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
34 ### sat.conf ###
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
35 [DEFAULT]
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
36 media_dir=~/sat/media/destination/path
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
37 ### end sat.conf ###
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
38
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
39 Of course, replace ~/sat/media/destination/path with the actual path you want to use.
1410
e2e75c3c7c7b quick_frontend, primitivus: fixes a couple of issues:
souliane <souliane@mailoo.org>
parents: 1291
diff changeset
40 Check the wiki for more information about this configuration file: http://wiki.goffi.org/wiki/Configuration/en
885
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
41
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
42 You should now be able to launch sat:
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
43 - to launch the backend, enter
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
44 $ sat
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
45 - to stop the backend, enter:
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
46 $ sat stop
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
47 - to launch Primitivus, enter:
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
48 $ primitivus
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
49 then create a profile.
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
50 - to use jp, follow its help:
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
51 $ jp --help
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
52
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
53 For Libervia, the web interface, check http://wiki.goffi.org/wiki/Libervia/en
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
54
c8a7019cd168 better INSTALL instructions
Goffi <goffi@goffi.org>
parents: 871
diff changeset
55 If you need help, come the SàT official XMPP room: sat@chat.jabberfr.org