Mercurial > libervia-pubsub

view README @ 405:c56a728412f1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
file organisation + setup refactoring: - `/src` has been renamed to `/sat_pubsub`, this is the recommended naming convention - revamped `setup.py` on the basis of SàT's `setup.py` - added a `VERSION` which is the unique place where version number will now be set - use same trick as in SàT to specify dev version (`D` at the end) - use setuptools_scm to retrieve Mercurial hash when in dev version
author Goffi <goffi@goffi.org>
date Fri, 16 Aug 2019 12:00:02 +0200
parents 105a0772eedd
children d58599801c23
line wrap: on
line source

SàT PubSub
This program is heavily based on Idavoll (0.9.1), which was written by Ralph Meijer

Copyright (c) 2012-2019 Jérôme Poisson
Copyright (c) 2014-2016 Adrien Cossa
Copyright (c) 2003-2011 Ralph Meijer

SàT PubSub is a PubSub/PEP component for XMPP


** LICENSE **

Sàt PubSub is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

Sàt PubSub is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with Sàt PubSub.  If not, see <http://www.gnu.org/licenses/>.


** ABOUT **

SàT PubSub is a XMPP PubSub/PEP component (XEP-0060)
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.
The use of a standard external component allow to use this features with most XMPP servers.
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...


** INSTALLATION **

Please check doc/ directory


** CREDIT **

The base project (Idavoll) was made by Ralph Meijer and can be found on http://idavoll.ik.nu/


** CONTRIBUTIONS **

Here are the URIs you can use to publish/retrieve tickets or merge requests:

tickets: xmpp:pubsub.goffi.org?;node=org.salut-a-toi.tickets%3A0 (please use "SàT Pubsub" label)
merge requests: xmpp:pubsub.goffi.org?;node=org.salut-a-toi.merge_requests%3A0 (please use "SàT Pubsub" label)

Tickets and merge requests are handled by SàT itself using XMPP.


** CONTACT **

Goffi (Jérôme Poisson): goffi@goffi.org (e-mail) or goffi@jabber.fr (jid)
Souliane (Adrien Cossa): souliane@mailoo.org (e-mail) or souliane@libervia.org (jid)

XMPP MUC: sat@chat.jabberfr.org