diff INSTALL @ 264:86e767dc6abb

packaging for release
author souliane <souliane@mailoo.org>
date Sat, 22 Feb 2014 06:10:24 +0100
parents edabaa535476
children b757c29b20d7
line wrap: on
line diff
--- a/INSTALL	Fri Feb 21 16:10:11 2014 +0100
+++ b/INSTALL	Sat Feb 22 06:10:24 2014 +0100
@@ -3,34 +3,24 @@
 
 - Twisted >= 8.0.1:
    - Twisted Core
-   - Twisted Conch (for idavoll-http)
-   - Twisted Web (for idavoll-http)
-   - Twisted Web2 (for idavoll-http)
    - Twisted Words
 - uuid.py (Python 2.5 std. lib. or http://pypi.python.org/pypi/uuid)
 - Wokkel >= 0.5.0 (http://wokkel.ik.nu/)
-- simplejson (for idavoll-http)
-- A Jabber server that supports the component protocol (XEP-0114)
+- A Jabber server that supports the component protocol (XEP-0114),
+  and, to enable the micro-blogging feature, the remote roster
+  management protocol (XEP-0321). We recommend using Prosody.
 
 For the PostgreSQL backend, the following is also required:
 
 - PostgreSQL
-- pyPgSQL
+- Psycopg 2
 
 
 Installation
 ============
 
-Idavoll uses setuptools for package building and installing, and is also
-available through the Python Package Index (pypi). The easiest way to
-install idavoll is:
-
-  easy_install idavoll
-
-This will pull down the dependencies, if needed, except for the Twisted
-packages.
-
-To building from source run:
+sat_pubsub uses setuptools for package building and installing.
+To build from the source run:
 
   python setup.py build
 
@@ -45,42 +35,32 @@
 Configuration
 =============
 
-Idavoll uses Twisted's twistd command for running its services. Starting with
+sat_pubsub uses Twisted's twistd command for running its services. Starting with
 Twisted 2.5.0, twistd supports running Twisted Application Plugins directly,
 without the use of mktap. In Twisted 8.1.0, the use of mktap for configuration
-is deprecated. These instructions will not cover the use of mktap anymore, but
-you can use TAC files to store a configuration, as described near the end
-of this document.
+is deprecated.
 
-Idavoll provides two types of storage for the backend: a memory-based storage
-facility, which is volatile, and a persistent storage facility using
-PostgreSQL. By default, the memory backend is used.
+Idavoll, on which sat_pubsub is based, provides two types of storage for the backend:
+a memory-based storage facility, which is volatile, and a persistent storage facility
+using PostgreSQL. For now, sat_pubsub only uses the persistent storage facility.
 
-For using the PostgreSQL backend, create a database (for example named pubsub)
-like so:
-
-  createdb pubsub
-  psql pubsub <db/pubsub.sql
+For using the PostgreSQL backend, create a database (for example named pubsub):
 
-To use this backend, add the --backend=pgsql parameter to twistd, along
-with the optional connection parameters (see twistd idavoll --help).
-
-Your Jabber server must also be configured to accept component connections,
-see below for details.
+  sudo -u postgres createuser -d -P `whoami`
+  createdb pubsub
+  psql pubsub < sat_pubsub/db/pubsub.sql
 
 
-Running Idavoll
-===============
+Your Jabber server must also be configured to accept component connections and,
+to enable the micro-blogging feature, remote roster management. See below for details.
+
 
-Idavoll provides two twistd plugins: idavoll and idavoll-http. The former
-provides a generic publish-subscribe service, and the latter adds to that an
-HTTP interface to access some of the features of the Idavoll backend, and also
-provides a way to subscribe to, and receive notifications from, remote
-publish-subscribe nodes.
+Running sat_pubsub
+==================
 
-The minimal example for running idavoll is:
+The minimal example for running sat_pubsub is:
 
-  twistd idavoll
+  twistd sat_pubsub
 
 This will start the service and run it in the background. It generates a
 file twistd.pid that holds the PID of the service and a log file twistd.log.
@@ -95,63 +75,57 @@
 the twistd plugin. You can get an overview of the parameters and their defaults
 using:
 
-  twistd idavoll --help
+  twistd sat_pubsub --help
 
 In particular, the following parameters will be of interest:
 
  --jid: The Jabber ID the component will assume.
  --rport: the port number of the Jabber server to connect to
  --secret: the secret used to authenticate with the Jabber server.
- --backend: the backend storage facility to be used (memory or PostgreSQL).
 
-The defaults for Idavoll use the memory database and assume the default
-settings of jabberd 2.x for --rport and --secret.
+For example:
+
+  twistd sat_pubsub --jid=sat-pubsub.<xmpp_domain> --secret=<password>
 
 You may also want to provide the --verbose flag to see the traffic flow,
 for example to debug the configuration. Below some specifics for the
-different Jabber server implementations.
-
-
-jabberd 2.x
-===========
-
-You can use the 'legacy' component support that defaults to port 5347 with
-secret 'secret'. These are the defaults of Idavoll, so you don't need to
-alter the connection details with a default jabberd 2.x install.
+Prosody XMPP server implementation.
 
 
-jabberd 1.4.x
-=============
+Running sat_pubsub with Prosody 
+===============================
 
-Put the following in the jabber.xml configuration file of jabberd:
+To enable the micro-blogging feature with Prosody XMPP server, you need
+the remote_roster plugin. Check if the remote_roster plugin is already
+in your Prosody installation:
 
-  <service id='pubsub.localhost'>
-    <accept>
-      <ip>127.0.0.1</ip>
-      <port>5347</port>
-      <secret>secret</secret>
-    </accept>
-  </service>
+  cd prosody/plugins
+  ls mod_remote_roster.lua
+
+If you can't see it, download it from here:
 
-and restart jabberd. Unlike jabber 2.x, you can only have one component per
-port, so the port number may need to be changed.
+  wget http://prosody-modules.googlecode.com/hg/mod_remote_roster/mod_remote_roster.lua
+
+You need to patch the file (commenting two lines to make all contacts available):
+
+  wget http://paste.debian.net/download/12106
+  patch -p2 < paste_1206
 
-For other server implementations, please refer to its documentation on
-how to interact with server side components using the protocol defined in
-JEP-0114.
+Edit the prosodi.cfg.lua file to add this module:
 
-Then, you can start Idavoll with:
-
-  twistd idavoll --rport=5347 --jid=pubsub.localhost --secret=secret
-
-This uses the (default) memory based backend.
+  modules_enabled = {
+                [...]
+                "remote_roster";
+                [...]
+  }
 
-
-Using TAC files to store a configuration
-========================================
+Also add these two lines at the end of the file, adapting them to your XMPP server
+domain (virtual host) and selecting a password of your choice:
 
-Apart from the provided TAPs that can be run with twistd, you can also create
-a configuration file that can be used by twistd to start up Idavoll. You can
-find an example in doc/examples/idavoll.tac, which can be run using:
+  Component "sat-pubsub.<xmpp_domain>"
+          component_secret = "<password>"
 
-  twisted -y idavoll.tac 
+For a more complete installation and configuration of Prosody to be used with
+sat_pubsub, please report yourself to the Salut à Toi wiki:
+
+http://wiki.goffi.org/wiki/Libervia/en#XMPP_server
\ No newline at end of file