Commit c02cd9d5 authored by Hiro's avatar Hiro 🏄
Browse files

Merge branch 'assingments-test' into 'master'

Document bridge test results params in assignments file

See merge request !71
parents 0f72a2fb 333937ed
Loading
Loading
Loading
Loading
+28 −12
Original line number Diff line number Diff line
@@ -640,12 +640,12 @@ statistical analysis.
<p>
The document below shows a BridgeDB pool assignment file
from April 09, 2022.
Every such file begins with a line containing the timestamp when BridgeDB
Every such file begins with a line containing the timestamp when rdsys
wrote this file.
Subsequent lines start with the SHA-1 hash of a bridge fingerprint,
followed by distribution mechanism, transport, ip and country block list
information.
There are currently different distributor mechanism in BridgeDB:
There are currently different distributor mechanism in rdsys:
</p>

<ol>
@@ -673,21 +673,37 @@ clients to autoconfigure the circumvention settings depending on the location of
</ol>

<p>
The assignment file also lists the transport that the bridge is using, like
obsf4, the ip version and the country blocklist.
The each bridge in the assignment contains a list of <em>key=value</em>
parameters with the following keys:
</p>

<p>the blocklist parameter lists the country codes of the location where we
  think the bridge might be blocked and should not be served.</p>
<ul>
<li><b>transport</b>: the transport that the bridge is using, like obsf4</li>
<li><b>ip</b>: the ip version of the bridge, 4 or 6</li>
<li><b>port</b>: if the bridge port is a common one, like 443</li>
<li><b>blocklist</b>: the blocklist parameter lists the country codes of the
location where we think the bridge might be blocked and should not be served.</li>
<li><b>distributed</b>: if the bridge is being currently distributed by rdsys,
can be true or false.</li>
<li><b>state</b>: can be functional, dysfunctional or untested. Indicates if
the bridge works correctly from our servers (using bridgestrap)</li>
<li><b>ratio</b>: The bandwidth ratio of the bridge represents how fast is a bridge
connection compared to the rest of the bridges. If the ratio is 1.0 the bridge 
is as fast as the rest of the bridges average, below the
bridge is slower than the mean and above the bridge is faster. It will not be
pressent if is not being tested by onbasca yet.</li>
<li><b>bandwidth</b>: Can be accepted, rejected or untested. Indicates if their
bandwidth ratio big enough to be distributed by rdsys.</li>
</ul>

<pre>
  @type bridge-pool-assignment 1.0
  @type bridge-pool-assignment 1.1
  bridge-pool-assignment 2022-04-09 00:29:37
  005fd4d7decbb250055b861579e6fdc79ad17bee email transport=obfs4 ip=4 blocklist=ru
  00782946f4c54ce1d028f21e541ef8440ecaa0ee settings ip=4 blocklist=ru
  00e1ae6cb75e47e363e6aef9f67a49c0e854fde7 moat transport=obfs4 ip=4
  00e6f1d633d4e29db31f43d1e6e3e928e5c1810d moat transport=obfs4 ip=4 blocklist=ru
  0110a6cf41a07637808fff79c0783ff37462b525 email ip=4 blocklist=ru
  005fd4d7decbb250055b861579e6fdc79ad17bee email transport=obfs4 ip=4 blocklist=ru port=443 distributed=true state=functional bandwidth=accepted ratio=1.902
  00782946f4c54ce1d028f21e541ef8440ecaa0ee settings ip=4 blocklist=ru distributed=true state=functional bandwidth=untested
  00e1ae6cb75e47e363e6aef9f67a49c0e854fde7 moat transport=obfs4 ip=4 distributed=false state=functional bandwidth=rejected ratio=0.569
  00e6f1d633d4e29db31f43d1e6e3e928e5c1810d moat transport=obfs4 ip=4 blocklist=ru distributed=false state=functional bandwidth=rejected ratio=0.752
  0110a6cf41a07637808fff79c0783ff37462b525 email ip=4 blocklist=ru distributed=true state=functional bandwidth=accepted ratio=1.223
[...]
</pre>