view INSTALL @ 676:849ffb24d5bf frontends_multi_profiles

browser side: menus refactorisation: - use of the new quick_frontends.quick_menus module, resulting in a big code simplification in Libervia - menu are added in there respective modules: main menus are done directely in libervia_main, while tarot and radiocol menus are done in game_tarot and game_radiocol - launchAction has the same signature as in QuickApp - base_menu: there are now 2 classes to launch an action: MenuCmd which manage quick_menus classes, and SimpleCmd to launch a generic callback - base_menu: MenuNode has been removed as logic is now in quick_menus - base_menu: GenericMenuBar.update method can be called to fully (re)build the menus - base_widget: removed WidgetSubMenuBar which is no more useful (GenericMenuBar do the same thing) - plugin_menu_context is used in LiberviaWidget and other classes with menus to indicate which menu types must be used - otr menus hooks are temporarily removed, will be fixed soon
author Goffi <goffi@goffi.org>
date Tue, 17 Mar 2015 20:42:02 +0100
parents 0924710b666a
children 47c21905e002
line wrap: on
line source

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
 security_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.<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