From 481790bc65010185eaa82596b6e85ea300802747 Mon Sep 17 00:00:00 2001 From: l-n-s Date: Fri, 7 Oct 2016 13:20:08 -0400 Subject: [PATCH] Instructions updated + requirements fix --- INSTALL.md | 32 ++++++++++++++++++++++++++++++++ README.md | 17 +++++++++++------ requirements.txt | 7 +------ 3 files changed, 44 insertions(+), 12 deletions(-) create mode 100644 INSTALL.md diff --git a/INSTALL.md b/INSTALL.md new file mode 100644 index 0000000..3564890 --- /dev/null +++ b/INSTALL.md @@ -0,0 +1,32 @@ +Installation +============ + +Requirements: python3 and python cryptography package + +Example for Ubuntu/Debian +------------------------- + + +Basic python packages & packages for building python cryptography package: + + sudo apt-get install python3 python3-pip python3-virtualenv build-essential libssl-dev libffi-dev python-dev + + +Clone repo: + + git clone https://github.com/PurpleI2P/pyseeder.git + + +Configure new python virtual environment: + + cd pyseeder + virtualenv --python=python3 venv + . venv/bin/activate + pip3 install -r requirements.txt + + +Thats it! Next time you will need to run pyseeder, don't forget to activate +python virtual environment as followed: + + . venv/bin/activate + diff --git a/README.md b/README.md index b5fd844..aa28c60 100644 --- a/README.md +++ b/README.md @@ -7,17 +7,13 @@ Reseed data managment tools for I2P * 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 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. - -Install requirements --------------------- - - # apt-get install python3 python3-pip - # pip3 install -r requirements.txt +[Installation instructions](INSTALL.md) Usage @@ -68,3 +64,12 @@ Upload su3 file with pluggable transports All parameters are optional. Copy file transports.ini.example to transports.ini. Edit your settings in this new file. + + +Run HTTPS reseed server +----------------------- + + $ python3 pyseeder.py 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. diff --git a/requirements.txt b/requirements.txt index 8ec0b10..b98e00d 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,6 +1 @@ -cffi==1.7.0 -cryptography==1.4 -idna==2.1 -pyasn1==0.1.9 -pycparser==2.14 -six==1.10.0 +cryptography>=1.4