Mercurial > libervia-pubsub

changeset 468:445a2f67be4a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: update following renaming and delegation changes
author Goffi <goffi@goffi.org>
date Fri, 15 Oct 2021 15:54:15 +0200
parents d86e0f8a1405
children bcbd2399bfee
files doc/conf.py doc/installation.rst
diffstat 2 files changed, 28 insertions(+), 26 deletions(-) [+]
line wrap: on
line diff
--- a/doc/conf.py	Fri Oct 15 15:30:18 2021 +0200
+++ b/doc/conf.py	Fri Oct 15 15:54:15 2021 +0200
@@ -19,8 +19,8 @@
 
 # -- Project information -----------------------------------------------------
 
-project = u'SàT PubSub'
-copyright = u'2019, Jérôme Poisson'
+project = u'Libervia PubSub'
+copyright = u'2021, Jérôme Poisson'
 author = u'Jérôme Poisson'
 
 # The short X.Y version
@@ -128,7 +128,7 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'STPubSub.tex', u'SàT PubSub Documentation',
+    (master_doc, 'STPubSub.tex', u'Libervia PubSub Documentation',
      u'Jérôme Poisson', 'manual'),
 ]
 
@@ -138,7 +138,7 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'stpubsub', u'SàT PubSub Documentation',
+    (master_doc, 'stpubsub', u'Libervia PubSub Documentation',
      [author], 1)
 ]
 
@@ -149,7 +149,7 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'STPubSub', u'SàT PubSub Documentation',
+    (master_doc, 'STPubSub', u'Libervia PubSub Documentation',
      author, 'STPubSub', 'One line description of project.',
      'Miscellaneous'),
 ]
--- a/doc/installation.rst	Fri Oct 15 15:30:18 2021 +0200
+++ b/doc/installation.rst	Fri Oct 15 15:54:15 2021 +0200
@@ -2,20 +2,20 @@
 Installation
 ============
 
-This are the instructions to install SàT Pubsub.
+This are the instructions to install Libervia Pubsub.
 
 .. note::
 
-   SàT PubSub is not released yet and this documentation is work in progress
+   Libervia PubSub is not released yet and this documentation is work in progress
 
 .. note::
 
-    /!\\ Beware, if you're installing SàT Pubsub on a server already running in production,
+    /!\\ Beware, if you're installing Libervia Pubsub on a server already running in production,
     it will replace your legacy Pubsub service, meaning that everything stored there won't
     be available anymore (this includes, and is not limited to, bookmarks, encryption
     keys, blogs, etc.).
 
-    Be sure to save everything from your legacy Pubsub service before switching to SàT
+    Be sure to save everything from your legacy Pubsub service before switching to Libervia
     Pubsub.
 
     Migration scripts are not yet available, help is welcome to write them.
@@ -45,7 +45,7 @@
 
     sudo apt-get install postgresql python3-dev python3-venv python3-wheel mercurial
 
-Now go in a location where you can install SàT Pubsub, for instance your home directory::
+Now go in a location where you can install Libervia Pubsub, for instance your home directory::
 
     $ cd
 
@@ -79,15 +79,15 @@
 
 .. note::
 
-    until the release of SàT Pubsub ``0.4.0`` it is recommended to install dev version
+    until the release of Libervia Pubsub ``0.4.0`` it is recommended to install dev version
     with instructions above
 
-To install SàT PubSub we'll work in a virtual environment. On Debian and derivatives you
+To install Libervia PubSub we'll work in a virtual environment. On Debian and derivatives you
 should easily install dependencies with this::
 
     sudo apt-get install postgresql python3-dev python3-venv python3-wheel mercurial
 
-Now go in a location where you can install SàT Pubsub, for instance your home directory::
+Now go in a location where you can install Libervia Pubsub, for instance your home directory::
 
     $ cd
 
@@ -107,7 +107,7 @@
 Post Installation
 -----------------
 
-Once SàT Pubsub is installed, you'll need to create a PostgreSQL user, and create the
+Once Libervia Pubsub is installed, you'll need to create a PostgreSQL user, and create the
 database::
 
     % sudo -u postgres createuser -d -P $(whoami)
@@ -118,7 +118,7 @@
 Update
 ------
 
-If you have updated SàT Pubsub and the database schema has been changed, you may have a
+If you have updated Libervia Pubsub and the database schema has been changed, you may have a
 message indicating that your are using an outdated version.
 
 To update schema, just apply ``sat_pubsub_update_x_y.sql`` files where ``x`` is your
@@ -145,10 +145,10 @@
 Prosody Configuration
 ---------------------
 
-SàT PubSub can work with any XMPP server (which supports components), but if you want to
+Libervia PubSub can work with any XMPP server (which supports components), but if you want to
 use it as your PEP service, you need a server which supports `XEP-0355`_ and `XEP-0356`_.
 
-Below you'll find the instruction to use SàT PubSub as a PEP service with Prosody:
+Below you'll find the instruction to use Libervia PubSub as a PEP service with Prosody:
 
 -  add these two lines at the end of your ``prosody.cfg.lua`` file, adapting them to your XMPP
    server domain (virtual host) and selecting a password of your choice:
@@ -212,19 +212,22 @@
             filtering = {"node"};
             jid = "pubsub.<xmpp_domain>";
           },
-          ["http://jabber.org/protocol/pubsub"] = {
+            ["http://jabber.org/protocol/pubsub"] = {
             jid = "pubsub.<xmpp_domain>";
           },
-          ["http://jabber.org/protocol/pubsub#owner"] = {
+            ["http://jabber.org/protocol/pubsub#owner"] = {
             jid = "pubsub.<xmpp_domain>";
           },
-          ["https://salut-a-toi/protocol/schema:0"] = {
+            ["https://salut-a-toi/protocol/schema:0"] = {
             jid = "pubsub.<xmpp_domain>";
           },
-          ["http://jabber.org/protocol/disco#items:*"] = {
+            ["https://salut-a-toi.org/spec/pubsub_admin:0"] = {
             jid = "pubsub.<xmpp_domain>";
           },
-          ["https://salut-a-toi.org/spec/pubsub_admin:0"] = {
+            ["urn:xmpp:delegation:2:bare:disco#info:*"] = {
+            jid = "pubsub.<xmpp_domain>";
+          },
+            ["urn:xmpp:delegation:2:bare:disco#items:*"] = {
             jid = "pubsub.<xmpp_domain>";
           },
       }
@@ -238,8 +241,8 @@
 .. _XEP-0355: https://xmpp.org/extensions/xep-0355.html
 .. _XEP-0356: https://xmpp.org/extensions/xep-0356.html
 
-Running SàT PubSub
-------------------
+Running Libervia PubSub
+-----------------------
 
 The minimal example for running sat_pubsub is:
 
@@ -275,6 +278,5 @@
   twistd sat-pubsub --jid=pubsub.<your_xmpp_domain> --xmpp_pwd=<password>
 
 You can set your options in ``sat.conf`` which is the same file used as for Salut à Toi
-ecosystem. Please check backend ``configuration`` section for details. The SàT PubSub
+ecosystem. Please check backend ``configuration`` section for details. The Libervia PubSub
 options must be in ``[pubsub]`` section.
-