|
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 |
|
133
|
18 In Idavoll the mimimal requirements of JEP-0060 version 1.7 are implemented |
|
|
19 plus most optional features, as returned by Service Discovery. |
|
10
|
20 |
|
|
21 Requirements |
|
|
22 ============ |
|
|
23 |
|
132
|
24 - Twisted >= 2.0.0 |
|
88
|
25 - A jabber server like jabberd 1.4.x |
|
|
26 |
|
|
27 For the PostgreSQL backend, the following is also required: |
|
|
28 |
|
|
29 - PostgreSQL |
|
|
30 - pyPgSQL |
|
10
|
31 |
|
|
32 Usage |
|
|
33 ===== |
|
|
34 |
|
|
35 For jabberd 1.4 configuration, put the following in jabber.xml: |
|
|
36 |
|
|
37 <service id='pubsub.localhost'> |
|
|
38 <accept> |
|
|
39 <ip>127.0.0.1</ip> |
|
|
40 <port>1238</port> |
|
|
41 <secret>mysecret</secret> |
|
|
42 </accept> |
|
|
43 </service> |
|
|
44 |
|
|
45 and restart jabberd. |
|
|
46 |
|
|
47 Then, in the same directory as this file run: |
|
|
48 |
|
|
49 mktap idavoll --rport=1238 --jid=pubsub.localhost --secret=1238 |
|
|
50 twistd -rf idavoll.tap |
|
|
51 |
|
132
|
52 This uses the (default) memory based backend. You can ignore the deprecation |
|
|
53 warnings. |
|
88
|
54 |
|
|
55 For using the PostgreSQL backend, create a database (for example named pubsub) |
|
|
56 like so: |
|
|
57 |
|
|
58 createdb pubsub |
|
|
59 psql pubsub <db/pubsub.db |
|
|
60 |
|
|
61 Then do: |
|
|
62 |
|
|
63 mktap idavoll --rport=1238 --jid=pubsub.localhost --secret=1238 \ |
|
|
64 --backend=pgsql |
|
|
65 twistd -rf idavoll.tap |
|
|
66 |
|
|
67 For viewing all options, run: |
|
|
68 |
|
|
69 mktap idavoll --help |
|
|
70 |
|
|
71 Contact |
|
|
72 ======= |
|
|
73 |
|
|
74 Questions, comments or suggestions are welcome! |
|
|
75 |
|
|
76 Ralph Meijer |
|
|
77 <xmpp:ralphm@ik.nu> |
