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
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
386
0fedfb5cd7c7 0.3.0a1 release
Goffi <goffi@goffi.org>
parents: 384
diff changeset
1 SàT PubSub component v0.3.0a1
233
564ae55219e1 sublicensed under AGPL V3
Goffi <goffi@goffi.org>
parents: 217
diff changeset
2 This program is heavily based on Idavoll (0.9.1), which was written by Ralph Meijer
564ae55219e1 sublicensed under AGPL V3
Goffi <goffi@goffi.org>
parents: 217
diff changeset
3
384
aa3a464df605 dates update
Goffi <goffi@goffi.org>
parents: 371
diff changeset
4 Copyright (c) 2012-2019 Jérôme Poisson
311
a776544d84e5 copyright update
Goffi <goffi@goffi.org>
parents: 305
diff changeset
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
564ae55219e1 sublicensed under AGPL V3
Goffi <goffi@goffi.org>
parents: 217
diff changeset
7
404
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents: 386
diff changeset
8 SàT PubSub is a PubSub component service for XMPP
233
564ae55219e1 sublicensed under AGPL V3
Goffi <goffi@goffi.org>
parents: 217
diff changeset
9
10
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
10
264
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
11 ** LICENSE **
10
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
12
264
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
13 Sàt PubSub is free software: you can redistribute it and/or modify
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
14 it under the terms of the GNU Affero General Public License as published by
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
15 the Free Software Foundation, either version 3 of the License, or
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
16 (at your option) any later version.
10
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
17
264
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
18 Sàt PubSub is distributed in the hope that it will be useful,
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
19 but WITHOUT ANY WARRANTY; without even the implied warranty of
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
20 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
21 GNU Affero General Public License for more details.
10
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
22
264
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
23 You should have received a copy of the GNU Affero General Public License
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
24 along with Sàt PubSub. If not, see <http://www.gnu.org/licenses/>.
10
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
25
264
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
26
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
27 ** ABOUT **
10
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
28
264
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
29 SàT PubSub is a XMPP PubSub service component (XEP-0060)
404
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents: 386
diff changeset
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
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
31 The use of a standard external component allow to use this features with most XMPP servers.
404
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents: 386
diff changeset
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
36f0ce354ce8 Initial revision
Ralph Meijer <ralphm@ik.nu>
parents:
diff changeset
33
264
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
34
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
35 ** INSTALLATION **
88
41247e59b55c Long needed update.
Ralph Meijer <ralphm@ik.nu>
parents: 10
diff changeset
36
404
105a0772eedd doc: first draft
Goffi <goffi@goffi.org>
parents: 386
diff changeset
37 Please check doc/ directory
264
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
38
88
41247e59b55c Long needed update.
Ralph Meijer <ralphm@ik.nu>
parents: 10
diff changeset
39
264
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
40 ** CREDIT **
88
41247e59b55c Long needed update.
Ralph Meijer <ralphm@ik.nu>
parents: 10
diff changeset
41
264
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
42 The base project (Idavoll) was made by Ralph Meijer and can be found on http://idavoll.ik.nu/
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
43
88
41247e59b55c Long needed update.
Ralph Meijer <ralphm@ik.nu>
parents: 10
diff changeset
44
371
8bf2db9accf0 README: added contribution links
Goffi <goffi@goffi.org>
parents: 368
diff changeset
45 ** CONTRIBUTIONS **
8bf2db9accf0 README: added contribution links
Goffi <goffi@goffi.org>
parents: 368
diff changeset
46
8bf2db9accf0 README: added contribution links
Goffi <goffi@goffi.org>
parents: 368
diff changeset
47 Here are the URIs you can use to publish/retrieve tickets or merge requests:
8bf2db9accf0 README: added contribution links
Goffi <goffi@goffi.org>
parents: 368
diff changeset
48
8bf2db9accf0 README: added contribution links
Goffi <goffi@goffi.org>
parents: 368
diff changeset
49 tickets: xmpp:pubsub.goffi.org?;node=org.salut-a-toi.tickets%3A0 (please use "SàT Pubsub" label)
8bf2db9accf0 README: added contribution links
Goffi <goffi@goffi.org>
parents: 368
diff changeset
50 merge requests: xmpp:pubsub.goffi.org?;node=org.salut-a-toi.merge_requests%3A0 (please use "SàT Pubsub" label)
8bf2db9accf0 README: added contribution links
Goffi <goffi@goffi.org>
parents: 368
diff changeset
51
8bf2db9accf0 README: added contribution links
Goffi <goffi@goffi.org>
parents: 368
diff changeset
52 Tickets and merge requests are handled by SàT itself using XMPP.
8bf2db9accf0 README: added contribution links
Goffi <goffi@goffi.org>
parents: 368
diff changeset
53
8bf2db9accf0 README: added contribution links
Goffi <goffi@goffi.org>
parents: 368
diff changeset
54
264
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
55 ** CONTACT **
88
41247e59b55c Long needed update.
Ralph Meijer <ralphm@ik.nu>
parents: 10
diff changeset
56
264
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
57 Goffi (Jérôme Poisson): goffi@goffi.org (e-mail) or goffi@jabber.fr (jid)
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
58 Souliane (Adrien Cossa): souliane@mailoo.org (e-mail) or souliane@libervia.org (jid)
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
59
86e767dc6abb packaging for release
souliane <souliane@mailoo.org>
parents: 255
diff changeset
60 XMPP MUC: sat@chat.jabberfr.org