Mercurial > libervia-pubsub
annotate doc/installation.rst @ 442:b38b8beac609
doc: better dev version instructions + update
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Fri, 19 Mar 2021 12:46:32 +0100 |
| parents | 80aca1cf1543 |
| children | 6cef8aa1c991 |
| rev | line source |
|---|---|
| 404 | 1 ============ |
| 2 Installation | |
| 3 ============ | |
| 4 | |
| 5 This are the instructions to install SàT Pubsub. | |
| 6 | |
| 7 .. note:: | |
| 8 | |
| 9 SàT PubSub is not released yet and this documentation is work in progress | |
| 10 | |
|
436
80aca1cf1543
doc: added a warning for people using SàT Pubsub on a server already used in production
Goffi <goffi@goffi.org>
parents:
427
diff
changeset
|
11 .. note:: |
|
80aca1cf1543
doc: added a warning for people using SàT Pubsub on a server already used in production
Goffi <goffi@goffi.org>
parents:
427
diff
changeset
|
12 |
|
442
b38b8beac609
doc: better dev version instructions + update
Goffi <goffi@goffi.org>
parents:
436
diff
changeset
|
13 /!\\ Beware, if you're installing SàT Pubsub on a server already running in production, |
|
436
80aca1cf1543
doc: added a warning for people using SàT Pubsub on a server already used in production
Goffi <goffi@goffi.org>
parents:
427
diff
changeset
|
14 it will replace your legacy Pubsub service, meaning that everything stored there won't |
|
80aca1cf1543
doc: added a warning for people using SàT Pubsub on a server already used in production
Goffi <goffi@goffi.org>
parents:
427
diff
changeset
|
15 be available anymore (this includes, and is not limited to, bookmarks, encryption |
|
80aca1cf1543
doc: added a warning for people using SàT Pubsub on a server already used in production
Goffi <goffi@goffi.org>
parents:
427
diff
changeset
|
16 keys, blogs, etc.). |
|
80aca1cf1543
doc: added a warning for people using SàT Pubsub on a server already used in production
Goffi <goffi@goffi.org>
parents:
427
diff
changeset
|
17 |
|
80aca1cf1543
doc: added a warning for people using SàT Pubsub on a server already used in production
Goffi <goffi@goffi.org>
parents:
427
diff
changeset
|
18 Be sure to save everything from your legacy Pubsub service before switching to SàT |
|
80aca1cf1543
doc: added a warning for people using SàT Pubsub on a server already used in production
Goffi <goffi@goffi.org>
parents:
427
diff
changeset
|
19 Pubsub. |
|
80aca1cf1543
doc: added a warning for people using SàT Pubsub on a server already used in production
Goffi <goffi@goffi.org>
parents:
427
diff
changeset
|
20 |
|
80aca1cf1543
doc: added a warning for people using SàT Pubsub on a server already used in production
Goffi <goffi@goffi.org>
parents:
427
diff
changeset
|
21 Migration scripts are not yet available, help is welcome to write them. |
|
80aca1cf1543
doc: added a warning for people using SàT Pubsub on a server already used in production
Goffi <goffi@goffi.org>
parents:
427
diff
changeset
|
22 |
| 404 | 23 |
| 24 Requirements | |
| 25 ------------ | |
| 26 | |
|
421
f124ed5ea78b
doc: remove python2 references + added a warning for `python setup.py install`
Goffi <goffi@goffi.org>
parents:
409
diff
changeset
|
27 - Python 3.7+ |
|
425
968091cea547
doc: installation instructions corrections
Goffi <goffi@goffi.org>
parents:
421
diff
changeset
|
28 - Python 3 "venv", which may be installed with Python 3 |
|
968091cea547
doc: installation instructions corrections
Goffi <goffi@goffi.org>
parents:
421
diff
changeset
|
29 - Mercurial |
| 404 | 30 - A XMPP server that supports the component protocol (XEP-0114), |
| 31 and, to enable the micro-blogging feature, Namespace Delegation (XEP-0355) | |
| 32 and privileged entity (XEP-0356) are needed. | |
| 33 We recommend using Prosody with mod_privilege and mod_delegation modules (those modules | |
| 34 are maintained by us). | |
| 35 | |
| 36 For the PostgreSQL backend, the following is also required: | |
| 37 | |
| 38 - PostgreSQL >= 9.5 (including development files for psycopg2) | |
|
442
b38b8beac609
doc: better dev version instructions + update
Goffi <goffi@goffi.org>
parents:
436
diff
changeset
|
39 |
|
b38b8beac609
doc: better dev version instructions + update
Goffi <goffi@goffi.org>
parents:
436
diff
changeset
|
40 Installation of dev version |
|
b38b8beac609
doc: better dev version instructions + update
Goffi <goffi@goffi.org>
parents:
436
diff
changeset
|
41 --------------------------- |
|
b38b8beac609
doc: better dev version instructions + update
Goffi <goffi@goffi.org>
parents:
436
diff
changeset
|
42 |
|
b38b8beac609
doc: better dev version instructions + update
Goffi <goffi@goffi.org>
parents:
436
diff
changeset
|
43 First install system requirements. On a Debian system or derivative, you can use following |
|
b38b8beac609
doc: better dev version instructions + update
Goffi <goffi@goffi.org>
parents:
436
diff
changeset
|
44 instructions:: |
|
b38b8beac609
doc: better dev version instructions + update
Goffi <goffi@goffi.org>
parents:
436
diff
changeset
|
45 |
|
b38b8beac609
doc: better dev version instructions + update
Goffi <goffi@goffi.org>
parents:
436
diff
changeset
|
46 sudo apt-get install postgresql python3-dev python3-venv python3-wheel mercurial |
|
b38b8beac609
doc: better dev version instructions + update
Goffi <goffi@goffi.org>
parents:
436
diff
changeset
|
47 |
|
b38b8beac609
doc: better dev version instructions + update
Goffi <goffi@goffi.org>
parents:
436
diff
changeset
|
48 Now go in a location where you can install SàT Pubsub, for instance your home directory:: |
|
b38b8beac609
doc: better dev version instructions + update
Goffi <goffi@goffi.org>
parents:
436
diff
changeset
|
49 |
|
b38b8beac609
doc: better dev version instructions + update
Goffi <goffi@goffi.org>
parents:
436
diff
changeset
|
50 $ cd |
|
b38b8beac609
doc: better dev version instructions + update
Goffi <goffi@goffi.org>
parents:
436
diff
changeset
|
51 |
|
b38b8beac609
doc: better dev version instructions + update
Goffi <goffi@goffi.org>
parents:
436
diff
changeset
|
52 You'll need to create and activate a Python virtual environment:: |
|
b38b8beac609
doc: better dev version instructions + update
Goffi <goffi@goffi.org>
parents:
436
diff
changeset
|
53 |
|
b38b8beac609
doc: better dev version instructions + update
Goffi <goffi@goffi.org>
parents:
436
diff
changeset
|
54 $ python3 -m venv pubsub-venv |
|
b38b8beac609
doc: better dev version instructions + update
Goffi <goffi@goffi.org>
parents:
436
diff
changeset
|
55 $ source pubsub-venv/bin/activate |
|
b38b8beac609
doc: better dev version instructions + update
Goffi <goffi@goffi.org>
parents:
436
diff
changeset
|
56 $ pip install -U pip wheel |
|
b38b8beac609
doc: better dev version instructions + update
Goffi <goffi@goffi.org>
parents:
436
diff
changeset
|
57 |
|
b38b8beac609
doc: better dev version instructions + update
Goffi <goffi@goffi.org>
parents:
436
diff
changeset
|
58 Then you need to clone the repository:: |
|
b38b8beac609
doc: better dev version instructions + update
Goffi <goffi@goffi.org>
parents:
436
diff
changeset
|
59 |
|
b38b8beac609
doc: better dev version instructions + update
Goffi <goffi@goffi.org>
parents:
436
diff
changeset
|
60 $ hg clone https://repos.goffi.org/sat_pubsub && cd sat_pubsub |
|
b38b8beac609
doc: better dev version instructions + update
Goffi <goffi@goffi.org>
parents:
436
diff
changeset
|
61 |
|
b38b8beac609
doc: better dev version instructions + update
Goffi <goffi@goffi.org>
parents:
436
diff
changeset
|
62 Now you can install requirements:: |
|
b38b8beac609
doc: better dev version instructions + update
Goffi <goffi@goffi.org>
parents:
436
diff
changeset
|
63 |
|
b38b8beac609
doc: better dev version instructions + update
Goffi <goffi@goffi.org>
parents:
436
diff
changeset
|
64 $ pip install -r requirements.txt |
|
b38b8beac609
doc: better dev version instructions + update
Goffi <goffi@goffi.org>
parents:
436
diff
changeset
|
65 |
|
b38b8beac609
doc: better dev version instructions + update
Goffi <goffi@goffi.org>
parents:
436
diff
changeset
|
66 And that's it! Please refer to :ref:`post_installation` to initialize database. |
| 404 | 67 |
| 68 Installation From Sources | |
| 69 ------------------------- | |
| 70 | |
|
442
b38b8beac609
doc: better dev version instructions + update
Goffi <goffi@goffi.org>
parents:
436
diff
changeset
|
71 .. note:: |
|
b38b8beac609
doc: better dev version instructions + update
Goffi <goffi@goffi.org>
parents:
436
diff
changeset
|
72 |
|
b38b8beac609
doc: better dev version instructions + update
Goffi <goffi@goffi.org>
parents:
436
diff
changeset
|
73 until the release of SàT Pubsub ``0.4.0`` it is recommended to install dev version |
|
b38b8beac609
doc: better dev version instructions + update
Goffi <goffi@goffi.org>
parents:
436
diff
changeset
|
74 with instructions above |
|
b38b8beac609
doc: better dev version instructions + update
Goffi <goffi@goffi.org>
parents:
436
diff
changeset
|
75 |
| 404 | 76 To install SàT PubSub we'll work in a virtual environment. On Debian and derivatives you |
| 77 should easily install dependencies with this:: | |
| 78 | |
|
425
968091cea547
doc: installation instructions corrections
Goffi <goffi@goffi.org>
parents:
421
diff
changeset
|
79 sudo apt-get install postgresql python3-dev python3-venv python3-wheel mercurial |
| 404 | 80 |
| 81 Now go in a location where you can install SàT Pubsub, for instance your home directory:: | |
| 82 | |
| 83 $ cd | |
| 84 | |
|
421
f124ed5ea78b
doc: remove python2 references + added a warning for `python setup.py install`
Goffi <goffi@goffi.org>
parents:
409
diff
changeset
|
85 And enter the following commands:: |
| 404 | 86 |
|
421
f124ed5ea78b
doc: remove python2 references + added a warning for `python setup.py install`
Goffi <goffi@goffi.org>
parents:
409
diff
changeset
|
87 $ python3 -m venv env |
| 404 | 88 $ source env/bin/activate |
|
442
b38b8beac609
doc: better dev version instructions + update
Goffi <goffi@goffi.org>
parents:
436
diff
changeset
|
89 $ pip install -U pip wheel |
|
b38b8beac609
doc: better dev version instructions + update
Goffi <goffi@goffi.org>
parents:
436
diff
changeset
|
90 $ pip install sat-pubsub |
| 404 | 91 |
|
421
f124ed5ea78b
doc: remove python2 references + added a warning for `python setup.py install`
Goffi <goffi@goffi.org>
parents:
409
diff
changeset
|
92 .. note:: |
|
f124ed5ea78b
doc: remove python2 references + added a warning for `python setup.py install`
Goffi <goffi@goffi.org>
parents:
409
diff
changeset
|
93 |
|
f124ed5ea78b
doc: remove python2 references + added a warning for `python setup.py install`
Goffi <goffi@goffi.org>
parents:
409
diff
changeset
|
94 If your are installing from a local clone of the repository, it has been reported that |
|
f124ed5ea78b
doc: remove python2 references + added a warning for `python setup.py install`
Goffi <goffi@goffi.org>
parents:
409
diff
changeset
|
95 installation with ``python setup.py install`` is not working properly. Please use ``pip |
|
f124ed5ea78b
doc: remove python2 references + added a warning for `python setup.py install`
Goffi <goffi@goffi.org>
parents:
409
diff
changeset
|
96 install .`` instead. |
|
f124ed5ea78b
doc: remove python2 references + added a warning for `python setup.py install`
Goffi <goffi@goffi.org>
parents:
409
diff
changeset
|
97 |
|
442
b38b8beac609
doc: better dev version instructions + update
Goffi <goffi@goffi.org>
parents:
436
diff
changeset
|
98 .. _post_installation: |
|
421
f124ed5ea78b
doc: remove python2 references + added a warning for `python setup.py install`
Goffi <goffi@goffi.org>
parents:
409
diff
changeset
|
99 |
| 404 | 100 Post Installation |
| 101 ----------------- | |
| 102 | |
| 103 Once SàT Pubsub is installed, you'll need to create a PostgreSQL user, and create the | |
| 104 database:: | |
| 105 | |
|
425
968091cea547
doc: installation instructions corrections
Goffi <goffi@goffi.org>
parents:
421
diff
changeset
|
106 % sudo -u postgres createuser -d -P $(whoami) |
|
968091cea547
doc: installation instructions corrections
Goffi <goffi@goffi.org>
parents:
421
diff
changeset
|
107 % createdb pubsub |
| 404 | 108 % cd /tmp && wget https://repos.goffi.org/sat_pubsub/raw-file/tip/db/pubsub.sql |
|
425
968091cea547
doc: installation instructions corrections
Goffi <goffi@goffi.org>
parents:
421
diff
changeset
|
109 % psql pubsub < pubsub.sql |
| 404 | 110 |
|
442
b38b8beac609
doc: better dev version instructions + update
Goffi <goffi@goffi.org>
parents:
436
diff
changeset
|
111 Update |
|
b38b8beac609
doc: better dev version instructions + update
Goffi <goffi@goffi.org>
parents:
436
diff
changeset
|
112 ------ |
|
b38b8beac609
doc: better dev version instructions + update
Goffi <goffi@goffi.org>
parents:
436
diff
changeset
|
113 |
|
b38b8beac609
doc: better dev version instructions + update
Goffi <goffi@goffi.org>
parents:
436
diff
changeset
|
114 If you have updated SàT Pubsub and the database schema has been changed, you may have a |
|
b38b8beac609
doc: better dev version instructions + update
Goffi <goffi@goffi.org>
parents:
436
diff
changeset
|
115 message indicating that your are using an outdated version. |
|
b38b8beac609
doc: better dev version instructions + update
Goffi <goffi@goffi.org>
parents:
436
diff
changeset
|
116 |
|
b38b8beac609
doc: better dev version instructions + update
Goffi <goffi@goffi.org>
parents:
436
diff
changeset
|
117 To update schema, just apply ``sat_pubsub_update_x_y.sql`` files where ``x`` is your |
|
b38b8beac609
doc: better dev version instructions + update
Goffi <goffi@goffi.org>
parents:
436
diff
changeset
|
118 current version, and ``y`` is the one to update. If you are several versions late, just |
|
b38b8beac609
doc: better dev version instructions + update
Goffi <goffi@goffi.org>
parents:
436
diff
changeset
|
119 apply updates one by one. |
|
b38b8beac609
doc: better dev version instructions + update
Goffi <goffi@goffi.org>
parents:
436
diff
changeset
|
120 |
|
b38b8beac609
doc: better dev version instructions + update
Goffi <goffi@goffi.org>
parents:
436
diff
changeset
|
121 For instance, if you have the following message:: |
|
b38b8beac609
doc: better dev version instructions + update
Goffi <goffi@goffi.org>
parents:
436
diff
changeset
|
122 |
|
b38b8beac609
doc: better dev version instructions + update
Goffi <goffi@goffi.org>
parents:
436
diff
changeset
|
123 ERROR:root:Bad database schema version (7), please upgrade to 8 |
|
b38b8beac609
doc: better dev version instructions + update
Goffi <goffi@goffi.org>
parents:
436
diff
changeset
|
124 |
|
b38b8beac609
doc: better dev version instructions + update
Goffi <goffi@goffi.org>
parents:
436
diff
changeset
|
125 Go to ``db`` directory and enter update instruction:: |
|
b38b8beac609
doc: better dev version instructions + update
Goffi <goffi@goffi.org>
parents:
436
diff
changeset
|
126 |
|
b38b8beac609
doc: better dev version instructions + update
Goffi <goffi@goffi.org>
parents:
436
diff
changeset
|
127 $ cd db |
|
b38b8beac609
doc: better dev version instructions + update
Goffi <goffi@goffi.org>
parents:
436
diff
changeset
|
128 $ psql pubsub < sat_pubsub_update_7_8.sql |
|
b38b8beac609
doc: better dev version instructions + update
Goffi <goffi@goffi.org>
parents:
436
diff
changeset
|
129 |
|
b38b8beac609
doc: better dev version instructions + update
Goffi <goffi@goffi.org>
parents:
436
diff
changeset
|
130 .. note:: |
|
b38b8beac609
doc: better dev version instructions + update
Goffi <goffi@goffi.org>
parents:
436
diff
changeset
|
131 |
|
b38b8beac609
doc: better dev version instructions + update
Goffi <goffi@goffi.org>
parents:
436
diff
changeset
|
132 Before any update and specially if there is a schema change, you should backup your |
|
b38b8beac609
doc: better dev version instructions + update
Goffi <goffi@goffi.org>
parents:
436
diff
changeset
|
133 database. If anything goes wrong, it will be your best chance to avoid any data loss. |
|
b38b8beac609
doc: better dev version instructions + update
Goffi <goffi@goffi.org>
parents:
436
diff
changeset
|
134 |
| 404 | 135 |
| 136 .. _prosody_configuration: | |
| 137 | |
| 138 Prosody Configuration | |
| 139 --------------------- | |
| 140 | |
| 141 SàT PubSub can work with any XMPP server (which supports components), but if you want to | |
| 142 use it as your PEP service, you need a server which supports `XEP-0355`_ and `XEP-0356`_. | |
| 143 | |
| 144 Below you'll find the instruction to use SàT PubSub as a PEP service with Prosody: | |
| 145 | |
| 146 - add these two lines at the end of your ``prosody.cfg.lua`` file, adapting them to your XMPP | |
| 147 server domain (virtual host) and selecting a password of your choice: | |
| 148 | |
| 149 .. sourcecode:: lua | |
| 150 | |
|
425
968091cea547
doc: installation instructions corrections
Goffi <goffi@goffi.org>
parents:
421
diff
changeset
|
151 Component "pubsub.<xmpp_domain>" |
| 404 | 152 component_secret = "<password>" |
| 153 | |
| 154 - there are extra steps to enable the micro-blogging feature with Prosody. Please follow | |
| 155 the installation and configuration instructions that are given on these pages: | |
| 156 | |
| 157 - https://modules.prosody.im/mod_delegation.html | |
| 158 - https://modules.prosody.im/mod_privilege.html | |
| 159 | |
| 160 To keep your modules up to date, we recommend to clone the full modules | |
| 161 repository and then to symlink them like that: | |
| 162 | |
| 163 .. sourcecode:: shell | |
| 164 | |
| 165 % cd /path/to/install_dir | |
| 166 % hg clone https://hg.prosody.im/prosody-modules | |
| 167 % cd /path/to/prosody_plugins | |
| 168 % ln -sf /path/to/install_dir/prosody-modules/mod_delegation ./ | |
| 169 % ln -sf /path/to/install_dir/prosody-modules/mod_privilege ./ | |
| 170 | |
| 171 Or course, you have to adapt ``/path/to/install_dir`` to the directory where you want to | |
| 172 install the modules, and ``/path/to/prosody_plugins`` to the directory where prosody | |
| 173 modules are installed (hint: check ``prosodyctl about`` to find the latter). The ``ln`` | |
| 174 commands may have to be run as root depending on your installation. | |
| 175 | |
| 176 Once your symlinks are set, to update the modules we just need to type this: | |
| 177 | |
| 178 .. sourcecode:: shell | |
| 179 | |
|
425
968091cea547
doc: installation instructions corrections
Goffi <goffi@goffi.org>
parents:
421
diff
changeset
|
180 % cd /path/to/install_dir/prosody-modules |
|
968091cea547
doc: installation instructions corrections
Goffi <goffi@goffi.org>
parents:
421
diff
changeset
|
181 % hg pull -u |
| 404 | 182 |
| 183 Here is an example of how your ``prosody.cfg.lua`` should look like with | |
| 184 ``mod_delegation`` and ``mod_privilege`` activated: | |
| 185 | |
| 186 .. sourcecode:: lua | |
| 187 | |
| 188 [...] | |
| 189 modules_enabled = { | |
| 190 [...] | |
| 191 "delegation"; | |
| 192 "privilege"; | |
| 193 } | |
| 194 [...] | |
| 195 VirtualHost "<xmpp_domain>" | |
| 196 privileged_entities = { | |
|
427
f6f4f99f1a1b
doc: explicite "wheel" installation + renamed "sat-pubsub.*" jids to simpler "pubsub.*"
Goffi <goffi@goffi.org>
parents:
425
diff
changeset
|
197 ["pubsub.<xmpp_domain>"] = { |
| 404 | 198 roster = "get"; |
| 199 message = "outgoing"; | |
| 200 presence = "roster"; | |
| 201 }, | |
| 202 } | |
| 203 delegations = { | |
| 204 ["urn:xmpp:mam:2"] = { | |
| 205 filtering = {"node"}; | |
|
427
f6f4f99f1a1b
doc: explicite "wheel" installation + renamed "sat-pubsub.*" jids to simpler "pubsub.*"
Goffi <goffi@goffi.org>
parents:
425
diff
changeset
|
206 jid = "pubsub.<xmpp_domain>"; |
| 404 | 207 }, |
| 208 ["http://jabber.org/protocol/pubsub"] = { | |
|
427
f6f4f99f1a1b
doc: explicite "wheel" installation + renamed "sat-pubsub.*" jids to simpler "pubsub.*"
Goffi <goffi@goffi.org>
parents:
425
diff
changeset
|
209 jid = "pubsub.<xmpp_domain>"; |
| 404 | 210 }, |
| 211 ["http://jabber.org/protocol/pubsub#owner"] = { | |
|
427
f6f4f99f1a1b
doc: explicite "wheel" installation + renamed "sat-pubsub.*" jids to simpler "pubsub.*"
Goffi <goffi@goffi.org>
parents:
425
diff
changeset
|
212 jid = "pubsub.<xmpp_domain>"; |
| 404 | 213 }, |
| 214 ["https://salut-a-toi/protocol/schema:0"] = { | |
|
427
f6f4f99f1a1b
doc: explicite "wheel" installation + renamed "sat-pubsub.*" jids to simpler "pubsub.*"
Goffi <goffi@goffi.org>
parents:
425
diff
changeset
|
215 jid = "pubsub.<xmpp_domain>"; |
| 404 | 216 }, |
| 217 ["http://jabber.org/protocol/disco#items:*"] = { | |
|
427
f6f4f99f1a1b
doc: explicite "wheel" installation + renamed "sat-pubsub.*" jids to simpler "pubsub.*"
Goffi <goffi@goffi.org>
parents:
425
diff
changeset
|
218 jid = "pubsub.<xmpp_domain>"; |
| 404 | 219 }, |
| 220 ["https://salut-a-toi.org/spec/pubsub_admin:0"] = { | |
|
427
f6f4f99f1a1b
doc: explicite "wheel" installation + renamed "sat-pubsub.*" jids to simpler "pubsub.*"
Goffi <goffi@goffi.org>
parents:
425
diff
changeset
|
221 jid = "pubsub.<xmpp_domain>"; |
| 404 | 222 }, |
| 223 } | |
| 224 | |
|
427
f6f4f99f1a1b
doc: explicite "wheel" installation + renamed "sat-pubsub.*" jids to simpler "pubsub.*"
Goffi <goffi@goffi.org>
parents:
425
diff
changeset
|
225 Component "pubsub.<xmpp_domain>" |
| 404 | 226 component_secret = "<password>" |
| 227 modules_enabled = {"delegation", "privilege"} | |
| 228 | |
| 229 Of course, you still have to replace and adapt to your own settings. | |
| 230 | |
| 231 .. _XEP-0355: https://xmpp.org/extensions/xep-0355.html | |
| 232 .. _XEP-0356: https://xmpp.org/extensions/xep-0356.html | |
| 233 | |
| 234 Running SàT PubSub | |
| 235 ------------------ | |
| 236 | |
| 237 The minimal example for running sat_pubsub is: | |
| 238 | |
|
425
968091cea547
doc: installation instructions corrections
Goffi <goffi@goffi.org>
parents:
421
diff
changeset
|
239 % twistd sat-pubsub |
| 404 | 240 |
| 241 This will start the service and run it in the background. It generates a | |
| 242 file twistd.pid that holds the PID of the service and a log file twistd.log. | |
| 243 The twistd utility has a fair number of options that might be useful, and | |
| 244 can be viewed with: | |
| 245 | |
| 246 % twistd --help | |
| 247 | |
| 248 When the service starts, it will connect to the XMPP server at the local machine using the | |
| 249 component protocol, and assumes the JID ``pubsub``. This assumes a couple of defaults | |
| 250 which can be overridden by passing parameters to the twistd plugin. You can get an | |
| 251 overview of the parameters and their defaults using: | |
| 252 | |
|
425
968091cea547
doc: installation instructions corrections
Goffi <goffi@goffi.org>
parents:
421
diff
changeset
|
253 % twistd sat-pubsub --help |
| 404 | 254 |
| 255 In particular, the following parameters will be of interest: | |
| 256 | |
| 257 ``--jid`` | |
| 258 The Jabber ID the component will assume. | |
| 259 | |
| 260 ``--rport`` | |
| 261 the port number of the XMPP server to connect to | |
| 262 | |
| 263 ``--xmpp_pwd`` | |
| 264 the secret used to authenticate with the XMPP server. | |
| 265 | |
| 266 For example:: | |
| 267 | |
|
427
f6f4f99f1a1b
doc: explicite "wheel" installation + renamed "sat-pubsub.*" jids to simpler "pubsub.*"
Goffi <goffi@goffi.org>
parents:
425
diff
changeset
|
268 twistd sat-pubsub --jid=pubsub.<your_xmpp_domain> --xmpp_pwd=<password> |
| 404 | 269 |
| 270 You can set your options in ``sat.conf`` which is the same file used as for Salut à Toi | |
| 271 ecosystem. Please check backend ``configuration`` section for details. The SàT PubSub | |
| 272 options must be in ``[pubsub]`` section. | |
| 273 |