GitLab is used only for code review, issue tracking and project management. Canonical locations for source code are still https://gitweb.torproject.org/ https://git.torproject.org/ and git-rw.torproject.org.

Commit c5fe10e4 authored by Georg Koppen's avatar Georg Koppen

Merge remote-tracking branch 'gitlab/merge-requests/13' into maint-1.1

parents 3e86fd59 e8a5d80b
......@@ -30,6 +30,9 @@ destination requirements
- Bandwidth: at least 12.5MB/s (100 Mbit/s).
- Network traffic: around 12-15GB/day.
If possible, use a `Content delivery network`_ (CDN) in order to make the
destination IP closer to the scanner exit.
scanner setup
----------------------
......@@ -38,17 +41,20 @@ or `<INSTALL.html>`_ (local build or Read the Docs).
To run the ``scanner`` it is mandatory to create a configuration file with at
least one ``destination``.
It is recommended to set several ``destination``s so that the ``scanner`` can
It is recommended to set several ``destinations`` so that the ``scanner`` can
continue if one fails.
If ``sbws`` is installed from the Debian package, then create a file in
``/etc/sbws/sbws.ini`` like in the following example:
If ``sbws`` is installed from the Debian package, then create the configuration
file in ``/etc/sbws/sbws.ini``.
You can see an example with all the possible options here, note that you don't
need to include all of that and that everything that starts with ``#`` and
``;`` is a comment:
.. 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``.
configuration file in ``~/.sbws.ini``.
More details about the configuration file can be found in
``./docs/source/man_sbws.ini.rst`` (in the local directory or GitHub) or
......@@ -58,3 +64,5 @@ More details about the configuration file can be found in
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`` (system
package).
.. _Content delivery network: https://en.wikipedia.org/wiki/Content_delivery_network
......@@ -3,10 +3,9 @@
Installing Simple Bandwidth Scanner
===================================
The recommended method is to install it from your system
distribution.
The recommended method is to install it from your system package manager.
In Debian/Ubuntu systems::
In Debian_/Ubuntu_ systems::
sudo apt install sbws
......@@ -14,19 +13,17 @@ To install also the documentation::
sudo apt install sbws-doc
You might need to check in which releases is the package available.
There is a port_ for FreeBSD.
Continue reading to install ``sbws`` in other ways.
System requirements
--------------------
- Tor (last stable version is recommended)
- Python 3 (>= 3.5)
- virtualenv_ (while there is not ``stem`` release > 1.6.0, it is
recommended to install the required python dependencies in a virtualenv)
In Debian::
sudo apt install tor python3 virtualenv
- Python 3 (>= 3.6)
Python dependencies
--------------------
......@@ -34,9 +31,34 @@ Python dependencies
- Stem_ >= 1.7.0
- Requests_ (with socks_ support) >= 2.10.0
To install the Python dependencies, create a ``virtualenv`` first
It is recommend to install the dependencies from your system package manager.
If that is not possible, because the Python dependencies are not available in
your system, you can install them from their sources.
We only recommend using pip_ for development or testing.
::
Installing sbws from source
---------------------------
Clone ``sbws``::
git clone https://git.torproject.org/sbws.git
git checkout maint-1.1
The branch ``maint-1.1`` is the last stable version and the one that should be
used in production.
and install it::
cd sbws
python3 setup.py install
Installing sbws for development or testing
------------------------------------------
If you use pip_, it is recommended to use virtualenv_, to avoid having
different versions of the same libraries in your system.
To create a ``virtualenv``::
virtualenv venv -p /usr/bin/python3
source venv/bin/activate
......@@ -47,7 +69,10 @@ Clone ``sbws``::
Install the python dependencies::
cd sbws && pip install .
cd sbws && pip install -e .
Configuration and deployment
----------------------------
``sbws`` needs :term:`destination` s to request files from.
......@@ -59,7 +84,7 @@ System physical requirements
-----------------------------
- Bandwidth: at least 12.5MB/s (100 Mbit/s).
- Free RAM: at least 1.5GB
- Free RAM: at least 2GB
- Free disk: at least 3GB
``sbws`` and its dependencies need around 20MB of disk space.
......@@ -91,3 +116,7 @@ are 10MB and it will keep 50 rotated log files.
.. _pytest: https://docs.pytest.org/
.. _tox: https://tox.readthedocs.io
.. _Coverage: https://coverage.readthedocs.io/
.. _port: https://www.freshports.org/net/py-sbws/
.. _Debian: https://packages.debian.org/search?keywords=sbws&searchon=names&suite=all&section=all
.. _Ubuntu: https://packages.ubuntu.com/search?keywords=sbws&searchon=names&suite=all&section=all
.. _pip: https://pypi.org/project/pip/
......@@ -51,8 +51,11 @@ setup(
'Intended Audience :: Developers',
'Intended Audience :: System Administrators',
'Operating System :: OS Independent',
'Programming Language :: Python :: 3.5',
'Programming Language :: Python :: 3',
'Programming Language :: Python :: 3.6',
'Programming Language :: Python :: 3.7',
'Programming Language :: Python :: 3.8',
'Programming Language :: Python :: 3.9',
'Topic :: System :: Networking',
],
packages=find_packages(),
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment