# HG changeset patch # User souliane # Date 1395677889 -3600 # Node ID ac0018e4391b73298e6df4da44af0b0a6d009eac # Parent 454c7685471dfb48177cb005e02f9644db1c967f misc: INSTALL: convert line delimiters to UNIX diff -r 454c7685471d -r ac0018e4391b INSTALL --- a/INSTALL Sun Mar 23 23:06:42 2014 +0100 +++ b/INSTALL Mon Mar 24 17:18:09 2014 +0100 @@ -1,105 +1,105 @@ -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.6 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. - -== Configuration == - -You can configure the Libervia service from the SàT configuration file, for example: - - [libervia] - connection_type=both - port=8080 - port_https=8443 - ssl_certificate=libervia.pem - redirect_to_https=1 - unsecure_warning=1 - -Check the wiki for more information: http://wiki.goffi.org/wiki/Configuration/en - -== 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. --secret= - 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 +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.6 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. + +== Configuration == + +You can configure the Libervia service from the SàT configuration file, for example: + + [libervia] + connection_type=both + port=8080 + port_https=8443 + ssl_certificate=libervia.pem + redirect_to_https=1 + unsecure_warning=1 + +Check the wiki for more information: http://wiki.goffi.org/wiki/Configuration/en + +== 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. --secret= + 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