annotate README @ 151:f809b998c6f4

Add comments about uuid.py and the required Twisted modules.
author Ralph Meijer <ralphm@ik.nu>
date Wed, 05 Oct 2005 07:02:40 +0000
parents 229c6f6cd754
children bd8e58c73370
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
88
41247e59b55c Long needed update.
Ralph Meijer <ralphm@ik.nu>
parents: 10
diff changeset
1 Idavoll using Twisted Python.
10
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
2
88
41247e59b55c Long needed update.
Ralph Meijer <ralphm@ik.nu>
parents: 10
diff changeset
3 What is Idavoll?
41247e59b55c Long needed update.
Ralph Meijer <ralphm@ik.nu>
parents: 10
diff changeset
4 ================
10
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
5
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
6 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
7 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
8 parts can be reused for building custom pubsub services for specific
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
9 applications.
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
10
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
11
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
12 Current Status
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
13 ==============
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
14
88
41247e59b55c Long needed update.
Ralph Meijer <ralphm@ik.nu>
parents: 10
diff changeset
15 There are two different backends: one using PostgreSQL for storage, and one
41247e59b55c Long needed update.
Ralph Meijer <ralphm@ik.nu>
parents: 10
diff changeset
16 just keeping everything in memory.
10
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
17
133
229c6f6cd754 Update to current state.
Ralph Meijer <ralphm@ik.nu>
parents: 132
diff changeset
18 In Idavoll the mimimal requirements of JEP-0060 version 1.7 are implemented
229c6f6cd754 Update to current state.
Ralph Meijer <ralphm@ik.nu>
parents: 132
diff changeset
19 plus most optional features, as returned by Service Discovery.
10
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
20
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
21 Requirements
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
22 ============
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
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
f809b998c6f4 Add comments about uuid.py and the required Twisted modules.
Ralph Meijer <ralphm@ik.nu>
parents: 133
diff changeset
25 - Twisted Xish >= 0.1.0
f809b998c6f4 Add comments about uuid.py and the required Twisted modules.
Ralph Meijer <ralphm@ik.nu>
parents: 133
diff changeset
26 - Twisted Words >= 0.1.0
f809b998c6f4 Add comments about uuid.py and the required Twisted modules.
Ralph Meijer <ralphm@ik.nu>
parents: 133
diff changeset
27 - 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
28 - A jabber server that supports the component protocol (JEP-0114)
88
41247e59b55c Long needed update.
Ralph Meijer <ralphm@ik.nu>
parents: 10
diff changeset
29
41247e59b55c Long needed update.
Ralph Meijer <ralphm@ik.nu>
parents: 10
diff changeset
30 For the PostgreSQL backend, the following is also required:
41247e59b55c Long needed update.
Ralph Meijer <ralphm@ik.nu>
parents: 10
diff changeset
31
41247e59b55c Long needed update.
Ralph Meijer <ralphm@ik.nu>
parents: 10
diff changeset
32 - PostgreSQL
41247e59b55c Long needed update.
Ralph Meijer <ralphm@ik.nu>
parents: 10
diff changeset
33 - pyPgSQL
10
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
34
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
35 Usage
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
36 =====
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
37
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
38 For jabberd 1.4 configuration, put the following in jabber.xml:
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
39
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
40 <service id='pubsub.localhost'>
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
41 <accept>
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
42 <ip>127.0.0.1</ip>
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
43 <port>1238</port>
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
44 <secret>mysecret</secret>
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
45 </accept>
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
46 </service>
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
47
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
48 and restart jabberd.
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
49
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
50 Then, in the same directory as this file run:
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
51
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
52 mktap idavoll --rport=1238 --jid=pubsub.localhost --secret=1238
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
53 twistd -rf idavoll.tap
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
54
132
71ec735ca5b0 New requirements.
Ralph Meijer <ralphm@ik.nu>
parents: 99
diff changeset
55 This uses the (default) memory based backend. You can ignore the deprecation
71ec735ca5b0 New requirements.
Ralph Meijer <ralphm@ik.nu>
parents: 99
diff changeset
56 warnings.
88
41247e59b55c Long needed update.
Ralph Meijer <ralphm@ik.nu>
parents: 10
diff changeset
57
41247e59b55c Long needed update.
Ralph Meijer <ralphm@ik.nu>
parents: 10
diff changeset
58 For using the PostgreSQL backend, create a database (for example named pubsub)
41247e59b55c Long needed update.
Ralph Meijer <ralphm@ik.nu>
parents: 10
diff changeset
59 like so:
41247e59b55c Long needed update.
Ralph Meijer <ralphm@ik.nu>
parents: 10
diff changeset
60
41247e59b55c Long needed update.
Ralph Meijer <ralphm@ik.nu>
parents: 10
diff changeset
61 createdb pubsub
41247e59b55c Long needed update.
Ralph Meijer <ralphm@ik.nu>
parents: 10
diff changeset
62 psql pubsub <db/pubsub.db
41247e59b55c Long needed update.
Ralph Meijer <ralphm@ik.nu>
parents: 10
diff changeset
63
41247e59b55c Long needed update.
Ralph Meijer <ralphm@ik.nu>
parents: 10
diff changeset
64 Then do:
41247e59b55c Long needed update.
Ralph Meijer <ralphm@ik.nu>
parents: 10
diff changeset
65
41247e59b55c Long needed update.
Ralph Meijer <ralphm@ik.nu>
parents: 10
diff changeset
66 mktap idavoll --rport=1238 --jid=pubsub.localhost --secret=1238 \
41247e59b55c Long needed update.
Ralph Meijer <ralphm@ik.nu>
parents: 10
diff changeset
67 --backend=pgsql
41247e59b55c Long needed update.
Ralph Meijer <ralphm@ik.nu>
parents: 10
diff changeset
68 twistd -rf idavoll.tap
41247e59b55c Long needed update.
Ralph Meijer <ralphm@ik.nu>
parents: 10
diff changeset
69
41247e59b55c Long needed update.
Ralph Meijer <ralphm@ik.nu>
parents: 10
diff changeset
70 For viewing all options, run:
41247e59b55c Long needed update.
Ralph Meijer <ralphm@ik.nu>
parents: 10
diff changeset
71
41247e59b55c Long needed update.
Ralph Meijer <ralphm@ik.nu>
parents: 10
diff changeset
72 mktap idavoll --help
41247e59b55c Long needed update.
Ralph Meijer <ralphm@ik.nu>
parents: 10
diff changeset
73
41247e59b55c Long needed update.
Ralph Meijer <ralphm@ik.nu>
parents: 10
diff changeset
74 Contact
41247e59b55c Long needed update.
Ralph Meijer <ralphm@ik.nu>
parents: 10
diff changeset
75 =======
41247e59b55c Long needed update.
Ralph Meijer <ralphm@ik.nu>
parents: 10
diff changeset
76
41247e59b55c Long needed update.
Ralph Meijer <ralphm@ik.nu>
parents: 10
diff changeset
77 Questions, comments or suggestions are welcome!
41247e59b55c Long needed update.
Ralph Meijer <ralphm@ik.nu>
parents: 10
diff changeset
78
41247e59b55c Long needed update.
Ralph Meijer <ralphm@ik.nu>
parents: 10
diff changeset
79 Ralph Meijer
41247e59b55c Long needed update.
Ralph Meijer <ralphm@ik.nu>
parents: 10
diff changeset
80 <xmpp:ralphm@ik.nu>