PurpleI2P/i2pd_docs_en
1
0
Fork 0
mirror of https://github.com/PurpleI2P/i2pd_docs_en synced 2025-08-27 22:22:19 +00:00
Code Issues Releases Wiki Activity

add SSU2 documentation

Browse Source
This commit is contained in:
R4SAS 2022-08-19 22:50:52 +03:00 committed by GitHub
parent ce3492f678
commit 80f072ca0e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 22 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
docs/user-guide/configuration.md
View File

@ -75,13 +75,23 @@ ssu | Enable SSU transport protocol (use UDP)
`datadir` and `service` options are only used as arguments for i2pd, these options have no effect when set in `i2pd.conf`. `datadir` and `service` options are only used as arguments for i2pd, these options have no effect when set in `i2pd.conf`.
### Windows-specific options ### NTCP2
Option | Description Option | Description
-------------------------------------- | -------------------------------------- -------------------------------------- | --------------------------------------
svcctl | Windows service management (--svcctl="install" or --svcctl="remove") ntcp2.enabled | Enable NTCP2. Enabled by default
insomnia | Prevent system from sleeping ntcp2.published | Enable incoming NTCP2 connections. Enabled by default
close | Action on close: minimize, exit, ask ntcp2.port | Port to listen for incoming NTCP2 connections (default: auto)
ntcp2.addressv6 | External IPv6 for incoming connections
ntcp2.proxy | Specify proxy server for NTCP2. Should be http://address:port or socks://address:port
### SSU2
Option | Description
-------------------------------------- | --------------------------------------
ssu2.enabled | Enable SSU2. Disabled by default on 2.43.0
ssu2.published | Enable incoming SSU2 connections. Disabled by default on 2.43.0
ssu2.port | Port to listen for incoming SSU2 connections (default: auto - 'port' from general section or 'port + 1' if SSU is enabled)
All options below still possible in cmdline, but better write it in config file: All options below still possible in cmdline, but better write it in config file:
@ -234,16 +244,6 @@ exploratory.inbound.quantity | Exploratory inbound tunnels quantity. 3
exploratory.outbound.length | Exploratory outbound tunnels length. 2 by default exploratory.outbound.length | Exploratory outbound tunnels length. 2 by default
exploratory.outbound.quantity | Exploratory outbound tunnels quantity. 3 by default exploratory.outbound.quantity | Exploratory outbound tunnels quantity. 3 by default
### NTCP2
Option | Description
-------------------------------------- | --------------------------------------
ntcp2.enabled | Enable NTCP2. Enabled by default
ntcp2.published | Enable incoming NTCP2 connections. Enabled by default
ntcp2.port | Port to listen for incoming NTCP2 connections (default: auto)
ntcp2.addressv6 | External IPv6 for incoming connections
ntcp2.proxy | Specify proxy server for NTCP2. Should be http://address:port or socks://address:port
### Time sync ### Time sync
Option | Description Option | Description
@ -265,7 +265,14 @@ Option | Description
meshnets.yggdrasil | Support transports through the Yggdrasil meshnets.yggdrasil | Support transports through the Yggdrasil
meshnets.yggaddress | Local Yggdrasil's address to publish meshnets.yggaddress | Local Yggdrasil's address to publish
### UNIX-specific ### Windows-specific options
Option | Description
-------------------------------------- | --------------------------------------
insomnia | Prevent system from sleeping
close | Action on close: minimize, exit, ask
### UNIX-specific options
Option | Description Option | Description
-------------------------------------- | -------------------------------------- -------------------------------------- | --------------------------------------