e1lama/i2pd
1
0
Fork 0
mirror of https://github.com/PurpleI2P/i2pd.git synced 2025-03-07 06:09:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

* tunnels.cfg.md: fix formatting, update descriptions

hagen
2016-07-19 01:54:58 +00:00
parent 459983b4c0
commit 568ab8ad3a
1 changed files with 28 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

53
tunnels.cfg.md

@@ -1,5 +1,3 @@
***
Overview
--------
@@ -7,7 +5,7 @@ tunnels.cfg is designed to support multiple I2P tunnels. Must be located in ``~/
This file uses .ini file format. It consists of multiple sections with unique name each.
Section type is specified by 'type' parameter with possible values 'client', 'server' or 'http'. Each 'client' specifies I2P client tunnel and each 'server' specifies I2P server tunnel. 'http' is special type of server tunnel for eepsites.
Section type is specified by *type* parameter with possible values *client*, *server* or *http*. Each *client* specifies I2P client tunnel and each *server* specifies I2P server tunnel. *http* is special type of server tunnel for eepsites.
Client tunnels
--------------
@@ -25,14 +23,14 @@ Example of client tunnel:
destination = irc.echelon.i2p
keys = irc.dat
If 'keys' is empty, transient keys will be created on every restart. If keys file is not found, new keys will be created and stored into specified file.
If *keys* is empty, transient keys will be created on every restart. If keys file is not found, new keys will be created and stored into specified file.
Client tunnels might share same local destination, if keys file contains same identity.
Optional parameters:
'address' means local interface tunnel binds to, '127.0.0.1' for connections from local host only, '0.0.0.0' for connections from everywhere. '127.0.0.1' by default.
'signaturetype' means signature type for new keys. 0 - DSA, 1- ECDSA-P256, 7 -EDDSA. 1 by default.
'destinationport' connect to particular port at destination. 0 by default.
* address -- local interface tunnel binds to, '127.0.0.1' for connections from local host only, '0.0.0.0' for connections from everywhere. '127.0.0.1' by default.
* signaturetype -- signature type for new keys. 0 (DSA), 1 (ECDSA-P256), 7 (EDDSA). 1 by default
* destinationport -- connect to particular port at destination. 0 by default
So, with example above, if you telnet to 127.0.0.1:6668 on localhost, i2pd will connect to irc.echelon.i2p:6668
@@ -49,23 +47,20 @@ Example of server tunnel:
port = 25
keys = smtp-in.dat
'keys' must be presented, LeaseSet of address from keys file will be published. Server tunnel must use its own local destination.
*keys* must be presented, LeaseSet of address from keys file will be published. Server tunnel must use its own local destination.
Optional parameters:
'inport' - what port at local destination server tunnel listens to. Same as 'port' by default.
'accesslist' - list of comma-separated of b32 address (without .b32.i2p) allowed to connect. Everybody is allowed by default.
'gzip' - turns internal compression off if set to false. true by default.
'signaturetype' means signature type for new keys. 0 - DSA, 1- ECDSA-P256, 7 -EDDSA. 1 by default.
* inport -- what port at local destination server tunnel listens to. Same as *port* by default.
* accesslist -- list of comma-separated of b32 address (without .b32.i2p) allowed to connect. Everybody is allowed by default.
* gzip -- turns internal compression off if set to false. true by default.
* signaturetype -- means signature type for new keys. 0 - DSA, 1- ECDSA-P256, 7 -EDDSA. 1 by default.
Server/http tunnels
-------------------
'http' tunnel works same way as server tunnel, but replace 'Host:' field in HTTP header to address provided in configuration. Also resolves it if necessary.
Optional parameters:
'hostoverride' - to send in 'Host:' header if different from 'host'
*http* tunnel works same way as server tunnel, but replace 'Host:' field in HTTP header to address provided in configuration.
Also resolves it if necessary.
Example of http tunnel:
@@ -75,21 +70,29 @@ Example of http tunnel:
port = 80
keys = our-website.dat
Optional parameters:
* hostoverride -- value to send in 'Host:' header, default: the same as *host* parameter
* gzip -- should we compress contents at i2p level. default: true
Server/IRC tunnels
-------------------
IRC tunnels are supposed to connect to an IRC server through WEBIRC.
It replaces IP address (usually 127.0.0.1) to user's .b32 I2P address.
Optional parameters:
'webircpassword' - password to send with WEBIRC command
Optional parameters:
* webircpassword -- password to send with WEBIRC command
I2CP parameters
---------------
I2CP parameter are common for all tunnel types and specify setting for a local destination.
I2CP parameter are common for all tunnel types and specify setting for a local destination.
'inbound.length' - number of hops of an inbound tunnel. 3 by default
'outbound.length' - number of hops of an outbound tunnel. 3 by default
'inbound.quantity' - number of inbound tunnels. 5 by default
'outbound.quantity' - number of outbound tunnels. 5 by default
'crypto.tagsToSend' - number of ElGamal/AES tags to send. 40 by default
* inbound.length -- number of hops of an inbound tunnel. 3 by default; lower value is faster but dangerous
* outbound.length -- number of hops of an outbound tunnel. 3 by default; lower value is faster but dangerous
* inbound.quantity -- number of inbound tunnels. 5 by default
* outbound.quantity -- number of outbound tunnels. 5 by default
* crypto.tagsToSend -- number of ElGamal/AES tags to send. 40 by default; too low value may cause problems with tunnel building
* explicitPeers -- list of comma-separated b64 addresses of peers to use, default: unset