annotate INSTALL @ 379:d2324f093942

added INSTALL
author souliane <souliane@mailoo.org>
date Wed, 26 Feb 2014 01:50:49 +0100
parents
children cb66dffdf9b2
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
379
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
1 Libervia's installation is currently a bit tricky. Full installation and
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
2 configuration instructions are given on the Salut à Toi wiki:
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
3
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
4 http://wiki.goffi.org/w/index.php?title=Libervia/en
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
5
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
6
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
7 == Prerequesites ==
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
8
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
9 These steps are detailed on the Salut à Toi wiki:
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
10
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
11 * install and configure Salut à Toi
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
12 * install and configure a local XMPP server (we recommend using Prosody)
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
13 * install sat_pubsub
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
14
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
15 == Dependencies ==
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
16
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
17 * you need to install the txJSON-RPC dependency. The installation script of the current
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
18 stable release is buggy, and it's fixed on the Bazaar repository, so you need to install
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
19 Bazaar or git and clone the repository:
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
20
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
21 bzr branch lp:txjsonrpc
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
22
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
23 or
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
24
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
25 git clone git://github.com/oubiwann/txjsonrpc
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
26
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
27 Then you can install it:
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
28
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
29 cd txjsonrpc
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
30 python setup.py install '''(as root, "sudo python setup.py install" for *buntu)'''
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
31
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
32 * install python2-gobject2 from your distribution repositories
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
33 * install the git version of pyjamas (http://pyj.be):
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
34
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
35 git clone git://pyjs.org/git/pyjamas.git
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
36 cd pyjamas
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
37 python boostrap.py
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
38
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
39 You can need to force a python version if libervia's compilation doesn't work, for example:
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
40
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
41 python2.7 boostrap.py
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
42
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
43 Salut à Toi and Libervia are being developped with Python 2.7.3.
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
44 You can check that it works by compiling the helloworld example:
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
45
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
46 cd examples/helloworld
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
47 ./build.sh
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
48
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
49 If you have no error message, it should be allright.
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
50
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
51 == Install Libervia ==
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
52
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
53 * to install Libervia using setuptools, the pyjsbuild executable should be accessible
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
54 from your environment variable "PATH". The easiest would be:
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
55
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
56 cd pyjamas
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
57 sudo ln -sf bin/pyjsbuild /usr/bin/pyjsbuild
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
58
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
59 * clone libervia repository:
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
60
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
61 hg clone http://repos.goffi.org/libervia
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
62
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
63 * install Libervia:
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
64
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
65 cd libervia
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
66 python setup.py install
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
67
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
68 * create an account "libervia@yourserver.tld" (replace "yourserver.tld" by "example.net"
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
69 or something else) on your XMPP server, create a profile on SàT named "libervia", and
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
70 plug the SàT profile to this account.
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
71
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
72 == Usage ==
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
73
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
74 The four components must be launched in the following order:
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
75
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
76 * prosody
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
77 * sat_pubsub (with the xmpp domain and password as declared in prosodi.cfg.lua)
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
78 * sat
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
79 * libervia's web server
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
80
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
81 Your command input would look like that:
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
82
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
83 cd prosody && prosodyctl start
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
84 twistd sat_pubsub --jid=sat-pubsub.<xmpp_domain> --secret=<password>
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
85 sat
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
86 libervia
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
87
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
88 You can now drop your web browser on http://localhost:8080/libervia.html
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
89
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
90 If you encounter any issue, you can ask for help on MUC room sat@chat.jabberfr.org
d2324f093942 added INSTALL
souliane <souliane@mailoo.org>
parents:
diff changeset
91 or use the dev mailing list: http://lists.goffi.org