PurpleI2P
/
i2pd_docs_en
mirror of https://github.com/PurpleI2P/i2pd_docs_en
1
0
Fork 0
Code Issues Releases Wiki Activity
Browse Source

update styling, add notes

pull/76/head
R4SAS 2 years ago committed by GitHub
parent
cb5a39147c
commit
01957cde2f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 113 additions and 99 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 212
      docs/user-guide/tunnels.md

212
docs/user-guide/tunnels.md
Unescape View File

@ -5,25 +5,25 @@ Overview
-------- --------
`tunnels.conf` is designed to support multiple I2P tunnels. The configuration file must be located in `tunnels.conf` is designed to support multiple I2P tunnels. The configuration file must be located in
``~/.i2pd`` (per-user) or ``/var/lib/i2pd`` (system-wide). ``~/.i2pd`` (per-user) or ``/var/lib/i2pd`` (system-wide) on Unix-based systems, and ``%APPDATA%/i2pd`` (per-user) on Windows.
This file uses the .ini file format. It consists of multiple sections each with a unique name. This file uses the .ini file format. It consists of multiple sections each with a unique name.
Tunnel types Tunnel types
------------ ------------
Section type is specified by the *type* parameter. Section type is specified by the *type* parameter.
Available tunnel types: Available tunnel types:
Type | Description Type | Description
------------- | -------------------------------------- ------------- | --------------------------------------
client | Client tunnel to remote I2P destination (TCP) client | Client tunnel to remote I2P destination (TCP)
server | Generic server tunnel to setup any TCP service in I2P network server | Generic server tunnel to setup any TCP service in I2P network
http | HTTP server tunnel to setup a website in I2P http | HTTP server tunnel to setup a website in I2P
irc | IRC server tunnel to setup IRC server in I2P irc | IRC server tunnel to setup IRC server in I2P
udpclient | Forwards local UDP endpoint to remote I2P destination udpclient | Forwards local UDP endpoint to remote I2P destination
udpserver | Forwards traffic from N I2P destinations to local UDP endpoint udpserver | Forwards traffic from N I2P destinations to local UDP endpoint
socks | Custom Socks proxy service to use I2P with socks | Custom Socks proxy service to use I2P with
httpproxy | Custom HTTP proxy service to use I2P with httpproxy | Custom HTTP proxy service to use I2P with
@ -82,22 +82,25 @@ Each client tunnel must contain a few mandatory parameters, along with some opti
Here is an example of a client tunnel: Here is an example of a client tunnel:
[irc-out] ```ini
type = client [irc-out]
address = 127.0.0.1 type = client
port = 6668 address = 127.0.0.1
destination = irc.ilita.i2p port = 6668
keys = irc.dat destination = irc.ilita.i2p
keys = irc.dat
```
If *keys* is empty, transient keys will be created on every restart. If the keys file is not found, new keys will be created and stored into the specified file.
If *keys* starts from *transient*, new keys will be created, but not stored into a file.
If *keys* is empty, transient keys will be created on every restart. If the keys file is not found, new keys will be created and stored into the specified file.
If *keys* starts from *transient*, new keys will be created, but not stored into a file.
Client tunnels might share the same local destination, if the keys file contains the same identity. Client tunnels might share the same local destination, if the keys file contains the same identity.
Optional parameters: 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. '127.0.0.1' by default
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 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
cryptotype | crypto type for new keys. Experimental. Should be always 0 cryptotype | crypto type for new keys. Experimental. Should be always 0
destinationport | connect to particular port at destination. 0 by default (targeting first tunnel on server side for destination) destinationport | connect to particular port at destination. 0 by default (targeting first tunnel on server side for destination)
@ -112,26 +115,32 @@ Mnemonic: we serving some service to others in network
Here is an example of a server tunnel: Here is an example of a server tunnel:
[smtp-in] ```ini
type = server [smtp-in]
host = 127.0.0.1 type = server
port = 25 host = 127.0.0.1
keys = smtp-in.dat port = 25
keys = smtp-in.dat
```
If *keys* is empty, transient keys will be created on every restart. If the *keys* file is not found, new keys will be created and stored into the specified file.
The file in *keys* must be present, and the LeaseSet of address from keys file will be published. Destination address from *keys* file will be loaded and the LeaseSet of address will be published.
The server tunnel must use its own local destination such as host 127.0.0.1 and port 80. The server tunnel must use its own destination such as host 127.0.0.1 and port 80.
This tunnel type should be used for any protocol other than HTTP, even HTTP with SSL encryption (HTTPS).
Optional parameters: Optional parameters:
Option | Description Option | Description
--------------------|-------------------- --------------------|--------------------
inport | what port at local destination server tunnel listens to. Same as *port* 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. 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. 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, 11 -RedDSA. 7 by default. signaturetype | means signature type for new keys. 0 - DSA, 1- ECDSA-P256, 7 -EDDSA, 11 -RedDSA. 7 by default
cryptotype | crypto type for new keys. Experimental. Should be always 0. 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. true by default. 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
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
Server/http tunnels Server/http tunnels
------------------- -------------------
@ -141,11 +150,13 @@ must be assigned to the address provided in configuration. i2pd will also resolv
Here's an example of an http tunnel: Here's an example of an http tunnel:
[http-in] ```ini
type = http [http-in]
host = 127.0.0.1 type = http
port = 80 host = 127.0.0.1
keys = our-website.dat port = 80
keys = our-website.dat
```
Optional parameters: Optional parameters:
@ -158,8 +169,7 @@ ssl | use SSL connection to upstream server. `hostoverride` para
Server/IRC tunnels Server/IRC tunnels
------------------- -------------------
IRC tunnels are supposed to connect to an IRC server through WEBIRC. 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.
It replaces IP address (usually 127.0.0.1) to user's .b32 I2P address.
Optional parameters: Optional parameters:
@ -175,34 +185,36 @@ There are 2 types of UDP tunnels: `udpclient` and `udpserver`
`udpclient` forwards 1 local UDP endpoint to 1 remote I2P destination `udpclient` forwards 1 local UDP endpoint to 1 remote I2P destination
```ini
[openvpn-client-simple] [openvpn-client-simple]
type = udpclient type = udpclient
destination = something.b32.i2p destination = something.b32.i2p
port = 1194 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, defaults to `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. true by default
`udpserver` forwards traffic from N I2P destinations to 1 local UDP endpoint `udpserver` forwards traffic from N I2P destinations to 1 local UDP endpoint
[openvpn-simple-server] ```ini
type = udpserver [openvpn-simple-server]
keys = openvpn.dat type = udpserver
host = 127.0.0.1 keys = openvpn.dat
port = 1194 host = 127.0.0.1
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, defaults to `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. true by default
Socks proxy Socks proxy
----------- -----------
@ -211,18 +223,19 @@ The SOCKS proxy interface can be defined in ``tunnels.conf``.
Here's an example of a Socks proxy: Here's an example of a Socks proxy:
[alt-socks] ```ini
type = socks [alt-socks]
address = 127.0.0.1 type = socks
port = 14447 address = 127.0.0.1
keys = socks-keys.dat port = 14447
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, defaults to `127.0.0.1`
port | TCP port Socks proxy binds to port | TCP port Socks proxy binds to
I2CP parameters I2CP parameters
--------------- ---------------
@ -239,53 +252,54 @@ outbound.lengthVariance | random number of hops to add or subtract to an o
crypto.tagsToSend | number of ElGamal/AES tags to send. 40 by default; too low value may cause problems with tunnel building 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 explicitPeers | list of comma-separated b64 addresses of peers to use, default: unset
i2p.streaming.initialAckDelay | milliseconds to wait before sending Ack. 200 by default i2p.streaming.initialAckDelay | milliseconds to wait before sending Ack. 200 by default
i2p.streaming.answerPings | enable sending pongs. true by default i2p.streaming.answerPings | enable sending pongs. true by default
i2cp.leaseSetType | type of LeaseSet to be sent. 1, 3 or 5. 1 by default i2cp.leaseSetType | type of LeaseSet to be sent. 1, 3 or 5. 1 by default
i2cp.leaseSetEncType | comma separated encryption types to be used in LeaseSet type 3 or 5. Identity's type by default i2cp.leaseSetEncType | comma separated encryption types to be used in LeaseSet type 3 or 5. Identity's type by default
i2cp.leaseSetPrivKey | decryption key for encrypted LeaseSet in base64. PSK or private DH i2cp.leaseSetPrivKey | decryption key for encrypted LeaseSet in base64. PSK or private DH
i2cp.leaseSetAuthType | authentication type for encrypted LeaseSet. 0 - no authentication(default), 1 - DH, 2 - PSK i2cp.leaseSetAuthType | authentication type for encrypted LeaseSet. 0 - no authentication(default), 1 - DH, 2 - PSK
i2cp.leaseSetClient.dh.nnn | client name:client's public DH in base64, for authentication type 1, nnn is integer i2cp.leaseSetClient.dh.nnn | client name:client's public DH in base64, for authentication type 1, nnn is integer
i2cp.leaseSetClient.psk.nnn | client name:client's PSK in base64, for authentication type 2, nnn is integer i2cp.leaseSetClient.psk.nnn | client name:client's PSK in base64, for authentication type 2, nnn is integer
Other examples Other examples
-------------- --------------
# outgoing tunnel sample, to remote service ```ini
# mandatory parameters: # outgoing tunnel sample, to remote service
# * type -- always "client" # mandatory parameters:
# * port -- local port to listen to # * type -- always "client"
# * destination -- I2P hostname # * port -- local port to listen to
# optional parameters (may be omitted) # * destination -- I2P hostname
# * keys -- our identity, if unset, will be generated on every startup, # optional parameters (may be omitted)
# if set and file missing, keys will be generated and placed to this file # * keys -- our identity, if unset, will be generated on every startup,
# * address -- local interface to bind # if set and file missing, keys will be generated and placed to this file
# * signaturetype -- signature type for new destination. 0 (DSA/SHA1), 1 (EcDSA/SHA256) or 7 (EdDSA/SHA512) # * address -- local interface to bind
[IRC] # * signaturetype -- signature type for new destination. 0 (DSA/SHA1), 1 (EcDSA/SHA256) or 7 (EdDSA/SHA512)
type = client [IRC]
address = 127.0.0.1 type = client
port = 6668 address = 127.0.0.1
destination = irc.ilita.i2p port = 6668
keys = irc-keys.dat destination = irc.ilita.i2p
# keys = irc-keys.dat
# incoming tunnel sample, for local service #
# mandatory parameters: # incoming tunnel sample, for local service
# * type -- "server" or "http" # mandatory parameters:
# * host -- IP address of our service # * type -- "server" or "http"
# * port -- port of our service # * host -- IP address of our service
# * keys -- file with LeaseSet of address in i2p # * port -- port of our service
# optional parameters (may be omitted) # * keys -- file with LeaseSet of address in i2p
# * inport -- optional, I2P service port, if unset - the same as 'port' # optional parameters (may be omitted)
# * accesslist -- comma-separated list of I2P addresses, allowed to connect # * inport -- optional, I2P service port, if unset - the same as 'port'
# every address is b32 without '.b32.i2p' part # * accesslist -- comma-separated list of I2P addresses, allowed to connect
[LOCALSITE] # every address is b32 without '.b32.i2p' part
type = http [LOCALSITE]
host = 127.0.0.1 type = http
port = 80 host = 127.0.0.1
keys = site-keys.dat port = 80
# keys = site-keys.dat
[IRC-SERVER] #
type = server [IRC-SERVER]
host = 127.0.0.1 type = server
port = 6667 host = 127.0.0.1
keys = irc.dat port = 6667
keys = irc.dat
```

Write Preview
Loading…
Cancel
Save