preliminary family docs

This commit is contained in:
zzz
2016-01-12 15:39:19 +00:00
parent 4aba81a5ac
commit 644591a987

View File

@@ -1,7 +1,7 @@
{% extends "global/layout.html" %}
{% block title %}{% trans %}The Network Database{% endtrans %}{% endblock %}
{% block lastupdated %}{% trans %}December 2015{% endtrans %}{% endblock %}
{% block accuratefor %}0.9.23{% endblock %}
{% block lastupdated %}{% trans %}January 2016{% endtrans %}{% endblock %}
{% block accuratefor %}0.9.24{% endblock %}
{% block content %}
<h2>{% trans %}Overview{% endtrans %}</h2>
@@ -36,6 +36,8 @@ as the key. The structure itself contains:
<li>{% trans %}The signature of the above, generated by the identity's signing key{% endtrans %}</li>
</ul>
<h3>{% trans %}Expected Options{% endtrans %}</h3>
<p>{% trans -%}
The following text options, while not strictly required, are expected
to be present:
@@ -86,6 +88,7 @@ Above the minimum threshold, the advertised bandwidth is not used or trusted any
in the router, except for display in the user interface and for debugging and network analysis.
{%- endtrans %}</p>
<h3>{% trans %}Additional Options{% endtrans %}</h3>
<p>{% trans stats=i2pconv('stats.i2p') -%}
Additional text options include
@@ -113,12 +116,35 @@ As the network has matured, we have gradually removed most of the published
statistics to improve anonymity, and we plan to remove more in future releases.
{%- endtrans %}</p>
<p>
<a href="{{ site_url('docs/spec/common-structures') }}#struct_RouterInfo">{% trans %}RouterInfo specification{% endtrans %}</a>
</p>
<p>
<a href="http://docs.i2p-projekt.de/javadoc/net/i2p/data/RouterInfo.html">{% trans %}RouterInfo Javadoc{% endtrans %}</a>
</p>
<h3>{% trans %}Family Options{% endtrans %}</h3>
<p><b>Note:</b> Preliminary, subject to change.</p>
<p>{% trans -%}
As of release 0.9.24, routers may declare that they are part of a "family", operated by the same entity.
Multiple routers in the same family will not be used in a single tunnel.
{%- endtrans %}</p>
<p>{% trans -%}
The family options are:
{%- endtrans %}</p>
<ul>
<li><b>family</b>
({% trans %}The family name{% endtrans %})
</li>
<li><b>family.key</b>
The type code of the family's
<a href="{{ site_url('docs/spec/common-structures') }}#type_SigningPublicKey">Signing Public Key</a>
(in ASCII digits)
concatenated with ':'
concatenated with the Signing Public Key in base 64
</li>
<li><b>family.sig</b>
The signature of ((family name in UTF-8) concatenated with (32 byte router hash)) in base 64
</li>
</ul>
<h3>{% trans %}RouterInfo Expiration{% endtrans %}</h3>
<p>{% trans -%}
@@ -156,6 +182,15 @@ RouterInfos are periodically written to disk so that they are available after a
{%- endtrans %}</p>
<h3>{% trans %}See Also{% endtrans %}</h3>
<p>
<a href="{{ site_url('docs/spec/common-structures') }}#struct_RouterInfo">{% trans %}RouterInfo specification{% endtrans %}</a>
</p>
<p>
<a href="http://docs.i2p-projekt.de/javadoc/net/i2p/data/RouterInfo.html">{% trans %}RouterInfo Javadoc{% endtrans %}</a>
</p>
<h2 id="leaseSet">LeaseSet</h2>
<p>{% trans -%}