split out policy section

This commit is contained in:
idk
2023-01-04 23:16:22 +00:00
parent 51a89c450a
commit 574a23bf5a
5 changed files with 212 additions and 14 deletions

View File

@ -1,8 +1,15 @@
{% extends "global/layout.html" %}
{% block title %}{{ _('How to Set up a Reseed Server using a Debian Package') }}{% endblock %}
{% block lastupdated %}2023-1{% endblock %}
{% block lastupdated %}2023-01{% endblock %}
{% block content %}
<h2>{% trans %}General Information{% endtrans %}</h2>
<h4><a href="reseed-policy">To read the reseed policy, follow this link.</a></h4>
<h4><a href="reseed">Please see the general information for all reseed servers in addition to reading this section.</a></h4>
<h2>{% trans %}Reseed on Debian using {% endtrans %} <code>checkinstall</code>, <code>apt-get</code></h2>
<p>
It is possible to easily and automatically configure a reseed server
with a self-signed certificate on any Debian-based operating system,
@ -26,7 +33,7 @@
</h2>
<p>
If you do not wish to build from source, you can use a binary package
from me. This package is built from this repo with the
from me(idk). This package is built from this repo with the
<code>
make checkinstall
</code>
@ -40,7 +47,7 @@
</p>
<pre><code class="language-sh">
wget https://github.com/eyedeekay/reseed-tools/releases/download/v0.2.30/reseed-tools_0.2.30-1_amd64.deb
# Obtain the checksum from the release web page
# Obtain the checksum from the release web page and store it in the SHA256SUMS file
echo &quot;38941246e980dfc0456e066f514fc96a4ba25d25a7ef993abd75130770fa4d4d reseed-tools_0.2.30-1_amd64.deb&quot; &gt; SHA256SUMS
sha256sums -c SHA256SUMS
sudo apt-get install ./reseed-tools_0.2.30-1_amd64.deb
@ -58,7 +65,7 @@ sudo apt-get install ./reseed-tools_0.2.30-1_amd64.deb
repository.
</p>
<p>
\
<strong>
1.
</strong>
@ -68,7 +75,7 @@ sudo apt-get install ./reseed-tools_0.2.30-1_amd64.deb
sudo apt-get install fakeroot checkinstall go git make
</code></pre>
<p>
\
<strong>
2.
</strong>
@ -78,7 +85,7 @@ sudo apt-get install fakeroot checkinstall go git make
git clone https://i2pgit.org/idk/reseed-tools ~/go/src/i2pgit.org/idk/reseed-tools
</code></pre>
<p>
\
<strong>
3.
</strong>
@ -97,7 +104,7 @@ cd ~/go/src/i2pgit.org/idk/reseed-tools
make checkinstall
</code></pre>
<p>
\
<strong>
4.
</strong>
@ -114,7 +121,7 @@ sudo apt-get install ./reseed-tools_*.deb
Running the Service
</h2>
<p>
\
<strong>
1.
</strong>
@ -131,7 +138,7 @@ sudo systemctl start i2p
sudo service i2p start
</code></pre>
<p>
\
<strong>
2.
</strong>

View File

@ -1,10 +1,13 @@
{% extends "global/layout.html" %}
{% block title %}{{ _('How to Set up a Reseed Server using an I2P Console Plugin') }}{% endblock %}
{% block lastupdated %}2023-1{% endblock %}
{% block lastupdated %}2023-01{% endblock %}
{% block content %}
<h2>{% trans %}General Information{% endtrans %}</h2>
<h2>{% trans %}Installation from Source Code{% endtrans %}</h2>
<h4><a href="reseed-policy">To read the reseed policy, follow this link.</a></h4>
<h4><a href="reseed">Please see the general information for all reseed servers in addition to reading this section.</a></h4>
<h2>{% trans %}Installation from an I2P console plugin{% endtrans %}</h2>
{% endblock %}

View File

@ -0,0 +1,51 @@
{% extends "global/layout.html" %}
{% block title %}{{ _('How to Set up a Reseed Server using an I2P Console Plugin') }}{% endblock %}
{% block lastupdated %}2023-01{% endblock %}
{% block content %}
<h2>{% trans %}Reseed Policy Information{% endtrans %}</h2>
<p>{% trans -%}
When your setup is complete and ready for testing, we will need the HTTPS URL,
the SSL public key certificate (only if selfsigned), and the su3 public key certificate.
After testing is complete, these will be added to the hardcoded entries in the Java and C++ routers in the next release,
and you will start seeing traffic.
We also will need your email address so we may continue to contact you about reseed administration issues.
The email will not be made public but will be known to the other reseed operators.
You should expect that your nick or name and its association with that URL or IP will become public.
{%- endtrans %}</p>
<h3>{% trans %}Information Required{% endtrans %}</h3>
<p>{% trans -%}
When your setup is complete and ready for testing, we will need the HTTPS URL,
the SSL public key certificate (only if selfsigned), and the su3 public key certificate.
After testing is complete, these will be added to the hardcoded entries in the Java and C++ routers in the next release,
and you will start seeing traffic.
We also will need your email address so we may continue to contact you about reseed administration issues.
The email will not be made public but will be known to the other reseed operators.
You should expect that your nick or name and its association with that URL or IP will become public.
{%- endtrans %}</p>
<h3>{% trans %}Privacy Policy{% endtrans %}</h3>
<p>{% trans -%}
A reseed operator is a trusted role in the network.
While we do not yet have a formal privacy policy, you must ensure the privacy of our users
by not publicizing logs or IPs found in those logs, except as necessary to discuss administration issues with the I2P reseed team.
{%- endtrans %}</p>
<h3>{% trans %}Financial Support{% endtrans %}</h3>
<p>{% trans -%}
Modest financial support may be available to those running reseed servers.
This support would be in partial reimbursement for your server costs.
Support will not be paid in advance and will probably not cover all your expenses.
Support is only available to those who have been running reseed servers in good standing for several months, and is based on actual need.
{%- endtrans %}</p>
<p>{% trans -%}
If you would like to discuss support, please contact echelon and CC: zzz
{%- endtrans %}</p>
{% endblock %}

View File

@ -1,10 +1,13 @@
{% extends "global/layout.html" %}
{% block title %}{{ _('How to Set up a Reseed Server using a Reverse Proxy') }}{% endblock %}
{% block lastupdated %}2023-1{% endblock %}
{% block lastupdated %}2023-01{% endblock %}
{% block content %}
<h2>{% trans %}General Information{% endtrans %}</h2>
<h2>{% trans %}Installation from Source Code{% endtrans %}</h2>
<h4><a href="reseed-policy">To read the reseed policy, follow this link.</a></h4>
<h4><a href="reseed">Please see the general information for all reseed servers in addition to reading this section.</a></h4>
<h2>{% trans %}Reseed Installation using a Reverse Proxy{% endtrans %}</h2>
{% endblock %}

View File

@ -1,10 +1,144 @@
{% extends "global/layout.html" %}
{% block title %}{{ _('How to Set up a Reseed Server') }}{% endblock %}
{% block lastupdated %}2023-1{% endblock %}
{% block lastupdated %}2023-01{% endblock %}
{% block content %}
<h2>{% trans %}General Information{% endtrans %}</h2>
<p>{% trans -%}
Thank you for volunteering to run an I2P reseed server.
"Reseeding" is our term for bootstrapping new routers into the network.
New routers fetch a bundle of peer references, or "router infos", from one or more of a hardcoded list of HTTPS URLs.
{%- endtrans %}</p>
<h2>{% trans %}Requirements{% endtrans %}</h2>
<p>{% trans -%}
A reseed server must be reachable on the public internet.
It must use TLS, but it may use a self-signed TLS certificate if the reseed administrator is in communication with the router development team.
The administrator of the reseed server should provide contact information in order to respond to issues and be in touch with the I2P team.
{%- endtrans %}</p>
<h2>{% trans %}More Information{% endtrans %}</h2>
<h4><a href="reseed-policy">To read the reseed policy, follow this link.</a></h4>
<h4><a href="reseed-debian">Are you a Debian user? You can find Debian-Specific instructions here.</a></h4>
<h4><a href="reseed-plugin">Would you like to use an I2P Plugin? I2P Plugin instructions are available here.</a></h4>
<h4><a href="reseed-proxy">Click here for instructions on using a reverse proxy such as nginx or Apache2.</a></h4>
<h4><a href="reseed-old">To read the old instructions, follow this link.</a></h4>
<h2>{% trans %}Installation from Source Code{% endtrans %}</h2>
<p>
Reseed Tools is a pure Go application which can be built statically without CGO.
It makes use of Go Modules.
A Makefile is provided with some targets which are convenient helpers for generating binaries, especially for production and release purposes.
</p>
<p>
<strong>
1.
</strong>
Install the build dependencies
</p>
<pre><code class="language-sh">
sudo apt-get install go git make
</code></pre>
<p>
<strong>
2.
</strong>
Clone the source code
</p>
<pre><code class="language-sh">
git clone https://i2pgit.org/idk/reseed-tools ~/go/src/i2pgit.org/idk/reseed-tools
</code></pre>
<p>
<strong>
3.
</strong>
Generate the
<code>
binaries
</code>
package using the
<code>
make build
</code>
target
</p>
<pre><code class="language-sh">
cd ~/go/src/i2pgit.org/idk/reseed-tools
make build
</code></pre>
<p>
<strong>
4.
</strong>
Install the binary and the config files
</p>
<pre><code class="language-sh">
sudo make install
</code></pre>
<h2>
Running the Service
</h2>
<p>
<strong>
1.
</strong>
First, ensure that the I2P service is already running. The longer the better,
if you have to re-start the service, or if the service has very few peers, allow it to
run for 24 hours before advancing to step
<strong>
2.
</strong>
</p>
<pre><code class="language-sh">
sudo systemctl start i2p
# or, if you use sysvinit
sudo service i2p start
</code></pre>
<p>
<strong>
2.
</strong>
Once your I2P router is &ldquo;Well-Integrated,&rdquo; start the reseed service.
</p>
<pre><code class="language-sh">
sudo systemctl start reseed
# or, if you use sysvinit
sudo service reseed start
</code></pre>
<p>
Your reseed will auto-configure with a self-signed certificate on port
<code>
:8443
</code>
. The
certificates themselves are available in
<code>
/var/lib/i2p/i2p-config/reseed
</code>
. When
you are ready, you should copy the
<code>
*.crt
</code>
files from that directory and share them
witth the I2P community on
<a href="http://zzz.i2p">
<code>
zzz.i2p
</code>
</a>
. These will allow I2P users
to authenticate your reseed services and secure the I2P network.
</p>
{% endblock %}