Mercurial > libervia-pubsub

comparison README @ 88:41247e59b55c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Long needed update.
author Ralph Meijer <ralphm@ik.nu>
date Tue, 16 Nov 2004 11:08:50 +0000
parents 36f0ce354ce8
children 886caecb0030
comparison
equal deleted inserted replaced
87:f766e46dce0f 88:41247e59b55c
1 This is the first try at rewriting Idavoll using Twisted Python. 1 Idavoll using Twisted Python.
2 2
3 3 What is Idavoll?
4 What is Idavoll 4 ================
5 ===============
6 5
7 A pubsub service, as defined in JEP-0060, aiming to be fully compliant and 6 A pubsub service, as defined in JEP-0060, aiming to be fully compliant and
8 mostly complete. The goal is to build a /generic/ pubsub service, but of which 7 mostly complete. The goal is to build a /generic/ pubsub service, but of which
9 parts can be reused for building custom pubsub services for specific 8 parts can be reused for building custom pubsub services for specific
10 applications. 9 applications.
11 10
12 11
13 Current Status 12 Current Status
14 ============== 13 ==============
15 14
16 It is still very experimental, has hardcoded nodes and subscriptions and no 15 There are two different backends: one using PostgreSQL for storage, and one
17 storage for items. 16 just keeping everything in memory.
18 17
19 It does implement the mimimal requirements of JEP-0060 version 1.4. It also 18 In Idavoll the mimimal requirements of JEP-0060 version 1.6 are implemented.
20 returns the following features defined in version 1.5 of the specification: 19 It also returns the following features:
21 20
22 http://jabber.org/protocol/pubsub#outcast-affil 21 http://jabber.org/protocol/pubsub#outcast-affiliation
23 http://jabber.org/protocol/pubsub#publisher-affil 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
24 27
25 It lacks support for requesting the current affiliations, and doesn't allow 28 When using the PostgreSQL backend the following features are also supported:
26 for discoing for meta-data of nodes. Therefore it is not compliant with 1.5, 29
27 yet. 30 http://jabber.org/protocol/pubsub#retrieve-items
28 31
29 Requirements 32 Requirements
30 ============ 33 ============
31 34
32 - Twisted >= 1.2.0 35 - Twisted >= 1.2.0
33 - The following patches to the twisted/xish directory: 36 - The following patches to the twisted/xish directory:
34 37
35 http://mag.ik.nu/~ralphm/tmp/domish.py.patch 38 http://mag.ik.nu/~ralphm/tmp/domish.py.patch
36 http://mag.ik.nu/~ralphm/tmp/utility.py.patch 39 http://mag.ik.nu/~ralphm/tmp/utility.py.patch
37 http://mag.ik.nu/~ralphm/tmp/xpath.py.patch 40 http://mag.ik.nu/~ralphm/tmp/xpath.py.patch
38 41
39 - A jabber server like jabberd 1.4 42 - The following patches to the twisted/protocols/jabber directory:
43
44 http://mag.ik.nu/~ralphm/tmp/jid.py.patch
45
46 - A jabber server like jabberd 1.4.x
47
48 For the PostgreSQL backend, the following is also required:
49
50 - PostgreSQL
51 - pyPgSQL
40 52
41 Usage 53 Usage
42 ===== 54 =====
43 55
44 For jabberd 1.4 configuration, put the following in jabber.xml: 56 For jabberd 1.4 configuration, put the following in jabber.xml:
56 Then, in the same directory as this file run: 68 Then, in the same directory as this file run:
57 69
58 mktap idavoll --rport=1238 --jid=pubsub.localhost --secret=1238 70 mktap idavoll --rport=1238 --jid=pubsub.localhost --secret=1238
59 twistd -rf idavoll.tap 71 twistd -rf idavoll.tap
60 72
73 This uses the (default) memory based backend.
74
75 For using the PostgreSQL backend, create a database (for example named pubsub)
76 like so:
77
78 createdb pubsub
79 psql pubsub <db/pubsub.db
80
81 Then do:
82
83 mktap idavoll --rport=1238 --jid=pubsub.localhost --secret=1238 \
84 --backend=pgsql
85 twistd -rf idavoll.tap
86
87 For viewing all options, run:
88
89 mktap idavoll --help
90
91 Contact
92 =======
93
94 Questions, comments or suggestions are welcome!
95
96 Ralph Meijer
97 <xmpp:ralphm@ik.nu>