docker
Hub
ctrl+K
Sign inSign up

geti2p/reseed-tools

Sponsored OSS

By geti2p

•Updated about 2 years ago

Automated, tagged Docker images of idk's Go reseed fork.

Image
Integration & Delivery
Networking
Security

1.2K

OverviewTags

I2P Reseed Tools

Reseed Tools Poster

This tool provides a secure and efficient reseed server for the I2P network. There are several utility commands to create, sign, and validate SU3 files. Please note that this requires at least Go version 1.13, and uses Go Modules.

Standard reseeds are distributed with the I2P packages. To get your reseed included, apply on zzz.i2p⁠.

Dependencies

go, git, and optionally make are required to build the project. Precompiled binaries for most platforms are available at my github mirror https://github.com/eyedeekay/i2p-tools-1⁠.

In order to install the build-dependencies on Ubuntu or Debian, you may use:

sudo apt-get install golang-go git make

Installation

Reseed-tools can be run as a user, as a freestanding service, or be installed as an I2P Plugin. It will attempt to configure itself automatically. You should make sure to set the --signer flag or the RESEED_EMAIL environment variable to configure your signing keys/contact info.

Plugin install URL's

Plugin releases are available inside of i2p at http://idk.i2p/reseed-tools/⁠ and via the github mirror at https://github.com/eyedeekay/reseed-tools/releases⁠. These can be installed by adding them on the http://127.0.0.1:7657/configplugins⁠.

After installing the plugin, you should immediately edit the $PLUGIN/signer file in order to set your --signer email, which is used to name your keys. You can find the $PLUGIN directory in your I2P config directory, which is usually $HOME/.i2p on Unixes.

This will allow the developers to contact you if your reseed has issues and will authenticate your reseed to the I2P routers that use it.

Installation(From Source)
git clone https://i2pgit.org/idk/reseed-tools
cd reseed-tools
make build
# Optionally, if you want to install to /usr/bin/reseed-tools
sudo make install

Usage

Debian/Ubuntu note:

Debian users who are running I2P as a system service must also run the reseed-tools as the same user. This is so that the reseed-tools can access the I2P service's netDb directory. On Debian and Ubuntu, that user is i2psvc and the netDb directory is: /var/lib/i2p/i2p-config/netDb.

Example Commands:

Without a webserver, standalone with TLS support

If this is your first time running a reseed server (ie. you don't have any existing keys), you can simply run the command and follow the prompts to create the appropriate keys, crl and certificates. Afterwards an HTTPS reseed server will start on the default port and generate 6 files in your current directory (a TLS key, certificate and crl, and a su3-file signing key, certificate and crl).

reseed-tools reseed --signer=you@mail.i2p --netdb=/home/i2p/.i2p/netDb --tlsHost=your-domain.tld
Locally behind a webserver (reverse proxy setup), preferred:

If you are using a reverse proxy server it may provide the TLS certificate instead.

reseed-tools reseed --signer=you@mail.i2p --netdb=/home/i2p/.i2p/netDb --port=8443 --ip=127.0.0.1 --trustProxy

Docker Pull Command

docker pull geti2p/reseed-tools