diff INSTALL @ 777:c3358ea316e5

update INSTALL file
author souliane <souliane@mailoo.org>
date Mon, 30 Nov 2015 11:44:29 +0100
parents 8aa2a199d6e3
children 1028a9c366d3
line wrap: on
line diff
--- a/INSTALL	Sun Nov 29 22:58:38 2015 +0100
+++ b/INSTALL	Mon Nov 30 11:44:29 2015 +0100
@@ -1,9 +1,10 @@
-Libervia's installation is currently a bit tricky. Full installation and
-configuration instructions are given on the Salut à Toi wiki:
+Libervia's installation is currently a bit tricky. Please note that this file instructs
+a minimal configuration of Libervia. For a complete procedure including the installation
+and configuration of your XMPP server and enabling the blog and directory features,
+please consult this page 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:
@@ -14,22 +15,10 @@
 
 == 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
+* you need to install the txJSON-RPC dependency (as root):
+  pip install txJSON-RPC
+* install python2-gobject2 from your distribution repositories. For example:
+  apt-get install python-gobject2
 * install pyjamas. We use the version which used to be on http://pyj.be, not the fork
   from http://pyjs.org. Since http://pyj.be has been down for a while, you can retrieve
   the package from our FTP.
@@ -37,13 +26,10 @@
   wget ftp://ftp.goffi.org/pyjamas/pyjamas.tar.bz2
   tar xvjf pyjamas.tar.bz2
   cd pyjamas
-  python bootstrap.py
+  python2.7 bootstrap.py
   
-You may need to force the python version if libervia's compilation doesn't work:
-
-  python2.7 boostrap.py
-
-Salut à Toi and Libervia are being developped with Python 2.7.3.
+Note that we force the python version to 2.7. Salut à Toi and Libervia will be ported
+to Python 3 after the Twisted framework which is our main dependency.
 You can check that it works by compiling the helloworld example:
 
   cd examples/helloworld
@@ -68,21 +54,25 @@
   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.
+* create an account "libervia@example.net" (replace "example.net" with your
+domain or virtual host) on your XMPP server, create a profile on SàT named
+"libervia", and plug the SàT profile to this account with jp or primitivus.
+  jp profile create libervia -j libervia@yourserver.tld -p <libervia_password>
 
 == 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
+  [libervia]
+  port = 8080
+  port_https = 8443
+  port_https_ext = 8443
+  connection_type = both
+  ssl_certificate = libervia.pem
+  redirect_to_https = 0
+  security_warning = 1
+  passphrase = <libervia_password>
+  data_dir = ~/workspace/libervia
 
 Check the wiki for more information: http://wiki.goffi.org/wiki/Configuration/en