view README @ 380:e81964db3cd6

administrators entities: In config file, the "admins_jids_list" setting can now be set to give a list of bare jids of entities with administrator privileges. This is not used yet but will be soon. config is now available in backend using self.config.
author Goffi <goffi@goffi.org>
date Sun, 13 Jan 2019 18:56:17 +0100
parents 8bf2db9accf0
children aa3a464df605
line wrap: on
line source

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

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

Sàt PubSub is a PubSub component service 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 service component (XEP-0060)
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.
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 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...


** INSTALLATION **

Instructions for installation are the same as for Idavoll, so follow what is written in INSTALL and UPGRADING files.


** 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