Welcome to Simple Bandwidth Scanner’s documentation!

User main documentation

Included in the repository root and in sbws Debian package:

• Readme
• Installing Simple Bandwidth Scanner
• Deploying Simple Bandwidth Scanner
• Troubleshooting
• Changelog
• Authors
• Simple Bandwidth Scanner - SBWS(1)
• Simple Bandwidth Scanner - SBWS.INI(5)

Developer/technical documentation

Included in the docs directory and in sbws-doc Debian package:

• Contributing to Simple Bandwidth Scanner
• Installing tests dependencies and running tests
• Installing and building the documentation
• How sbws works
• How aggregation and scaling works
• Torflow aggregation and scaling
• Differences between Torflow and sbws
• Data retention
• BandwidthFile modifications
• Code design
• The state.dat file
• Internal code configuration files
• Internal Tor configuration for the scanner
• sbws package API
• webclient package API
• Implementation decisions
• Relays’ bandwidth distribution
• How bandwidth files are shown in the Tor network
• Bandwidth authorities in metrics
• Monitoring bandwidth changes in the Tor Network
• Roadmap
• Glossary
• Frequently Asked Questions (FAQ)

Proposals:

• Switching from helpers to HTTP(S)

Indices and tables

• Index

• Module Index

• Search Page