Mercurial > libervia-pubsub

comparison README @ 264:86e767dc6abb

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
packaging for release
author souliane <souliane@mailoo.org>
date Sat, 22 Feb 2014 06:10:24 +0100
parents d55620ceafed
children 002c59dbc23f
comparison
equal deleted inserted replaced
263:9dfd3890e646 264:86e767dc6abb
1 Sat PubSub component 1 SàT PubSub component v0.1.0
2 This program is heavily based on Idavoll (0.9.1), which was written by Ralph Meijer 2 This program is heavily based on Idavoll (0.9.1), which was written by Ralph Meijer
3 3
4 Copyright (c) 2014 Adrien Cossa
5 Copyright (c) 2012, 2013, 2014 Jérôme Poisson
4 Copyright (c) 2003-2011 Ralph Meijer 6 Copyright (c) 2003-2011 Ralph Meijer
5 Copyright (c) 2012, 2013 Jérôme Poisson
6 7
7 ** Below is the original README from Idavoll ** 8 Sàt PubSub is a PubSub component service for XMPP
8 9
9 10
10 What is this?
11 ================
12 11
13 Idavoll is a Jabber publish-subscribe service component, as defined in
14 JEP-0060, aiming to be fully compliant and mostly complete. The goal is to
15 build a generic pubsub service, but of which parts can be reused for building
16 custom pubsub services for specific applications.
17 12
18 Current Status 13 ** LICENSE **
19 ==============
20 14
21 There are two different backends: one using PostgreSQL for storage, and one 15 Sàt PubSub is free software: you can redistribute it and/or modify
22 just keeping everything in memory. 16 it under the terms of the GNU Affero General Public License as published by
17 the Free Software Foundation, either version 3 of the License, or
18 (at your option) any later version.
23 19
24 In Idavoll the mimimal requirements of JEP-0060 version 1.11 are implemented 20 Sàt PubSub is distributed in the hope that it will be useful,
25 plus a number of optional features, as returned by Service Discovery. 21 but WITHOUT ANY WARRANTY; without even the implied warranty of
22 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 GNU Affero General Public License for more details.
26 24
27 Installing 25 You should have received a copy of the GNU Affero General Public License
28 ========== 26 along with Sàt PubSub. If not, see <http://www.gnu.org/licenses/>.
29 27
30 Instructions for installing, configuring and running this software are in
31 INSTALL. Also refer to UPGRADING for instruction on upgrading from older
32 versions of Idavoll.
33 28
34 Copyright 29 ** ABOUT **
35 =========
36 30
37 All of the code in this distribution is Copyright (c) 2003-2011 Ralph Meijer. 31 SàT PubSub is a XMPP PubSub service component (XEP-0060)
32 It's based on Ralph Meijer's Idavoll, but provide special features necessary for the « Salut à Toi » project ( http://sat.goffi.org ), but it can also be used for any other XMPP project.
33 The use of a standard external component allow to use this features with most XMPP servers.
34 One of the main addition is fine access tuning for PubSub, which allow the publication of items for only some groups, even if the entire node is open. The protocol is explained on http://www.goffi.org/post/2012/06/24/Fine-access-tuning-for-PubSub for the moment, and a protoxep should be proposed to the XSF in the future...
38 35
39 Idavoll is made available under the MIT license. The included LICENSE file
40 describes this in detail.
41 36
42 Contact 37 ** INSTALLATION **
43 =======
44 38
45 Questions, comments or suggestions are welcome! There is a mailing list for 39 Instructions for installation are the same as for Idavoll, so follow what is written in INSTALL and UPGRADING files.
46 Jabber related Twisted development at mailto:twisted-jabber@ik.nu. The list's
47 info page lives here: https://mailman.ik.nu/mailman/listinfo/twisted-jabber.
48 40
49 Ralph Meijer 41
50 <xmpp:ralphm@ik.nu> 42 ** CREDIT **
43
44 The base project (Idavoll) was made by Ralph Meijer and can be found on http://idavoll.ik.nu/
45
46
47 ** CONTACT **
48
49 Goffi (Jérôme Poisson): goffi@goffi.org (e-mail) or goffi@jabber.fr (jid)
50 Souliane (Adrien Cossa): souliane@mailoo.org (e-mail) or souliane@libervia.org (jid)
51
52 XMPP MUC: sat@chat.jabberfr.org