Name | Date | Size | #Lines | LOC | ||
---|---|---|---|---|---|---|
.. | 09-Aug-2021 | - | ||||
data/ | H | 03-May-2022 | - | |||
examples/ | H | 09-Aug-2021 | - | 60 | 53 | |
images/ | H | 03-May-2022 | - | |||
proposals/ | H | 09-Aug-2021 | - | 209 | 155 | |
AUTHORS.rst | H A D | 09-Aug-2021 | 243 | 15 | 11 | |
CHANGELOG.rst | H A D | 09-Aug-2021 | 44.9 KiB | 1,123 | 1,028 | |
DEPLOY.rst | H A D | 09-Aug-2021 | 2.6 KiB | 78 | 55 | |
INSTALL.rst | H A D | 09-Aug-2021 | 3.7 KiB | 124 | 85 | |
README.rst | H A D | 09-Aug-2021 | 2.5 KiB | 75 | 54 | |
activity_aggr_file.puml | H A D | 09-Aug-2021 | 682 | 28 | 24 | |
activity_aggr_lines.puml | H A D | 09-Aug-2021 | 736 | 37 | 33 | |
activity_all.puml | H A D | 09-Aug-2021 | 250 | 25 | 13 | |
activity_measure.puml | H A D | 09-Aug-2021 | 440 | 31 | 26 | |
activity_scaling_as_torflow.puml | H A D | 09-Aug-2021 | 940 | 35 | 31 | |
activity_second_relay.puml | H A D | 09-Aug-2021 | 520 | 30 | 27 | |
activity_torflow_aggr.puml | H A D | 09-Aug-2021 | 1.9 KiB | 65 | 57 | |
activity_torflow_scaling.puml | H A D | 09-Aug-2021 | 6.5 KiB | 169 | 161 | |
activity_torflow_scaling_simplified.puml | H A D | 09-Aug-2021 | 5 KiB | 133 | 125 | |
activity_torflow_scaling_simplified1.puml | H A D | 09-Aug-2021 | 1.2 KiB | 39 | 35 | |
bandwidth_authorities.rst | H A D | 09-Aug-2021 | 760 | 29 | 18 | |
bandwidth_distribution.rst | H A D | 09-Aug-2021 | 1 KiB | 39 | 22 | |
classes_original.puml | H A D | 09-Aug-2021 | 4.9 KiB | 221 | 215 | |
code_design.rst | H A D | 09-Aug-2021 | 1.3 KiB | 61 | 43 | |
conf.py | H A D | 09-Aug-2021 | 5.9 KiB | 201 | 54 | |
config.default.ini | H A D | 09-Aug-2021 | 5.1 KiB | 132 | 124 | |
config.example.ini | H A D | 09-Aug-2021 | 575 | 18 | 15 | |
config.log.default.ini | H A D | 09-Aug-2021 | 701 | 44 | 33 | |
config.rst | H A D | 09-Aug-2021 | 1.9 KiB | 53 | 37 | |
config_tor.rst | H A D | 09-Aug-2021 | 1.8 KiB | 45 | 32 | |
contributing.rst | H A D | 09-Aug-2021 | 10.9 KiB | 326 | 230 | |
differences.rst | H A D | 09-Aug-2021 | 1.4 KiB | 45 | 28 | |
documenting.rst | H A D | 09-Aug-2021 | 1 KiB | 49 | 27 | |
faq.rst | H A D | 09-Aug-2021 | 1.7 KiB | 56 | 36 | |
generator.rst | H A D | 09-Aug-2021 | 2.1 KiB | 65 | 41 | |
glossary.rst | H A D | 09-Aug-2021 | 1.7 KiB | 50 | 37 | |
how_works.rst | H A D | 09-Aug-2021 | 4.1 KiB | 135 | 99 | |
implementation.rst | H A D | 09-Aug-2021 | 6.5 KiB | 187 | 135 | |
index.rst | H A D | 09-Aug-2021 | 1.7 KiB | 87 | 69 | |
man_sbws.ini.rst | H A D | 09-Aug-2021 | 7.8 KiB | 239 | 202 | |
man_sbws.rst | H A D | 09-Aug-2021 | 3.1 KiB | 118 | 81 | |
monitoring_bandwidth.rst | H A D | 09-Aug-2021 | 1.5 KiB | 65 | 35 | |
roadmap.rst | H A D | 09-Aug-2021 | 139 | 15 | 10 | |
sbws.core.rst | H A D | 09-Aug-2021 | 750 | 47 | 34 | |
sbws.lib.rst | H A D | 09-Aug-2021 | 941 | 54 | 40 | |
sbws.rst | H A D | 09-Aug-2021 | 262 | 23 | 16 | |
sbws.util.rst | H A D | 09-Aug-2021 | 1,023 | 63 | 46 | |
state.rst | H A D | 09-Aug-2021 | 777 | 22 | 15 | |
testing.rst | H A D | 09-Aug-2021 | 483 | 24 | 16 | |
threads.puml | H A D | 09-Aug-2021 | 279 | 23 | 19 | |
tor_bandwidth_files.rst | H A D | 09-Aug-2021 | 714 | 33 | 18 | |
torflow_aggr.rst | H A D | 09-Aug-2021 | 13.8 KiB | 478 | 327 |
README.rst
1Readme 2====== 3 4`Build 5Status <https://travis-ci.org/https://travis-ci.org/torproject/sbws>`__ 6 7Simple Bandwidth Scanner (called ``sbws``) is a Tor bandwidth scanner 8that generates bandwidth files to be used by Directory Authorities. 9 10The scanner measures the bandwidth of each relay in the Tor network 11(except the directory authorities) by creating a two hops circuit with 12the relay. It then measures the bandwidth by downloading data from a 13destination Web Server and stores the measurements. 14 15The generator read the measurements, aggregates, filters and scales them 16using torflow’s scaling method. Then it generates a bandwidth list file 17that is read by a directory authority to report relays’ bandwidth in its 18vote. 19 20**WARNING**: This software is intended to be run by researchers using a 21test Tor network, such as chutney or shadow, or by the Tor bandwidth 22authorities on the public Tor network. Please do not run this software 23on the public Tor network unless you are one of the Tor bandwidth 24authorities, to avoid creating unnecessary traffic. 25 26**ADVICE**: It is recommended to read this documentation at 27https://tpo.pages.torproject.net/network-health/sbws. 28At https://gitlab.torproject.org/tpo/network-health/sbws 29some links won’t be properly rendered. It can also be read after 30installing the Debian package ``sbws-doc`` in ``/usr/share/doc/sbws`` or 31after building it locally as explained in 32``./docs/source/documenting.rst``. 33 34Installing 35---------- 36 37See `./INSTALL.rst <INSTALL.rst>`__ (in local directory or tpo Gitlab) 38or `INSTALL.html <INSTALL.html>`__ (local build or Read the Docs). 39 40Deploying and running 41--------------------- 42 43See `./DEPLOY.rst <DEPLOY.rst>`__ (in local directory or tpo Gitlab) or 44`DEPLOY.html <DEPLOY.html>`__ (local build or Read the Docs). 45 46Changelog 47--------- 48 49See `./CHANGELOG.rst <CHANGELOG.rst>`__ (in local directory or tpo 50Gitlab) or `CHANGELOG.html <CHANGELOG.html>`__ (local build or Read the 51Docs). 52 53Documentation 54------------- 55 56More extensive documentation can be found in the ``./docs`` directory, 57and online at https://tpo.pages.torproject.net/network-health/sbws. 58 59License 60------- 61 62This work is in the public domain within the United States. 63 64We waive copyright and related rights in the work worldwide through the 65`CC0-1.0 license <https://creativecommons.org/publicdomain/zero/1.0>`__. 66 67You can find a copy of the CC0 Public Domain Dedication along with this 68software in ./LICENSE.md 69 70Authors 71------- 72 73See `./AUTHORS.rst <AUTHORS.rst>`__ (in local directory or tpo Gitlab) or 74`AUTHORS.html <AUTHORS.html>`__ (local build or Read the Docs). 75