Mercurial > libervia-pubsub
annotate README @ 128:b27a66637a10
Add more documentation.
| author | Ralph Meijer <ralphm@ik.nu> |
|---|---|
| date | Sun, 24 Apr 2005 17:23:12 +0000 |
| parents | 886caecb0030 |
| children | 71ec735ca5b0 |
| 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 |
| 88 | 18 In Idavoll the mimimal requirements of JEP-0060 version 1.6 are implemented. |
| 19 It also returns the following features: | |
| 10 | 20 |
| 88 | 21 http://jabber.org/protocol/pubsub#outcast-affiliation |
| 22 http://jabber.org/protocol/pubsub#publisher-affiliation | |
| 23 http://jabber.org/protocol/pubsub#persistent-items | |
| 24 http://jabber.org/protocol/pubsub#subscribe | |
| 25 http://jabber.org/protocol/pubsub#create-nodes | |
| 26 http://jabber.org/protocol/pubsub#instant-nodes | |
| 10 | 27 |
| 88 | 28 When using the PostgreSQL backend the following features are also supported: |
| 29 | |
| 30 http://jabber.org/protocol/pubsub#retrieve-items | |
| 10 | 31 |
| 32 Requirements | |
| 33 ============ | |
| 34 | |
| 88 | 35 - Twisted >= 1.2.0 |
| 10 | 36 - The following patches to the twisted/xish directory: |
| 37 | |
| 38 http://mag.ik.nu/~ralphm/tmp/domish.py.patch | |
| 39 http://mag.ik.nu/~ralphm/tmp/utility.py.patch | |
| 40 http://mag.ik.nu/~ralphm/tmp/xpath.py.patch | |
| 41 | |
| 88 | 42 - The following patches to the twisted/protocols/jabber directory: |
| 43 | |
| 44 http://mag.ik.nu/~ralphm/tmp/jid.py.patch | |
| 45 | |
|
99
886caecb0030
Include comment about xmpp_stringprep.py addition to Twisted.
Ralph Meijer <ralphm@ik.nu>
parents:
88
diff
changeset
|
46 - Add the following file in the twisted/protocols/jabber directory: |
|
886caecb0030
Include comment about xmpp_stringprep.py addition to Twisted.
Ralph Meijer <ralphm@ik.nu>
parents:
88
diff
changeset
|
47 |
|
886caecb0030
Include comment about xmpp_stringprep.py addition to Twisted.
Ralph Meijer <ralphm@ik.nu>
parents:
88
diff
changeset
|
48 http://mag.ik.nu/~ralphm/tmp/xmpp_stringprep.py |
|
886caecb0030
Include comment about xmpp_stringprep.py addition to Twisted.
Ralph Meijer <ralphm@ik.nu>
parents:
88
diff
changeset
|
49 |
| 88 | 50 - A jabber server like jabberd 1.4.x |
| 51 | |
| 52 For the PostgreSQL backend, the following is also required: | |
| 53 | |
| 54 - PostgreSQL | |
| 55 - pyPgSQL | |
| 10 | 56 |
| 57 Usage | |
| 58 ===== | |
| 59 | |
| 60 For jabberd 1.4 configuration, put the following in jabber.xml: | |
| 61 | |
| 62 <service id='pubsub.localhost'> | |
| 63 <accept> | |
| 64 <ip>127.0.0.1</ip> | |
| 65 <port>1238</port> | |
| 66 <secret>mysecret</secret> | |
| 67 </accept> | |
| 68 </service> | |
| 69 | |
| 70 and restart jabberd. | |
| 71 | |
| 72 Then, in the same directory as this file run: | |
| 73 | |
| 74 mktap idavoll --rport=1238 --jid=pubsub.localhost --secret=1238 | |
| 75 twistd -rf idavoll.tap | |
| 76 | |
| 88 | 77 This uses the (default) memory based backend. |
| 78 | |
| 79 For using the PostgreSQL backend, create a database (for example named pubsub) | |
| 80 like so: | |
| 81 | |
| 82 createdb pubsub | |
| 83 psql pubsub <db/pubsub.db | |
| 84 | |
| 85 Then do: | |
| 86 | |
| 87 mktap idavoll --rport=1238 --jid=pubsub.localhost --secret=1238 \ | |
| 88 --backend=pgsql | |
| 89 twistd -rf idavoll.tap | |
| 90 | |
| 91 For viewing all options, run: | |
| 92 | |
| 93 mktap idavoll --help | |
| 94 | |
| 95 Contact | |
| 96 ======= | |
| 97 | |
| 98 Questions, comments or suggestions are welcome! | |
| 99 | |
| 100 Ralph Meijer | |
| 101 <xmpp:ralphm@ik.nu> |