Mercurial > libervia-web
diff INSTALL @ 379:d2324f093942
added INSTALL
author | souliane <souliane@mailoo.org> |
---|---|
date | Wed, 26 Feb 2014 01:50:49 +0100 |
parents | |
children | cb66dffdf9b2 |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/INSTALL Wed Feb 26 01:50:49 2014 +0100 @@ -0,0 +1,91 @@ +Libervia's installation is currently a bit tricky. Full installation and +configuration instructions are given on the Salut à Toi wiki: + +http://wiki.goffi.org/w/index.php?title=Libervia/en + + +== Prerequesites == + +These steps are detailed on the Salut à Toi wiki: + +* install and configure Salut à Toi +* install and configure a local XMPP server (we recommend using Prosody) +* install sat_pubsub + +== Dependencies == + +* you need to install the txJSON-RPC dependency. The installation script of the current +stable release is buggy, and it's fixed on the Bazaar repository, so you need to install +Bazaar or git and clone the repository: + + bzr branch lp:txjsonrpc + +or + + git clone git://github.com/oubiwann/txjsonrpc + +Then you can install it: + + cd txjsonrpc + python setup.py install '''(as root, "sudo python setup.py install" for *buntu)''' + +* install python2-gobject2 from your distribution repositories +* install the git version of pyjamas (http://pyj.be): + + git clone git://pyjs.org/git/pyjamas.git + cd pyjamas + python boostrap.py + +You can need to force a python version if libervia's compilation doesn't work, for example: + + python2.7 boostrap.py + +Salut à Toi and Libervia are being developped with Python 2.7.3. +You can check that it works by compiling the helloworld example: + + cd examples/helloworld + ./build.sh + +If you have no error message, it should be allright. + +== Install Libervia == + +* to install Libervia using setuptools, the pyjsbuild executable should be accessible +from your environment variable "PATH". The easiest would be: + + cd pyjamas + sudo ln -sf bin/pyjsbuild /usr/bin/pyjsbuild + +* clone libervia repository: + + hg clone http://repos.goffi.org/libervia + +* install Libervia: + + cd libervia + python setup.py install + +* create an account "libervia@yourserver.tld" (replace "yourserver.tld" by "example.net" +or something else) on your XMPP server, create a profile on SàT named "libervia", and +plug the SàT profile to this account. + +== Usage == + +The four components must be launched in the following order: + +* prosody +* sat_pubsub (with the xmpp domain and password as declared in prosodi.cfg.lua) +* sat +* libervia's web server + +Your command input would look like that: + + cd prosody && prosodyctl start + twistd sat_pubsub --jid=sat-pubsub.<xmpp_domain> --secret=<password> + sat + libervia + +You can now drop your web browser on http://localhost:8080/libervia.html + +If you encounter any issue, you can ask for help on MUC room sat@chat.jabberfr.org +or use the dev mailing list: http://lists.goffi.org