diff options
Diffstat (limited to 'spec/bandwidth-file-spec-intro.md')
| -rw-r--r-- | spec/bandwidth-file-spec-intro.md | 40 |
1 files changed, 13 insertions, 27 deletions
diff --git a/spec/bandwidth-file-spec-intro.md b/spec/bandwidth-file-spec-intro.md index 93d812e..86563fa 100644 --- a/spec/bandwidth-file-spec-intro.md +++ b/spec/bandwidth-file-spec-intro.md @@ -1,32 +1,18 @@ +# Tor Bandwidth File Format + ```text - Tor Bandwidth File Format juga teor +``` -Table of Contents +This document describes the format of Tor's Bandwidth File, version +1.0.0 and later. - 1. Scope and preliminaries - 1.2. Acknowledgements - 1.3. Outline - 1.4. Format Versions - 2. Format details - 2.1. Definitions - 2.2. Header List format - 2.3. Relay Line format - 2.4. Implementation details - 2.4.1. Writing bandwidth files atomically - 2.4.2. Additional KeyValue pair definitions - 2.4.2.1. Simple Bandwidth Scanner - 2.4.2.2. Torflow - A. Sample data - A.1. Generated by Torflow - A.2. Generated by sbws version 0.1.0 - A.3. Generated by sbws version 1.0.3 - A.4. Headers generated by sbws version 1.0.4 - A.5 Generated by sbws version 1.1.0 - B. Scaling bandwidths - B.1. Scaling requirements - B.2. A linear scaling method - B.3. Quota changes - B.4. Torflow aggregation -``` +It is a new specification for the existing bandwidth file format, +which we call version 1.0.0. It also specifies new format versions +1.1.0 and later, which are backwards compatible with 1.0.0 parsers. + +Since Tor version 0.2.4.12-alpha, the directory authorities use +the Bandwidth File file called "V3BandwidthsFile" generated by +Torflow \[1\]. The details of this format are described in Torflow's +README.spec.txt. We also summarise the format in this specification. |