README.md 1.91 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
juga's avatar
juga committed
6
7
produces bandwidth measurements files to be used by Directory Authorities.

Matt Traudt's avatar
Matt Traudt committed
8
The scanner builds two hop circuits consisting of the relay being measured and
juga's avatar
juga committed
9
10
11
12
13
14
a fast exit. Over these circuits it measures RTT and bandwidth.

**WARNING**: This software is *only* intended to be run by Tor directory
authorities or researches using a test Tor network, chutney or shadow.
Please, do not run this software otherwise, since the measurements would not be
used by Tor and would only create more traffic in the Tor network.
15

16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
`sbws` will be considered production ready when version 1.0.0 will be released.

Installing
------------

See ./INSTALL.rst (or  [INSTALL](./INSTALL.rst) or [INSTALL](./INSTALL.html) )

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

See ./DEPLOY.rst (or  [DEPLOY](./DEPLOY.rst) or [DEPLOY](./DEPLOY.html) )

Contributing
--------------

See ./CONTRIBUTING.rst (or  [CONTRIBUTING](./CONTRIBUTING.rst) or
[CONTRIBUTING](./CONTRIBUTING.html) )

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

See ./CHANGELOG.rst (or  [CHANGELOG](./CHANGELOG.rst) or
[CHANGELOG](./CHANGELOG.html) )

Documentation
--------------
42

43
More extensive documentation can be found in the ./docs directory,
44
and online at [sbws.rtfd.io](https://sbws.readthedocs.io) and
Matt Traudt's avatar
Matt Traudt committed
45
46
47
[this onion service](http://d7pxflytfsmz6uh3x7i2jxzzwea6nbpmtsz5tmfkcin5edapaig5vpyd.onion/)
([v2](http://sdmb3rfvp3wadu6y.onion/)).

juga's avatar
juga committed
48
49
50
51
52
53
54
55
56
## 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
juga's avatar
juga committed
57
58
59

## Authors

60
See ./AUTHORS.md (or  [AUTHORS](./AUTHORS.MD)