1
2
3
4
5
6
7
8
9
10
11
12
13
14
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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
|
.. simple-bw-scanner documentation master file, created by
sphinx-quickstart on Fri Mar 23 16:20:02 2018.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
.. raw:: html
<script type="text/javascript">
if (String(window.location).indexOf("readthedocs") !== -1) {
window.alert('The documentation has moved, redirecting...');
window.location.replace('https://tpo.pages.torproject.net/network-health/sbws');
}
</script>
<noscript>
NOTE: documentation has moved from https://sbws.readthedocs.org to
https://tpo.pages.torproject.net/network-health/sbws
</noscript>
Welcome to Simple Bandwidth Scanner's documentation!
====================================================
User main documentation
------------------------
Included in the
`repository root <https://gitlab.torproject.org/tpo/network-health/sbws>`_
and in ``sbws`` Debian package:
.. toctree::
:maxdepth: 1
README
INSTALL
DEPLOY
troubleshooting
CHANGELOG
AUTHORS
man_sbws
man_sbws.ini
.. _dev_doc:
Developer/technical documentation
----------------------------------
Included in the
`docs directory <https://gitlab.torproject.org/tpo/network-health/sbws/-/tree/main/docs>`_ and in
``sbws-doc`` Debian package:
.. toctree::
:maxdepth: 1
contributing
testing
documenting
how_works
generator
torflow_aggr
differences
data_retention
bandwidth_file
code_design
state
config
config_tor
sbws
webclient
implementation
bandwidth_distribution
tor_bandwidth_files
bandwidth_authorities
monitoring_bandwidth
roadmap
glossary
faq
Proposals:
.. toctree::
:maxdepth: 1
:glob:
proposals/*
Indices and tables
-------------------
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
|
