Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
S
sbws
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container Registry
Model registry
Operate
Environments
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
juga
sbws
Commits
b52afd65
Commit
b52afd65
authored
6 years ago
by
juga
Browse files
Options
Downloads
Patches
Plain Diff
chg: docs: document that authorities are not measured
and improve a bit the summary about what sbws does. Closes: #29722
parent
fa6d18b5
No related branches found
Branches containing commit
No related tags found
No related merge requests found
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
README.md
+9
-5
9 additions, 5 deletions
README.md
docs/source/how_works.rst
+13
-6
13 additions, 6 deletions
docs/source/how_works.rst
with
22 additions
and
11 deletions
README.md
+
9
−
5
View file @
b52afd65
...
...
@@ -3,13 +3,17 @@
[

](https://travis-ci.org/https://travis-ci.org/torproject/sbws)
Simple Bandwidth Scanner (called
`sbws`
) is a Tor bandwidth scanner that
produc
es bandwidth files to be used by Directory Authorities.
generat
es 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 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.
The generator read the measurement results, scales them using torflow's
scaling method and creates the bandwidth file.
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.
**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
...
...
This diff is collapsed.
Click to expand it.
docs/source/how_works.rst
+
13
−
6
View file @
b52afd65
...
...
@@ -7,12 +7,19 @@ Running the scanner
Overview
~~~~~~~~~
The :term:`scanner` obtain a list of relays from the Tor network.
It measures the bandwidth of each relay by creating a two hop circuit with the
relay to measure and download data from a :term:`destination` Web Server.
The :term:`generator` creates a :term:`bandwidth list file` that is read
by a :term:`directory authority` and used to report relays' bandwidth in its
vote.
.. The following text is part of the introduction in the README, but rst
formatted.
The :term:`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 :term:`destination` Web Server and stores the measurements.
The :term:`generator` read the measurements, aggregates, filters and
scales them using torflow's scaling method.
Then it generates a :term:`bandwidth list file` that is read
by a :term:`directory authority` to report relays’ bandwidth in its vote.
.. image:: ./images/scanner.svg
:height: 200px
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment