Mercurial > libervia-pubsub
annotate README @ 154:bd8e58c73370
Update README and fix typo.
- Adds informations about how to use Idavoll with jabberd 2.x
- Updates dependency information
- Updates implemented specification version
| author | Ralph Meijer <ralphm@ik.nu> |
|---|---|
| date | Thu, 29 Jun 2006 08:38:24 +0000 |
| parents | f809b998c6f4 |
| children | 5191ba7c4df8 |
| rev | line source |
|---|---|
| 88 | 1 Idavoll using Twisted Python. |
| 10 | 2 |
| 88 | 3 What is Idavoll? |
| 4 ================ | |
| 10 | 5 |
| 6 A pubsub service, as defined in JEP-0060, aiming to be fully compliant and | |
| 7 mostly complete. The goal is to build a /generic/ pubsub service, but of which | |
| 8 parts can be reused for building custom pubsub services for specific | |
| 9 applications. | |
| 10 | |
| 11 | |
| 12 Current Status | |
| 13 ============== | |
| 14 | |
| 88 | 15 There are two different backends: one using PostgreSQL for storage, and one |
| 16 just keeping everything in memory. | |
| 10 | 17 |
| 154 | 18 In Idavoll the mimimal requirements of JEP-0060 version 1.8 are implemented |
| 133 | 19 plus most optional features, as returned by Service Discovery. |
| 10 | 20 |
| 21 Requirements | |
| 22 ============ | |
| 23 | |
|
151
f809b998c6f4
Add comments about uuid.py and the required Twisted modules.
Ralph Meijer <ralphm@ik.nu>
parents:
133
diff
changeset
|
24 - Twisted Core >= 2.0.0 |
| 154 | 25 - Twisted Words >= 0.3.0 |
|
151
f809b998c6f4
Add comments about uuid.py and the required Twisted modules.
Ralph Meijer <ralphm@ik.nu>
parents:
133
diff
changeset
|
26 - uuid.py (http://ofxsuite.berlios.de/uuid.py) |
|
f809b998c6f4
Add comments about uuid.py and the required Twisted modules.
Ralph Meijer <ralphm@ik.nu>
parents:
133
diff
changeset
|
27 - A jabber server that supports the component protocol (JEP-0114) |
| 88 | 28 |
| 29 For the PostgreSQL backend, the following is also required: | |
| 30 | |
| 31 - PostgreSQL | |
| 32 - pyPgSQL | |
| 10 | 33 |
| 34 Usage | |
| 35 ===== | |
| 36 | |
| 37 For jabberd 1.4 configuration, put the following in jabber.xml: | |
| 38 | |
| 39 <service id='pubsub.localhost'> | |
| 40 <accept> | |
| 41 <ip>127.0.0.1</ip> | |
| 42 <port>1238</port> | |
| 43 <secret>mysecret</secret> | |
| 44 </accept> | |
| 45 </service> | |
| 46 | |
| 47 and restart jabberd. | |
| 48 | |
| 154 | 49 For jabberd 2.x, you can use the 'legacy' component support that defaults |
| 50 to port 5347. You do not need to add anything specific for this service. | |
| 51 | |
| 52 For other server implementations, please refer to its documentation on | |
| 53 how to interact with server side components using the protocol defined in | |
| 54 JEP-0114. | |
| 55 | |
| 10 | 56 Then, in the same directory as this file run: |
| 57 | |
| 58 mktap idavoll --rport=1238 --jid=pubsub.localhost --secret=1238 | |
| 59 twistd -rf idavoll.tap | |
| 60 | |
| 132 | 61 This uses the (default) memory based backend. You can ignore the deprecation |
| 62 warnings. | |
| 88 | 63 |
| 64 For using the PostgreSQL backend, create a database (for example named pubsub) | |
| 65 like so: | |
| 66 | |
| 67 createdb pubsub | |
| 68 psql pubsub <db/pubsub.db | |
| 69 | |
| 70 Then do: | |
| 71 | |
| 72 mktap idavoll --rport=1238 --jid=pubsub.localhost --secret=1238 \ | |
| 73 --backend=pgsql | |
| 74 twistd -rf idavoll.tap | |
| 75 | |
| 76 For viewing all options, run: | |
| 77 | |
| 78 mktap idavoll --help | |
| 79 | |
| 80 Contact | |
| 81 ======= | |
| 82 | |
| 83 Questions, comments or suggestions are welcome! | |
| 84 | |
| 85 Ralph Meijer | |
| 86 <xmpp:ralphm@ik.nu> |