Mercurial > libervia-pubsub
annotate README @ 404:105a0772eedd
doc: first draft
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Wed, 24 Jul 2019 19:26:43 +0200 |
| parents | 0fedfb5cd7c7 |
| children | c56a728412f1 |
| rev | line source |
|---|---|
| 386 | 1 SàT PubSub component v0.3.0a1 |
| 233 | 2 This program is heavily based on Idavoll (0.9.1), which was written by Ralph Meijer |
| 3 | |
| 384 | 4 Copyright (c) 2012-2019 Jérôme Poisson |
| 311 | 5 Copyright (c) 2014-2016 Adrien Cossa |
|
235
64f780413b82
fixed Ralph Meijer copyright years (last commit was in 2011, not in 2009)
Goffi <goffi@goffi.org>
parents:
233
diff
changeset
|
6 Copyright (c) 2003-2011 Ralph Meijer |
| 233 | 7 |
| 404 | 8 SàT PubSub is a PubSub component service for XMPP |
| 233 | 9 |
| 10 | 10 |
| 264 | 11 ** LICENSE ** |
| 10 | 12 |
| 264 | 13 Sàt PubSub is free software: you can redistribute it and/or modify |
| 14 it under the terms of the GNU Affero General Public License as published by | |
| 15 the Free Software Foundation, either version 3 of the License, or | |
| 16 (at your option) any later version. | |
| 10 | 17 |
| 264 | 18 Sàt PubSub is distributed in the hope that it will be useful, |
| 19 but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 20 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
| 21 GNU Affero General Public License for more details. | |
| 10 | 22 |
| 264 | 23 You should have received a copy of the GNU Affero General Public License |
| 24 along with Sàt PubSub. If not, see <http://www.gnu.org/licenses/>. | |
| 10 | 25 |
| 264 | 26 |
| 27 ** ABOUT ** | |
| 10 | 28 |
| 264 | 29 SàT PubSub is a XMPP PubSub service component (XEP-0060) |
| 404 | 30 It's based on Ralph Meijer's Idavoll, and provides special features necessary for the « Salut à Toi » project (https://salut-a-toi.org), but it can also be used for any other XMPP project. |
| 264 | 31 The use of a standard external component allow to use this features with most XMPP servers. |
| 404 | 32 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 https://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... |
| 10 | 33 |
| 264 | 34 |
| 35 ** INSTALLATION ** | |
| 88 | 36 |
| 404 | 37 Please check doc/ directory |
| 264 | 38 |
| 88 | 39 |
| 264 | 40 ** CREDIT ** |
| 88 | 41 |
| 264 | 42 The base project (Idavoll) was made by Ralph Meijer and can be found on http://idavoll.ik.nu/ |
| 43 | |
| 88 | 44 |
| 371 | 45 ** CONTRIBUTIONS ** |
| 46 | |
| 47 Here are the URIs you can use to publish/retrieve tickets or merge requests: | |
| 48 | |
| 49 tickets: xmpp:pubsub.goffi.org?;node=org.salut-a-toi.tickets%3A0 (please use "SàT Pubsub" label) | |
| 50 merge requests: xmpp:pubsub.goffi.org?;node=org.salut-a-toi.merge_requests%3A0 (please use "SàT Pubsub" label) | |
| 51 | |
| 52 Tickets and merge requests are handled by SàT itself using XMPP. | |
| 53 | |
| 54 | |
| 264 | 55 ** CONTACT ** |
| 88 | 56 |
| 264 | 57 Goffi (Jérôme Poisson): goffi@goffi.org (e-mail) or goffi@jabber.fr (jid) |
| 58 Souliane (Adrien Cossa): souliane@mailoo.org (e-mail) or souliane@libervia.org (jid) | |
| 59 | |
| 60 XMPP MUC: sat@chat.jabberfr.org |