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.

README.md 2.57 KB
Newer Older
1
# Readme
Matt Traudt's avatar
Matt Traudt committed
2

3
[![Build Status](https://travis-ci.org/torproject/sbws.svg?branch=master)](https://travis-ci.org/https://travis-ci.org/torproject/sbws)
Matt Traudt's avatar
Matt Traudt committed
4

juga  's avatar
juga committed
5
Simple Bandwidth Scanner (called `sbws`) is a Tor bandwidth scanner that
6
generates bandwidth files to be used by Directory Authorities.
juga  's avatar
juga committed
7

8 9 10 11
The scanner measures the bandwidth of each relay in the Tor network
(except the directory authorities) by creating a two hops circuit
with the relay. It then measures the bandwidth by downloading data
from a destination Web Server and stores the measurements.
12

13 14 15 16
The generator read the measurements, aggregates, filters and
scales them using torflow's scaling method.
Then it generates a bandwidth list file that is read
by a directory authority to report relays’ bandwidth in its vote.
juga  's avatar
juga committed
17

juga  's avatar
juga committed
18 19 20 21 22
**WARNING**: This software is intended to be run by researchers using a test
Tor network, such as chutney or shadow, or by the Tor bandwidth authorities
on the public Tor network.
Please do not run this software on the public Tor network unless you are one
of the Tor bandwidth authorities, to avoid creating unnecessary traffic.
23

24 25
**ADVICE**: It is recommended to read this documentation at
[Read the Docs](https://sbws.rtfd.io). In
26 27
[Tor Project Gitlab](https://gitlab.torproject.org/tpo/network-health/sbws)
(tpo Gitlab) some links won't be properly rendered.
28 29 30 31 32
It can also be read after installing the Debian package ``sbws-doc`` in
``/usr/share/doc/sbws`` or after building it locally as explained in
``./docs/source/documenting.rst``.


33 34 35
Installing
------------

36
See [./INSTALL.rst](INSTALL.rst) (in local directory or tpo Gitlab) or
37
[INSTALL.html](INSTALL.html) (local build or Read the Docs).
38 39 40 41

Deploying and running
---------------------

42
See [./DEPLOY.rst](DEPLOY.rst) (in local directory or tpo Gitlab) or
43
[DEPLOY.html](DEPLOY.html) (local build or Read the Docs).
44 45 46 47

Changelog
--------------

48
See [./CHANGELOG.rst](CHANGELOG.rst) (in local directory or tpo Gitlab) or
49
[CHANGELOG.html](CHANGELOG.html)  (local build or Read the Docs).
50 51 52

Documentation
--------------
53

54
More extensive documentation can be found in the ``./docs`` directory,
55
and online at [sbws.rtfd.io](https://sbws.readthedocs.io).
Matt Traudt's avatar
Matt Traudt committed
56

57 58 59 60 61 62 63 64 65
## License

This work is in the public domain within the United States.

We waive copyright and related rights in the work worldwide through the
[CC0-1.0 license](https://creativecommons.org/publicdomain/zero/1.0).

You can find a copy of the CC0 Public Domain Dedication along with this
software in ./LICENSE.md
66 67 68

## Authors

69 70
See [./AUTHORS.md](AUTHORS.md) (in local directory or tpo Gitlab) or
[AUTHORS.html](AUTHORS.html) (local build or Read the Docs).