Browse Source

update styling, add notes

pull/76/head
R4SAS 2 years ago committed by GitHub
parent
commit
01957cde2f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 54
      docs/user-guide/tunnels.md

54
docs/user-guide/tunnels.md

@ -5,7 +5,7 @@ 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.
@ -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:
```ini
[irc-out] [irc-out]
type = client type = client
address = 127.0.0.1 address = 127.0.0.1
port = 6668 port = 6668
destination = irc.ilita.i2p destination = irc.ilita.i2p
keys = irc.dat 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* 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* 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:
```ini
[smtp-in] [smtp-in]
type = server type = server
host = 127.0.0.1 host = 127.0.0.1
port = 25 port = 25
keys = smtp-in.dat 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:
```ini
[http-in] [http-in]
type = http type = http
host = 127.0.0.1 host = 127.0.0.1
port = 80 port = 80
keys = our-website.dat 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
```ini
[openvpn-simple-server] [openvpn-simple-server]
type = udpserver type = udpserver
keys = openvpn.dat keys = openvpn.dat
host = 127.0.0.1 host = 127.0.0.1
port = 1194 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:
```ini
[alt-socks] [alt-socks]
type = socks type = socks
address = 127.0.0.1 address = 127.0.0.1
port = 14447 port = 14447
keys = socks-keys.dat 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
--------------- ---------------
@ -250,6 +263,7 @@ i2cp.leaseSetClient.psk.nnn | client name:client's PSK in base64, for authenti
Other examples Other examples
-------------- --------------
```ini
# outgoing tunnel sample, to remote service # outgoing tunnel sample, to remote service
# mandatory parameters: # mandatory parameters:
# * type -- always "client" # * type -- always "client"
@ -288,4 +302,4 @@ Other examples
host = 127.0.0.1 host = 127.0.0.1
port = 6667 port = 6667
keys = irc.dat keys = irc.dat
```

Loading…
Cancel
Save