commit 0cf0b3477239515fa9652f99f0da2a9ecf6abc10 Merge: c537d47 ecb35bc Author: juga0 juga@riseup.net Date: Fri Dec 7 15:33:51 2018 +0000
Merge branch 'bug28649'
DEPLOY.rst | 19 ++++++++++++++++--- docs/source/config.rst | 4 ++-- .../examples/{config.example.ini => sbws.example.ini} | 4 +++- 3 files changed, 21 insertions(+), 6 deletions(-)
diff --cc DEPLOY.rst index afbdc5f,239aefa..e62e17f --- a/DEPLOY.rst +++ b/DEPLOY.rst @@@ -25,13 -25,24 +25,26 @@@ destination requirement scanner setup ----------------------
-Install sbws according to ``./INSTALL.rst`` (or `/INSTALL.rst </INSTALL.rst>`_ -or :ref:`install`). +Install sbws according to `<INSTALL.rst>`_ (in the local directory or GitHub) +or `<INSTALL.html>`_ (local build or Read the Docs).
- To configure destinations, create a configuration file according to + To run the ``scanner`` it is mandatory to create a configuration file with at + least one ``destination``. + + If ``sbws`` is installed from the Debian package, then create a file in + ``/etc/sbws/sbws.ini`` like in the following example: + + .. literalinclude:: /examples/sbws.example.ini + :caption: Example sbws.example.ini + + If ``sbws`` is installed from the sources as a non-root user then create the + file in ``~/.sbws.ini``. + + More details about the configuration file can be found in -``./docs/source/man_sbws.ini.rst`` (or `/docs/source/man_sbws.ini.rst <man_sbws.ini>`_ -or :doc:`man_sbws.ini` or ``man sbws.ini``) +``./docs/source/man_sbws.ini.rst`` (in the local directory or GitHub) or +`<man_sbws.ini.html>`_ (local build or Read the Docs) or - ``man sbws.ini`` (Debian). ++``man sbws.ini`` (system package).
-See also ``./docs/source/man_sbws.rst`` (or `/docs/source/man_sbws.rst <man_sbws>`_ or -:doc:`man_sbws` or ``man sbws``) manual page. +See also ``./docs/source/man_sbws.rst`` (in the local directory or GitHub) or - `<man_sbws.html>`_ (local build or Read the Docs) or ``man sbws`` (Debian). ++`<man_sbws.html>`_ (local build or Read the Docs) or ``man sbws`` (system ++package).
tor-commits@lists.torproject.org