Mercurial > libervia-pubsub
annotate INSTALL @ 167:ef22e4150caa
Move protocol implementations (pubsub, disco, forms) to and depend on wokkel.
Author: ralphm
Fixes: #4
| author | Ralph Meijer <ralphm@ik.nu> |
|---|---|
| date | Wed, 03 Oct 2007 12:41:43 +0000 |
| parents | 6fe78048baf9 |
| children | e2c2c2baf483 |
| rev | line source |
|---|---|
| 155 | 1 Requirements |
| 2 ============ | |
| 3 | |
| 4 - Twisted Core >= 2.0.0 | |
|
159
6fe78048baf9
Rework error handling, depend on Twisted Words 0.4.0.
Ralph Meijer <ralphm@ik.nu>
parents:
155
diff
changeset
|
5 - Twisted Words >= 0.4.0 |
| 155 | 6 - uuid.py (http://ofxsuite.berlios.de/uuid.py) |
| 7 - A jabber server that supports the component protocol (JEP-0114) | |
|
167
ef22e4150caa
Move protocol implementations (pubsub, disco, forms) to and depend on wokkel.
Ralph Meijer <ralphm@ik.nu>
parents:
159
diff
changeset
|
8 - Wokkel (http://wokkel.ik.nu/) |
| 155 | 9 |
| 10 For the PostgreSQL backend, the following is also required: | |
| 11 | |
| 12 - PostgreSQL | |
| 13 - pyPgSQL | |
| 14 | |
| 15 Installation | |
| 16 ============ | |
| 17 | |
| 18 Run: | |
| 19 | |
| 20 python setup.py install | |
| 21 | |
| 22 Configuration | |
| 23 ============= | |
| 24 | |
| 25 The configuration file is created using Twisted's mktap, which needs a number | |
| 26 of parameters: | |
| 27 | |
| 28 --jid: The Jabber ID the component will assume. | |
| 29 --rport: the port number of the Jabber server to connect to | |
| 30 --secret: the secret used to authenticate with the Jabber server. | |
| 31 --backend: the backend storage facility to be used (memory or PostgreSQL). | |
| 32 | |
| 33 The default settings of mktap for Idavoll use the memory database and assume | |
| 34 the default settings of jabberd 2.x for --rport and --secret. | |
| 35 | |
| 36 jabberd 2.x | |
| 37 =========== | |
| 38 You can use the 'legacy' component support that defaults to port 5347 with | |
| 39 secret 'secret'. You do not need to add anything specific for this service. | |
| 40 | |
| 41 jabberd 1.4.x | |
| 42 ============= | |
| 43 | |
| 44 Put the following in the jabber.xml configuration file of jabberd: | |
| 45 | |
| 46 <service id='pubsub.localhost'> | |
| 47 <accept> | |
| 48 <ip>127.0.0.1</ip> | |
| 49 <port>5347</port> | |
| 50 <secret>secret</secret> | |
| 51 </accept> | |
| 52 </service> | |
| 53 | |
| 54 and restart jabberd. Unlike jabber 2.x, you can only have one component per | |
| 55 port, so the port number may need to be changed. | |
| 56 | |
| 57 For other server implementations, please refer to its documentation on | |
| 58 how to interact with server side components using the protocol defined in | |
| 59 JEP-0114. | |
| 60 | |
| 61 Then, in the same directory as this file run: | |
| 62 | |
| 63 mktap idavoll --rport=5347 --jid=pubsub.localhost --secret=secret | |
| 64 | |
| 65 This uses the (default) memory based backend. | |
| 66 | |
| 67 For using the PostgreSQL backend, create a database (for example named pubsub) | |
| 68 like so: | |
| 69 | |
| 70 createdb pubsub | |
| 71 psql pubsub <db/pubsub.sql | |
| 72 | |
| 73 To use this backend, add the --backend=pgsql parameter to mktap. | |
| 74 | |
| 75 For viewing all options, run: | |
| 76 | |
| 77 mktap idavoll --help | |
| 78 | |
| 79 The generated file idavoll.tap now holds the configuration. | |
| 80 | |
| 81 Running | |
| 82 ======= | |
| 83 | |
| 84 Using the configuration file idavoll.tap, run: | |
| 85 | |
| 86 twistd -of idavoll.tap | |
| 87 | |
| 88 This will start the service and run it in the background. It generates a | |
| 89 file twistd.pid that holds the PID of the service and a log file twistd.log. | |
| 90 The twistd utility has a fair number of options that might be useful, and | |
| 91 can be viewed with: | |
| 92 | |
| 93 twistd --help |