1
0
mirror of https://github.com/PurpleI2P/pyseeder synced 2025-01-31 17:14:20 +00:00
pyseeder/README.md

81 lines
2.3 KiB
Markdown
Raw Normal View History

2016-08-30 20:25:23 +03:00
pyseeder
========
Reseed data managment tools for I2P
* Generate reseed signing keypair
* Make reseed data files (su3)
* Download su3 files from official servers for mirroring
* Upload reseed data to different places (with plugins)
* Run HTTPS reseed server
2016-08-30 20:25:23 +03:00
Reseed transports are implemented so that users can bootstrap their I2P nodes
without needing to connect to "official" I2P reseeds. This makes I2P more
invisible for firewalls.
2017-07-04 15:10:05 -04:00
Installation
------------
$ pip3 install https://github.com/PurpleI2P/pyseeder/zipball/master
[Detailed installation instructions](INSTALL.md)
2016-08-30 20:25:23 +03:00
Usage
-----
2017-07-04 15:10:05 -04:00
$ pyseeder --help
$ pyseeder keygen --help
2016-08-30 20:25:23 +03:00
Generating keypair
------------------
2017-07-04 15:10:05 -04:00
$ pyseeder keygen --cert data/user_at_mail.i2p.crt --private-key data/priv_key.pem --signer-id user@mail.i2p
2016-08-30 20:25:23 +03:00
This will generate certificate (user\_at\_mail.i2p.crt) and private RSA key
(priv\_key.pem) in data folder. E-mail is used as certificate identifier.
Script will prompt for private key password.
Generating reseed data
----------------------
$ YOUR_PASSWORD="Pa55w0rd"
2017-07-04 15:10:05 -04:00
$ echo $YOUR_PASSWORD | pyseeder reseed --netdb /path/to/netDb --private-key data/priv_key.pem --outfile output/i2pseeds.su3 --signer-id user@mail.i2p
2016-08-30 20:25:23 +03:00
This will generate file i2pseeds.su3 in output folder, using user@mail.i2p as
certificate identifier.
Note: you'll have to enter your private key password to stdin, the above
is one of the ways to do it (for cron and scripts).
Download su3 file from official servers
---------------------------------------
2017-07-04 15:10:05 -04:00
$ pyseeder transport.pull --urls https://reseed.i2p-projekt.de/ https://reseed.i2p.vzaws.com:8443/ --outfile output/i2pseeds.su3
2016-08-30 20:25:23 +03:00
Note: --urls parameter is optional, defaults are "official" I2P reseeds.
Upload su3 file with pluggable transports
-----------------------------------------
2017-07-04 15:10:05 -04:00
$ pyseeder transport.push --config transports.ini --file output/i2pseeds.su3
2016-08-30 20:25:23 +03:00
All parameters are optional. Copy file transports.ini.example to
transports.ini. Edit your settings in this new file.
Run HTTPS reseed server
-----------------------
2017-07-04 15:10:05 -04:00
$ pyseeder serve --port 8443 --host 127.0.0.1 --private-key data/priv_key.pem --cert data/user_at_mail.i2p.crt --file output/i2pseeds.su3
Note: this server is fine for testing, but for "production" environments please
use nginx webserver.