diff options
Diffstat (limited to 'spec/bridgedb-spec.md')
| -rw-r--r-- | spec/bridgedb-spec.md | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/spec/bridgedb-spec.md b/spec/bridgedb-spec.md index 4ced4bd..b12fcfb 100644 --- a/spec/bridgedb-spec.md +++ b/spec/bridgedb-spec.md @@ -13,7 +13,7 @@ behavior. <a id="bridgedb-spec.txt-1"></a> -# Importing bridge network statuses and bridge descriptors { #importing } +## Importing bridge network statuses and bridge descriptors { #importing } BridgeDB learns about bridges by parsing bridge network statuses, bridge descriptors, and extra info documents as specified in Tor's @@ -29,7 +29,7 @@ from a Tor instance that did the validation for us. <a id="bridgedb-spec.txt-1.1"></a> -## Parsing bridge network statuses { #parsing-network-status } +### Parsing bridge network statuses { #parsing-network-status } Bridge network status documents contain the information of which bridges are known to the bridge authority and which flags the bridge authority @@ -57,7 +57,7 @@ with these flags. <a id="bridgedb-spec.txt-1.2"></a> -## Parsing bridge descriptors { #parsing-bridge-descriptors } +### Parsing bridge descriptors { #parsing-bridge-descriptors } BridgeDB learns about a bridge's most recent IP address and OR port from parsing bridge descriptors. @@ -99,7 +99,7 @@ to the set of bridges to be given out to bridge users. <a id="bridgedb-spec.txt-1.3"></a> -## Parsing extra-info documents { #parsing-extra-info } +### Parsing extra-info documents { #parsing-extra-info } BridgeDB learns if a bridge supports a pluggable transport by parsing extra-info documents. @@ -126,7 +126,7 @@ Bridges that do not have an associated extra-info entry are not invalid. <a id="bridgedb-spec.txt-2"></a> -# Assigning bridges to distributors { #assigning-to-distributors } +## Assigning bridges to distributors { #assigning-to-distributors } A "distributor" is a mechanism by which bridges are given (or not given) to clients. The current distributors are "email", "https", @@ -148,7 +148,7 @@ distributors change or distributors are disabled entirely. <a id="bridgedb-spec.txt-3"></a> -# Giving out bridges upon requests { #distributing } +## Giving out bridges upon requests { #distributing } Upon receiving a client request, a BridgeDB distributor provides a subset of the bridges assigned to it. @@ -165,7 +165,7 @@ should not be blocked. <a id="bridgedb-spec.txt-4"></a> -# Selecting bridges to be given out based on IP addresses { #ip-based } +## Selecting bridges to be given out based on IP addresses { #ip-based } ```text BridgeDB may be configured to support one or more distributors which @@ -274,7 +274,7 @@ total." To do this, BridgeDB combines to the results: <a id="bridgedb-spec.txt-5"></a> -# Selecting bridges to be given out based on email addresses +## Selecting bridges to be given out based on email addresses ```text BridgeDB can be configured to support one or more distributors that are @@ -357,7 +357,7 @@ proceeds as follows: <a id="bridgedb-spec.txt-6"></a> -# Selecting unallocated bridges to be stored in file buckets { #unallocated-buckets } +## Selecting unallocated bridges to be stored in file buckets { #unallocated-buckets } > Kaner should have a look at this section. -NM @@ -387,7 +387,7 @@ proceeds as follows: <a id="bridgedb-spec.txt-7"></a> -# Displaying Bridge Information { #formatting } +## Displaying Bridge Information { #formatting } After bridges are selected using one of the methods described in Sections 4 - 6, they are output in one of two formats. Bridges are @@ -413,7 +413,7 @@ Previously, each line was prepended with the "bridge" keyword, such as <a id="bridgedb-spec.txt-8"></a> -# Writing bridge assignments for statistics +## Writing bridge assignments for statistics BridgeDB can be configured to write bridge assignments to disk for statistical analysis. |