Mercurial > libervia-pubsub
annotate README @ 427:f6f4f99f1a1b
doc: explicite "wheel" installation + renamed "sat-pubsub.*" jids to simpler "pubsub.*"
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Fri, 09 Oct 2020 18:22:45 +0200 |
| parents | d58599801c23 |
| children | 074037832daf |
| rev | line source |
|---|---|
|
405
c56a728412f1
file organisation + setup refactoring:
Goffi <goffi@goffi.org>
parents:
404
diff
changeset
|
1 SàT PubSub |
| 233 | 2 |
| 384 | 3 Copyright (c) 2012-2019 Jérôme Poisson |
| 311 | 4 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
|
5 Copyright (c) 2003-2011 Ralph Meijer |
| 233 | 6 |
|
405
c56a728412f1
file organisation + setup refactoring:
Goffi <goffi@goffi.org>
parents:
404
diff
changeset
|
7 SàT PubSub is a PubSub/PEP component for XMPP |
| 233 | 8 |
| 10 | 9 |
| 264 | 10 ** LICENSE ** |
| 10 | 11 |
| 264 | 12 Sàt PubSub is free software: you can redistribute it and/or modify |
| 13 it under the terms of the GNU Affero General Public License as published by | |
| 14 the Free Software Foundation, either version 3 of the License, or | |
| 15 (at your option) any later version. | |
| 10 | 16 |
| 264 | 17 Sàt PubSub is distributed in the hope that it will be useful, |
| 18 but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 19 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
| 20 GNU Affero General Public License for more details. | |
| 10 | 21 |
| 264 | 22 You should have received a copy of the GNU Affero General Public License |
| 23 along with Sàt PubSub. If not, see <http://www.gnu.org/licenses/>. | |
| 10 | 24 |
| 264 | 25 |
| 26 ** ABOUT ** | |
| 10 | 27 |
| 407 | 28 SàT PubSub is a XMPP PubSub/PEP component (XEP-0060) It's based on Ralph |
| 29 Meijer's Idavoll, and provides special features necessary for the « Salut à | |
| 30 Toi » project (https://salut-a-toi.org), but it can also be used for any other | |
| 31 XMPP project. The use of a standard external component allow to use this | |
| 32 features with most XMPP servers. One of the main addition is fine access | |
| 33 tuning for PubSub, which allow the publication of items for only some groups, | |
| 34 even if the entire node is open. The protocol is explained on | |
| 35 https://www.goffi.org/post/2012/06/24/Fine-access-tuning-for-PubSub for the | |
| 36 moment, and a protoxep should be proposed to the XSF in the future... | |
| 10 | 37 |
| 264 | 38 |
| 39 ** INSTALLATION ** | |
| 88 | 40 |
| 404 | 41 Please check doc/ directory |
| 264 | 42 |
| 88 | 43 |
| 407 | 44 ** CREDITS ** |
| 45 | |
| 46 The base project (Idavoll) was made by Ralph Meijer and can be found on | |
| 47 http://idavoll.ik.nu/. | |
| 48 The main authors of SàT Pubsub (beside original work) are Jérôme Poisson and | |
| 49 Adrien Cossa. | |
| 88 | 50 |
| 407 | 51 Idavoll has also received a contribution which have been inherited in SàT |
| 52 Pubsub from Christopher Zorn. | |
| 53 | |
| 54 SàT Pubsub has received contributions from: | |
| 55 | |
| 56 - Arnaud Joset | |
| 57 - W. Martin Borgert | |
| 264 | 58 |
| 88 | 59 |
| 371 | 60 ** CONTRIBUTIONS ** |
| 61 | |
| 62 Here are the URIs you can use to publish/retrieve tickets or merge requests: | |
| 63 | |
| 64 tickets: xmpp:pubsub.goffi.org?;node=org.salut-a-toi.tickets%3A0 (please use "SàT Pubsub" label) | |
| 65 merge requests: xmpp:pubsub.goffi.org?;node=org.salut-a-toi.merge_requests%3A0 (please use "SàT Pubsub" label) | |
| 66 | |
| 67 Tickets and merge requests are handled by SàT itself using XMPP. | |
| 68 | |
| 69 | |
| 264 | 70 ** CONTACT ** |
| 88 | 71 |
| 264 | 72 Goffi (Jérôme Poisson): goffi@goffi.org (e-mail) or goffi@jabber.fr (jid) |
| 73 Souliane (Adrien Cossa): souliane@mailoo.org (e-mail) or souliane@libervia.org (jid) | |
| 74 | |
| 75 XMPP MUC: sat@chat.jabberfr.org |