annotate README @ 18:7937d6fbbe2a

Small code cleanups
author Ralph Meijer <ralphm@ik.nu>
date Mon, 30 Aug 2004 17:41:18 +0000
parents 36f0ce354ce8
children 41247e59b55c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
10
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
1 This is the first try at rewriting Idavoll using Twisted Python.
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
2
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
3
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
4 What is Idavoll
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
5 ===============
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
6
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
7 A pubsub service, as defined in JEP-0060, aiming to be fully compliant and
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
8 mostly complete. The goal is to build a /generic/ pubsub service, but of which
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
9 parts can be reused for building custom pubsub services for specific
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
10 applications.
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
11
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
12
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
13 Current Status
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
14 ==============
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
15
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
16 It is still very experimental, has hardcoded nodes and subscriptions and no
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
17 storage for items.
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
18
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
19 It does implement the mimimal requirements of JEP-0060 version 1.4. It also
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
20 returns the following features defined in version 1.5 of the specification:
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
21
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
22 http://jabber.org/protocol/pubsub#outcast-affil
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
23 http://jabber.org/protocol/pubsub#publisher-affil
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
24
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
25 It lacks support for requesting the current affiliations, and doesn't allow
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
26 for discoing for meta-data of nodes. Therefore it is not compliant with 1.5,
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
27 yet.
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
28
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
29 Requirements
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
30 ============
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
31
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
32 - Twisted >= 1.2.0
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
33 - The following patches to the twisted/xish directory:
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
34
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
35 http://mag.ik.nu/~ralphm/tmp/domish.py.patch
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
36 http://mag.ik.nu/~ralphm/tmp/utility.py.patch
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
37 http://mag.ik.nu/~ralphm/tmp/xpath.py.patch
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
38
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
39 - A jabber server like jabberd 1.4
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
40
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
41 Usage
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
42 =====
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
43
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
44 For jabberd 1.4 configuration, put the following in jabber.xml:
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
45
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
46 <service id='pubsub.localhost'>
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
47 <accept>
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
48 <ip>127.0.0.1</ip>
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
49 <port>1238</port>
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
50 <secret>mysecret</secret>
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
51 </accept>
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
52 </service>
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
53
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
54 and restart jabberd.
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
55
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
56 Then, in the same directory as this file run:
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
57
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
58 mktap idavoll --rport=1238 --jid=pubsub.localhost --secret=1238
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
59 twistd -rf idavoll.tap
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
60