Mercurial > libervia-pubsub
diff doc/installation.rst @ 425:968091cea547
doc: installation instructions corrections
author | Goffi <goffi@goffi.org> |
---|---|
date | Sun, 13 Sep 2020 15:51:32 +0200 |
parents | f124ed5ea78b |
children | f6f4f99f1a1b |
line wrap: on
line diff
--- a/doc/installation.rst Sat Aug 15 22:53:53 2020 +0200 +++ b/doc/installation.rst Sun Sep 13 15:51:32 2020 +0200 @@ -13,6 +13,8 @@ ------------ - Python 3.7+ +- Python 3 "venv", which may be installed with Python 3 +- Mercurial - Twisted >= 15.2.0: - Twisted Core - Twisted Words @@ -35,7 +37,7 @@ To install SàT PubSub we'll work in a virtual environment. On Debian and derivatives you should easily install dependencies with this:: - sudo apt-get install postgresql python-dev mercurial virtualenv + 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:: @@ -60,10 +62,10 @@ Once SàT Pubsub is installed, you'll need to create a PostgreSQL user, and create the database:: - % sudo -u postgres createuser -d -P $(whoami) - % createdb pubsub + % sudo -u postgres createuser -d -P $(whoami) + % createdb pubsub % cd /tmp && wget https://repos.goffi.org/sat_pubsub/raw-file/tip/db/pubsub.sql - % psql pubsub < pubsub.sql + % psql pubsub < pubsub.sql .. _prosody_configuration: @@ -81,7 +83,7 @@ .. sourcecode:: lua - Component "sat-pubsub.<xmpp_domain>" + Component "pubsub.<xmpp_domain>" component_secret = "<password>" - there are extra steps to enable the micro-blogging feature with Prosody. Please follow @@ -110,8 +112,8 @@ .. sourcecode:: shell - % cd /path/to/install_dir/prosody-modules - % hg pull -u + % cd /path/to/install_dir/prosody-modules + % hg pull -u Here is an example of how your ``prosody.cfg.lua`` should look like with ``mod_delegation`` and ``mod_privilege`` activated: @@ -169,7 +171,7 @@ The minimal example for running sat_pubsub is: - % twistd sat_pubsub + % twistd sat-pubsub This will start the service and run it in the background. It generates a file twistd.pid that holds the PID of the service and a log file twistd.log. @@ -183,7 +185,7 @@ which can be overridden by passing parameters to the twistd plugin. You can get an overview of the parameters and their defaults using: - % twistd sat_pubsub --help + % twistd sat-pubsub --help In particular, the following parameters will be of interest: @@ -198,7 +200,7 @@ For example:: - twistd sat_pubsub --jid=sat-pubsub.<your_xmpp_domain> --xmpp_pwd=<password> + twistd sat-pubsub --jid=sat-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