@ -50,7 +50,7 @@ Contact developers with IRC or create an issue on GitHub.
## What is good tunnel creation success rate value?
## What is good tunnel creation success rate value?
Average values are 15% - 40%. Larger is better.
\>10%. Larger is better.
## Is there a place I can use to find running I2P websites?
## Is there a place I can use to find running I2P websites?
@ -73,9 +73,8 @@ i2pd's socks proxy has an option to pass all non-I2P traffic to the Tor socks pr
## What is a floodfill mode?
## What is a floodfill mode?
Floodfill mode is a special mode, which contributes to the I2P network more.
Floodfill mode make your router a floodfill, that means what other routers will publish and get LeaseSets and RIs on your router. [Read more](http://geti2p.net/en/docs/how/network-database).
You may want to enable floodfill mode if you have stable uptime and high bandwidth
Floodfill mode require more bandwith, CPU time. If you sure, what you have stable uptime, you can enable floodfill: `floodfill = true`
to share.
## How is I2P different from Tor?
## How is I2P different from Tor?
@ -92,5 +91,5 @@ Tor is highly centralized by design, while I2P is designed to be decentralized a
## Can use i2pd as a proxy for regular Internet?
## Can use i2pd as a proxy for regular Internet?
Not out of the box. You better use [Tor](https://www.torproject.org/) for that.
Yes, but better use [Tor](https://www.torproject.org/) for that.
logclftime | Write full CLF-formatted date and time to log (default: write only time)
logclftime | Write full CLF-formatted date and time to log (default: false (write only time))
datadir | Path to storage of i2pd data (RI, keys, peer profiles, ...)
datadir | Path to storage of i2pd data (RouterInfos, destinations keys, peer profiles, etc ...)
host | Router external IP for incoming connections
host | Router external IP for incoming connections (default: auto if SSU2 is enabled)
port | Port to listen for incoming connections (default: auto)
port | Port to listen for incoming connections (default: auto (random))
daemon | Router will go to background after start
daemon | Router will go to background after start (default: true)
service | Router will use system folders like '/var/lib/i2pd' (on unix) or 'C:\ProgramData\i2pd' (on Windows). Ignored on MacOS and Android
service | Router will use system folders like '/var/lib/i2pd' (on unix) or 'C:\ProgramData\i2pd' (on Windows). Ignored on MacOS and Android (default: false)
ifname | Network interface to bind to
ifname | Network interface to bind to
ifname4 | Network interface to bind to for IPv4
ifname4 | Network interface to bind to for IPv4
ifname6 | Network interface to bind to for IPv6
ifname6 | Network interface to bind to for IPv6
address4 | Local address to bind to for IPv4
address4 | Local address to bind to for IPv4
address6 | Local address to bind to for clearnet IPv6
address6 | Local address to bind to for clearnet IPv6
nat | If true, assume we are behind NAT. true by default
nat | If true, assume we are behind NAT (default: true)
ipv4 | Enable communication through IPv4. true by default
ipv4 | Enable communication through IPv4 (default: true)
ipv6 | Enable communication through clearnet IPv6. false by default
ipv6 | Enable communication through clearnet IPv6 (default: false)
notransit | Router will not accept transit tunnels, disabling transit traffic completely. false by default
notransit | Router will not accept transit tunnels, disabling transit traffic completely (default: false)
floodfill | Router will be floodfill. false by default
floodfill | Router will be floodfill (default: false)
bandwidth | Bandwidth limit: integer in KBps or letters: L (32), O (256), P (2048), X (>9000)
bandwidth | Bandwidth limit: integer in KBps or letters: L (32), O (256), P (2048), X (unlimited).
share | Max % of bandwidth limit for transit. 0-100. 100 by default
share | Max % of bandwidth limit for transit. 0-100 (default: 100)
family | Name of a family, router belongs to
family | Name of a family, router belongs to
netid | Network ID, router belongs to. Main I2P is 2.
netid | Network ID, router belongs to. Main I2P is 2.
ssu | Enable SSU transport protocol (use UDP). true by default
ELGAMAL | 0 | **Default**(only for support old routers)
ECIES_P256_SHA256_AES256CBC | 1 | Not compatible with Java router
ECIES_P256_SHA256_AES256CBC | 1 | Not compatible with Java router
*ECIES_P384_SHA384_AES256CBC* | 2 | Not implemented
*ECIES_P384_SHA384_AES256CBC* | 2 | Not implemented
*ECIES_P521_SHA512_AES256CBC* | 3 | Not implemented
*ECIES_P521_SHA512_AES256CBC* | 3 | Not implemented
ECIES_X25519_AEAD | 4 | **Default** for routers
ECIES_X25519_AEAD | 4 | **Default**
Client tunnels
Client tunnels
--------------
--------------
@ -100,13 +100,15 @@ Optional parameters:
Option | Description
Option | Description
--------------------|--------------------
--------------------|--------------------
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
address | Local interface tunnel binds to, '127.0.0.1' for connections from local host only, '0.0.0.0' for connections from everywhere. (default: 127.0.0.1)
signaturetype | signature type for new keys. 0 (DSA), 1 (ECDSA-P256), 7 (EDDSA), 11 (RedDSA). RSA signatures (4,5,6) are not allowed and will be changed to 7. 7 by default
port | Port of client tunnel.
cryptotype | crypto type for new keys. Experimental. Should be always 0
signaturetype | Signature type for new keys. RSA signatures (4,5,6) are not allowed and will be changed to 7. (default: 7)
destinationport | connect to particular port at destination. 0 by default (targeting first tunnel on server side for destination)
cryptotype | Crypto type for new keys. Experimental. Should be always 0
keepaliveinterval | send ping to the destination after this interval in seconds. 0 by default meaning no pings
destinationport | Connect to particular port at destination. 0 by default (targeting first tunnel on server side for destination)
keepaliveinterval | Send ping to the destination after this interval in seconds. (default: 0 - no pings)
keys | Keys for destination. When same for several tunnels, will be using same destination for every tunnel.
So, given the example above, if you connected to 127.0.0.1:6668 on localhost, i2pd would tunnel that connection to irc.ilita.i2p
So, given the example above, if you connected to 127.0.0.1:6668 on localhost, i2pd would tunnel that connection to irc.ilita.i2p.
Server/generic tunnels
Server/generic tunnels
----------------------
----------------------
@ -136,13 +138,16 @@ Optional parameters:
Option | Description
Option | Description
--------------------|--------------------
--------------------|--------------------
inport | (non-TCP non-UDP) I2P local destination port to listen to; an unsigned 16-bit integer. What port at local destination server tunnel listens to. Same as *port* by default
host | IP address of server (on this address i2pd will send data from I2P)
accesslist | list of comma-separated of b32 address (without .b32.i2p) allowed to connect. Everybody is allowed by default
port | Port of server tunnel.
gzip | turns internal compression off if set to false. true by default
inport | (non-TCP non-UDP) I2P local destination port to listen to; an unsigned 16-bit integer. What port at local destination server tunnel listens to (default: same as *port*)
signaturetype | means signature type for new keys. 0 - DSA, 1- ECDSA-P256, 7 -EDDSA, 11 -RedDSA. 7 by default
accesslist | List of comma-separated of b32 address (without .b32.i2p) allowed to connect. Everybody is allowed by default
cryptotype | crypto type for new keys. Experimental. Should be always 0
gzip | Turns internal compression off if set to false. (default: false)
enableuniquelocal | if true, connection to local address will look like 127.x.x.x where x.x.x is first 3 bytes of incoming connection peer's ident hash. true by default
signaturetype | Signature type for new keys. (default: 7)
cryptotype | Crypto type for new keys. Experimental. Should be always 0
enableuniquelocal | If true, connection to local address will look like 127.x.x.x where x.x.x is first 3 bytes of incoming connection peer's ident hash. (default: true)
address | IP address of an interface tunnel is connected to *host* from. Usually not used
address | IP address of an interface tunnel is connected to *host* from. Usually not used
keys | Keys for destination. When same for several tunnels, will be using same destination for every tunnel.
Server/http tunnels
Server/http tunnels
-------------------
-------------------
@ -164,9 +169,8 @@ Optional parameters:
Option | Description
Option | Description
--------------------|--------------------
--------------------|--------------------
hostoverride | value to send in 'Host:' header, default: the same as *host* parameter
hostoverride | Value to send in 'Host:' header, default: the same as *host* parameter
gzip | should we compress contents at I2P level. default: true
ssl | Use SSL connection to upstream server. `hostoverride` parameter can be used to set SNI domain. default: false (since 2.44.0)
ssl | use SSL connection to upstream server. `hostoverride` parameter can be used to set SNI domain. default: false (since 2.44.0)
Server/IRC tunnels
Server/IRC tunnels
-------------------
-------------------
@ -177,7 +181,7 @@ Optional parameters:
Option | Description
Option | Description
--------------------|--------------------
--------------------|--------------------
webircpassword | password to send with WEBIRC command
webircpassword | Password to send with WEBIRC command
UDP Tunnels
UDP Tunnels
-----------
-----------
@ -196,10 +200,11 @@ port = 1194
Option | Description
Option | Description
--------------------|--------------------
--------------------|--------------------
destination | the I2P destination of a udpserver tunnel, required parameter
destination | The I2P destination of a udpserver tunnel, required parameter
address | IP address to bind local UDP endpoint to, defaults to `127.0.0.1`
address | IP address to bind local UDP endpoint to (default: `127.0.0.1`)
port | port to bind local UDP endpoint to, required parameter
port | Port to bind local UDP endpoint to, required parameter
gzip | turns internal compression off if set to false. true by default
gzip | Turns internal compression off if set to false. (default: false)
keys | Keys for destination. When same for several tunnels, will be using same destination for every tunnel.
`udpserver` forwards traffic from N I2P destinations to 1 local UDP endpoint
`udpserver` forwards traffic from N I2P destinations to 1 local UDP endpoint
@ -213,10 +218,11 @@ port = 1194
Option | Description
Option | Description
--------------------|--------------------
--------------------|--------------------
address | IP address to use for local UDP endpoints, defaults to `127.0.0.1`
address | IP address to use for local UDP endpoints (default: `127.0.0.1`)
host | IP address to forward traffic to, required parameter
host | IP address to forward traffic to, required parameter
port | UDP port to forward traffic on, required parameter
port | UDP port to forward traffic on, required parameter
gzip | turns internal compression off if set to false. true by default
gzip | Turns internal compression off if set to false. (default: false)
keys | Keys for destination. When same for several tunnels, will be using same destination for every tunnel.
Socks proxy
Socks proxy
-----------
-----------
@ -235,7 +241,7 @@ keys = socks-keys.dat
Option | Description
Option | Description
--------------------|--------------------
--------------------|--------------------
address | local address Socks proxy binds to, defaults to `127.0.0.1`
address | Local address Socks proxy binds to (default: `127.0.0.1`)
port | TCP port Socks proxy binds to
port | TCP port Socks proxy binds to
I2CP parameters
I2CP parameters
@ -245,22 +251,23 @@ These I2CP parameter are common for all tunnel types and specify settings for a
weko
2 years ago