Mercurial > libervia-pubsub

comparison doc/installation.rst @ 427:f6f4f99f1a1b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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 968091cea547
children 80aca1cf1543
comparison
equal deleted inserted replaced
426:6f8e1c180c83 427:f6f4f99f1a1b
45 45
46 And enter the following commands:: 46 And enter the following commands::
47 47
48 $ python3 -m venv env 48 $ python3 -m venv env
49 $ source env/bin/activate 49 $ source env/bin/activate
50 $ pip install wheel
50 $ pip install hg+https://repos.goffi.org/sat_pubsub 51 $ pip install hg+https://repos.goffi.org/sat_pubsub
51 52
52 .. note:: 53 .. note::
53 54
54 If your are installing from a local clone of the repository, it has been reported that 55 If your are installing from a local clone of the repository, it has been reported that
127 "privilege"; 128 "privilege";
128 } 129 }
129 [...] 130 [...]
130 VirtualHost "<xmpp_domain>" 131 VirtualHost "<xmpp_domain>"
131 privileged_entities = { 132 privileged_entities = {
132 ["sat-pubsub.<xmpp_domain>"] = { 133 ["pubsub.<xmpp_domain>"] = {
133 roster = "get"; 134 roster = "get";
134 message = "outgoing"; 135 message = "outgoing";
135 presence = "roster"; 136 presence = "roster";
136 }, 137 },
137 } 138 }
138 delegations = { 139 delegations = {
139 ["urn:xmpp:mam:2"] = { 140 ["urn:xmpp:mam:2"] = {
140 filtering = {"node"}; 141 filtering = {"node"};
141 jid = "sat-pubsub.<xmpp_domain>"; 142 jid = "pubsub.<xmpp_domain>";
142 }, 143 },
143 ["http://jabber.org/protocol/pubsub"] = { 144 ["http://jabber.org/protocol/pubsub"] = {
144 jid = "sat-pubsub.<xmpp_domain>"; 145 jid = "pubsub.<xmpp_domain>";
145 }, 146 },
146 ["http://jabber.org/protocol/pubsub#owner"] = { 147 ["http://jabber.org/protocol/pubsub#owner"] = {
147 jid = "sat-pubsub.<xmpp_domain>"; 148 jid = "pubsub.<xmpp_domain>";
148 }, 149 },
149 ["https://salut-a-toi/protocol/schema:0"] = { 150 ["https://salut-a-toi/protocol/schema:0"] = {
150 jid = "sat-pubsub.<xmpp_domain>"; 151 jid = "pubsub.<xmpp_domain>";
151 }, 152 },
152 ["http://jabber.org/protocol/disco#items:*"] = { 153 ["http://jabber.org/protocol/disco#items:*"] = {
153 jid = "sat-pubsub.<xmpp_domain>"; 154 jid = "pubsub.<xmpp_domain>";
154 }, 155 },
155 ["https://salut-a-toi.org/spec/pubsub_admin:0"] = { 156 ["https://salut-a-toi.org/spec/pubsub_admin:0"] = {
156 jid = "sat-pubsub.<xmpp_domain>"; 157 jid = "pubsub.<xmpp_domain>";
157 }, 158 },
158 } 159 }
159 160
160 Component "sat-pubsub.<xmpp_domain>" 161 Component "pubsub.<xmpp_domain>"
161 component_secret = "<password>" 162 component_secret = "<password>"
162 modules_enabled = {"delegation", "privilege"} 163 modules_enabled = {"delegation", "privilege"}
163 164
164 Of course, you still have to replace and adapt to your own settings. 165 Of course, you still have to replace and adapt to your own settings.
165 166
198 ``--xmpp_pwd`` 199 ``--xmpp_pwd``
199 the secret used to authenticate with the XMPP server. 200 the secret used to authenticate with the XMPP server.
200 201
201 For example:: 202 For example::
202 203
203 twistd sat-pubsub --jid=sat-pubsub.<your_xmpp_domain> --xmpp_pwd=<password> 204 twistd sat-pubsub --jid=pubsub.<your_xmpp_domain> --xmpp_pwd=<password>
204 205
205 You can set your options in ``sat.conf`` which is the same file used as for Salut à Toi 206 You can set your options in ``sat.conf`` which is the same file used as for Salut à Toi
206 ecosystem. Please check backend ``configuration`` section for details. The SàT PubSub 207 ecosystem. Please check backend ``configuration`` section for details. The SàT PubSub
207 options must be in ``[pubsub]`` section. 208 options must be in ``[pubsub]`` section.
208 209