Mercurial > libervia-pubsub

comparison README @ 155:5191ba7c4df8

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Work towards first release 0.5.0. - Add licensing information (MIT) - Improve installation instructions. - Use new plugins framework in twisted.
author Ralph Meijer <ralphm@ik.nu>
date Mon, 21 Aug 2006 16:05:35 +0000
parents bd8e58c73370
children 6250905b72f6
comparison
equal deleted inserted replaced
154:bd8e58c73370 155:5191ba7c4df8
1 Idavoll using Twisted Python. 1 Idavoll 0.5.0
2 2
3 What is Idavoll? 3 What is this?
4 ================ 4 ================
5 5
6 A pubsub service, as defined in JEP-0060, aiming to be fully compliant and 6 Idavoll is a Jabber publish-subscribe service component, as defined in
7 mostly complete. The goal is to build a /generic/ pubsub service, but of which 7 JEP-0060, aiming to be fully compliant and mostly complete. The goal is to
8 parts can be reused for building custom pubsub services for specific 8 build a generic pubsub service, but of which parts can be reused for
9 applications. 9 building custom pubsub services for specific applications.
10
11 10
12 Current Status 11 Current Status
13 ============== 12 ==============
14 13
15 There are two different backends: one using PostgreSQL for storage, and one 14 There are two different backends: one using PostgreSQL for storage, and one
16 just keeping everything in memory. 15 just keeping everything in memory.
17 16
18 In Idavoll the mimimal requirements of JEP-0060 version 1.8 are implemented 17 In Idavoll the mimimal requirements of JEP-0060 version 1.8 are implemented
19 plus most optional features, as returned by Service Discovery. 18 plus most optional features, as returned by Service Discovery.
20 19
21 Requirements 20 Installing
22 ============ 21 ==========
23 22
24 - Twisted Core >= 2.0.0 23 Instructions for installing, configuring and running this software are in
25 - Twisted Words >= 0.3.0 24 INSTALL.
26 - uuid.py (http://ofxsuite.berlios.de/uuid.py)
27 - A jabber server that supports the component protocol (JEP-0114)
28 25
29 For the PostgreSQL backend, the following is also required: 26 Copyright
27 =========
30 28
31 - PostgreSQL 29 All of the code in this distribution is Copyright (c) 2003-2006 Ralph Meijer
32 - pyPgSQL
33 30
34 Usage 31 Idavoll is made available under the MIT license. The included LICENSE file
35 ===== 32 describes this in detail.
36
37 For jabberd 1.4 configuration, put the following in jabber.xml:
38
39 <service id='pubsub.localhost'>
40 <accept>
41 <ip>127.0.0.1</ip>
42 <port>1238</port>
43 <secret>mysecret</secret>
44 </accept>
45 </service>
46
47 and restart jabberd.
48
49 For jabberd 2.x, you can use the 'legacy' component support that defaults
50 to port 5347. You do not need to add anything specific for this service.
51
52 For other server implementations, please refer to its documentation on
53 how to interact with server side components using the protocol defined in
54 JEP-0114.
55
56 Then, in the same directory as this file run:
57
58 mktap idavoll --rport=1238 --jid=pubsub.localhost --secret=1238
59 twistd -rf idavoll.tap
60
61 This uses the (default) memory based backend. You can ignore the deprecation
62 warnings.
63
64 For using the PostgreSQL backend, create a database (for example named pubsub)
65 like so:
66
67 createdb pubsub
68 psql pubsub <db/pubsub.db
69
70 Then do:
71
72 mktap idavoll --rport=1238 --jid=pubsub.localhost --secret=1238 \
73 --backend=pgsql
74 twistd -rf idavoll.tap
75
76 For viewing all options, run:
77
78 mktap idavoll --help
79 33
80 Contact 34 Contact
81 ======= 35 =======
82 36
83 Questions, comments or suggestions are welcome! 37 Questions, comments or suggestions are welcome!