Skip to content
This repository has been archived by the owner on May 4, 2021. It is now read-only.

torproject/sbws

Repository files navigation

Readme

Build Status

Simple Bandwidth Scanner (called sbws) is a Tor bandwidth scanner that produces bandwidth files to be used by Directory Authorities.

The scanner builds two hop circuits consisting of the relay being measured and a fast exit. Over these circuits it measures bandwidth and store the results.

The generator read the measurement results, scales them using torflow's scaling method and creates the bandwidth file.

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.

ADVICE: It is recommended to read this documentation at Read the Docs. In Github some links won't be properly rendered. 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.

Installing

See ./INSTALL.rst (in local directory or GitHub) or INSTALL.html (local build or Read the Docs).

Deploying and running

See ./DEPLOY.rst (in local directory or GitHub) or DEPLOY.html (local build or Read the Docs).

Contributing

See ./CONTRIBUTING.rst (in local directory or GitHub) or CONTRIBUTING.html (local build or Read the Docs).

Changelog

See ./CHANGELOG.rst (in local directory or GitHub) or CHANGELOG.html (local build or Read the Docs).

Documentation

More extensive documentation can be found in the ./docs directory, and online at sbws.rtfd.io.

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.

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

Authors

See ./AUTHORS.md (in local directory or GitHub) or AUTHORS.html (local build or Read the Docs).