mirror of
https://github.com/PurpleI2P/i2pd.git
synced 2025-04-27 19:27:49 +02:00
Improve i2pd.conf example
- In case of default port setting, change it to `0` so that a random one would be assigned for i2pd in case where user uncomments the setting without changing the port - In case of ipv6 setting change it to `true` since the default behaviour is to not use IPv6, and the only reason to uncomment it would be to set it to `true`. - try to specify default values and/or default behaviour - make things more consistent - remove trailing whitespaces - formatting
This commit is contained in:
Zetok Zalbavar
parent
97d9795fc9
commit
f078a49115
1 changed files with 283 additions and 177 deletions
|
|
@ -1,231 +1,337 @@
|
||||||
## Configuration file for a typical i2pd user
|
# Configuration file for a typical i2pd user
|
||||||
## See https://i2pd.readthedocs.io/en/latest/user-guide/configuration/
|
# See https://i2pd.readthedocs.io/en/latest/user-guide/configuration/
|
||||||
## for more options you can use in this file.
|
# for more options you can use in this file.
|
||||||
|
|
||||||
## Lines that begin with "## " try to explain what's going on. Lines
|
# Lines that begin with "# " (hashtag space) try to explain what's going on.
|
||||||
## that begin with just "#" are disabled commands: you can enable them
|
# Lines that begin with just "#" are disabled commands: you can enable them by
|
||||||
## by removing the "#" symbol.
|
# removing the "#" symbol.
|
||||||
|
|
||||||
## Tunnels config file
|
|
||||||
## Default: ~/.i2pd/tunnels.conf or /var/lib/i2pd/tunnels.conf
|
|
||||||
# tunconf = /var/lib/i2pd/tunnels.conf
|
|
||||||
|
|
||||||
## Tunnels config files path
|
# Tunnels config file
|
||||||
## Use that path to store separated tunnels in different config files.
|
# Default: ~/.i2pd/tunnels.conf or /var/lib/i2pd/tunnels.conf
|
||||||
## Default: ~/.i2pd/tunnels.d or /var/lib/i2pd/tunnels.d
|
#tunconf = /var/lib/i2pd/tunnels.conf
|
||||||
# tunnelsdir = /var/lib/i2pd/tunnels.conf.d
|
|
||||||
|
|
||||||
## Where to write pidfile (don't write by default)
|
# Tunnels config files path
|
||||||
# pidfile = /var/run/i2pd.pid
|
# Use that path to store separated tunnels in different config files.
|
||||||
|
# Default: ~/.i2pd/tunnels.d or /var/lib/i2pd/tunnels.d
|
||||||
|
#tunnelsdir = /var/lib/i2pd/tunnels.conf.d
|
||||||
|
|
||||||
## Logging configuration section
|
# Where to write pidfile
|
||||||
## By default logs go to stdout with level 'info' and higher
|
# By default i2pd doesn't create pidfile
|
||||||
##
|
#pidfile = /var/run/i2pd.pid
|
||||||
## Logs destination (valid values: stdout, file, syslog)
|
|
||||||
## * stdout - print log entries to stdout
|
|
||||||
## * file - log entries to a file
|
|
||||||
## * syslog - use syslog, see man 3 syslog
|
|
||||||
# log = file
|
|
||||||
## Path to logfile (default - autodetect)
|
|
||||||
# logfile = /var/log/i2pd.log
|
|
||||||
## Log messages above this level (debug, *info, warn, error, none)
|
|
||||||
## If you set it to none, logging will be disabled
|
|
||||||
# loglevel = info
|
|
||||||
## Write full CLF-formatted date and time to log (default: write only time)
|
|
||||||
# logclftime = true
|
|
||||||
|
|
||||||
## Daemon mode. Router will go to background after start
|
|
||||||
# daemon = true
|
|
||||||
|
|
||||||
## Specify a family, router belongs to (default - none)
|
# Logging
|
||||||
# family =
|
#
|
||||||
|
# Log destination
|
||||||
|
# Valid values:
|
||||||
|
# * stdout - print log entries to stdout
|
||||||
|
# * file - log entries to a file
|
||||||
|
# * syslog - use syslog, see man 3 syslog
|
||||||
|
#log = file
|
||||||
|
|
||||||
## External IP address to listen for connections
|
# Path to logfile (default - autodetect)
|
||||||
## By default i2pd sets IP automatically
|
#logfile = /var/log/i2pd.log
|
||||||
# host = 1.2.3.4
|
|
||||||
|
|
||||||
## Port to listen for connections
|
# Log level
|
||||||
## By default i2pd picks random port. You MUST pick a random number too,
|
# Valid values listed from smallest amount of logging to highest:
|
||||||
## don't just uncomment this
|
# * none - disables logging
|
||||||
# port = 4567
|
# * error
|
||||||
|
# * warn
|
||||||
|
# * info - logs go to stdout
|
||||||
|
# * debug - logs go to stdout
|
||||||
|
#loglevel = info
|
||||||
|
|
||||||
## Enable communication through ipv4
|
# Write full CLF-formatted date and time to log
|
||||||
ipv4 = true
|
# By default i2pd write only time, no date
|
||||||
## Enable communication through ipv6
|
#logclftime = true
|
||||||
ipv6 = false
|
|
||||||
|
|
||||||
## Network interface to bind to
|
# Daemon mode. Router will go to background after start.
|
||||||
# ifname =
|
#daemon = true
|
||||||
## You can specify different interfaces for IPv4 and IPv6
|
|
||||||
# ifname4 =
|
|
||||||
# ifname6 =
|
|
||||||
|
|
||||||
## Enable NTCP transport (default = true)
|
# Specify a family the router belongs to
|
||||||
# ntcp = true
|
# By default there's no family specified
|
||||||
## If you run i2pd behind a proxy server, you can only use NTCP transport with ntcpproxy option
|
#family =
|
||||||
## Should be http://address:port or socks://address:port
|
|
||||||
# ntcpproxy = http://127.0.0.1:8118
|
|
||||||
## Enable SSU transport (default = true)
|
|
||||||
# ssu = true
|
|
||||||
|
|
||||||
## Should we assume we are behind NAT? (false only in MeshNet)
|
# External IP address to listen for connections
|
||||||
# nat = true
|
# By default i2pd sets IP automatically
|
||||||
|
#host = 1.2.3.4
|
||||||
|
|
||||||
## Bandwidth configuration
|
# Port to listen for connections
|
||||||
## L limit bandwidth to 32KBs/sec, O - to 256KBs/sec, P - to 2048KBs/sec,
|
# By default i2pd picks random port.
|
||||||
## X - unlimited
|
# Value range: 0-65535
|
||||||
## Default is X for floodfill, L for regular node
|
#port = 0
|
||||||
# bandwidth = L
|
|
||||||
## Max % of bandwidth limit for transit. 0-100. 100 by default
|
|
||||||
# share = 100
|
|
||||||
|
|
||||||
## Router will not accept transit tunnels, disabling transit traffic completely
|
# Enable communication through IPv4
|
||||||
## (default = false)
|
# Default: true
|
||||||
# notransit = true
|
#ipv4 = true
|
||||||
|
|
||||||
|
# Enable communication through IPv6
|
||||||
|
# Default: false
|
||||||
|
#ipv6 = true
|
||||||
|
|
||||||
|
# Network interface to bind to
|
||||||
|
#ifname =
|
||||||
|
# You can specify different interfaces for IPv4 and IPv6
|
||||||
|
#ifname4 =
|
||||||
|
#ifname6 =
|
||||||
|
|
||||||
|
# Enable NTCP transport
|
||||||
|
# Default: true
|
||||||
|
#ntcp = true
|
||||||
|
|
||||||
|
# If you run i2pd behind a proxy server, you can only use NTCP transport with
|
||||||
|
# ntcpproxy option.
|
||||||
|
# Example: http://address:port or socks://address:port
|
||||||
|
#ntcpproxy = http://127.0.0.1:8118
|
||||||
|
|
||||||
|
# Enable SSU transport
|
||||||
|
# Default: true
|
||||||
|
#ssu = true
|
||||||
|
|
||||||
|
# Should we assume we are behind NAT?
|
||||||
|
# Default in MeshNet: false
|
||||||
|
# Default: true
|
||||||
|
#nat = true
|
||||||
|
|
||||||
|
# Bandwidth limit
|
||||||
|
# Set to a valid letter or a number of KB/s
|
||||||
|
# Valid letters:
|
||||||
|
# * L - up to 32 KB/s
|
||||||
|
# * O - up to 256 KB/s
|
||||||
|
# * P - up to 2048 KB/s
|
||||||
|
# * X - unlimited
|
||||||
|
# Value range: 1-9000
|
||||||
|
# Default for floodfill: X
|
||||||
|
# Default: L
|
||||||
|
#bandwidth = L
|
||||||
|
|
||||||
|
# Max % of bandwidth limit for transit.
|
||||||
|
# Value range: 0-100
|
||||||
|
# Default: 100
|
||||||
|
#share = 100
|
||||||
|
|
||||||
|
# Don't accept transit tunnels, disabling transit traffic completely
|
||||||
|
# Default: false
|
||||||
|
#notransit = true
|
||||||
|
|
||||||
|
# Router will be floodfill
|
||||||
|
# Default: false
|
||||||
|
#floodfill = true
|
||||||
|
|
||||||
## Router will be floodfill
|
|
||||||
# floodfill = true
|
|
||||||
|
|
||||||
[http]
|
[http]
|
||||||
## Web Console settings
|
# Web Console settings
|
||||||
## Uncomment and set to 'false' to disable Web Console
|
# Set to 'false' to disable Web Console
|
||||||
# enabled = true
|
# Default: true
|
||||||
## Address and port service will listen on
|
#enabled = true
|
||||||
|
|
||||||
|
# Address and port service will listen on
|
||||||
address = 127.0.0.1
|
address = 127.0.0.1
|
||||||
port = 7070
|
port = 7070
|
||||||
## Path to web console, default "/"
|
|
||||||
# webroot = /
|
# Path to web console
|
||||||
## Uncomment following lines to enable Web Console authentication
|
# Default: /
|
||||||
# auth = true
|
#webroot = /
|
||||||
# user = i2pd
|
|
||||||
# pass = changeme
|
# Enable Web Console authentication
|
||||||
|
#auth = true
|
||||||
|
#user = i2pd
|
||||||
|
#pass = changeme
|
||||||
|
|
||||||
|
|
||||||
[httpproxy]
|
[httpproxy]
|
||||||
## Uncomment and set to 'false' to disable HTTP Proxy
|
# httpproxy section also accepts I2CP parameters, like "inbound.length" etc.
|
||||||
# enabled = true
|
|
||||||
## Address and port service will listen on
|
# Set to 'false' to disable HTTP Proxy
|
||||||
|
# Default: true
|
||||||
|
#enabled = true
|
||||||
|
|
||||||
|
# Address and port service will listen on
|
||||||
address = 127.0.0.1
|
address = 127.0.0.1
|
||||||
port = 4444
|
port = 4444
|
||||||
## Optional keys file for proxy local destination
|
|
||||||
# keys = http-proxy-keys.dat
|
# Optional keys file for proxy local destination
|
||||||
## Enable address helper for adding .i2p domains with "jump URLs" (default: true)
|
#keys = http-proxy-keys.dat
|
||||||
# addresshelper = true
|
|
||||||
## Address of a proxy server inside I2P, which is used to visit regular Internet
|
# Enable address helper for adding .i2p domains with "jump URLs"
|
||||||
# outproxy = http://false.i2p
|
# Default: true
|
||||||
## httpproxy section also accepts I2CP parameters, like "inbound.length" etc.
|
#addresshelper = true
|
||||||
|
|
||||||
|
# Address of a proxy server inside I2P, which is used to visit regular Internet
|
||||||
|
#outproxy = http://false.i2p
|
||||||
|
|
||||||
|
|
||||||
[socksproxy]
|
[socksproxy]
|
||||||
## Uncomment and set to 'false' to disable SOCKS Proxy
|
# socksproxy section also accepts I2CP parameters, like "inbound.length" etc.
|
||||||
# enabled = true
|
|
||||||
## Address and port service will listen on
|
# Set to 'false' to disable SOCKS Proxy
|
||||||
|
# Default: true
|
||||||
|
#enabled = true
|
||||||
|
|
||||||
|
# Address and port service will listen on
|
||||||
address = 127.0.0.1
|
address = 127.0.0.1
|
||||||
port = 4447
|
port = 4447
|
||||||
## Optional keys file for proxy local destination
|
# Optional keys file for proxy local destination
|
||||||
# keys = socks-proxy-keys.dat
|
#keys = socks-proxy-keys.dat
|
||||||
## Socks outproxy. Example below is set to use Tor for all connections except i2p
|
|
||||||
## Uncomment and set to 'true' to enable using of SOCKS outproxy
|
# Socks outproxy.
|
||||||
# outproxy.enabled = false
|
# Set to 'true' to enable using of SOCKS outproxy
|
||||||
## Address and port of outproxy
|
# Default: false
|
||||||
# outproxy = 127.0.0.1
|
#outproxy.enabled = false
|
||||||
# outproxyport = 9050
|
|
||||||
## socksproxy section also accepts I2CP parameters, like "inbound.length" etc.
|
# Address and port of outproxy
|
||||||
|
# Example is set to use default Tor port for all connections except i2p
|
||||||
|
#outproxy = 127.0.0.1
|
||||||
|
#outproxyport = 9050
|
||||||
|
|
||||||
|
|
||||||
[sam]
|
[sam]
|
||||||
## Uncomment and set to 'true' to enable SAM Bridge
|
# Set to 'true' to enable SAM Bridge
|
||||||
enabled = true
|
enabled = true
|
||||||
## Address and port service will listen on
|
|
||||||
# address = 127.0.0.1
|
# Address and port service will listen on
|
||||||
# port = 7656
|
#address = 127.0.0.1
|
||||||
|
#port = 7656
|
||||||
|
|
||||||
|
|
||||||
[bob]
|
[bob]
|
||||||
## Uncomment and set to 'true' to enable BOB command channel
|
# Set to 'true' to enable BOB command channel
|
||||||
# enabled = false
|
#enabled = false
|
||||||
## Address and port service will listen on
|
|
||||||
# address = 127.0.0.1
|
# Address and port service will listen on
|
||||||
# port = 2827
|
#address = 127.0.0.1
|
||||||
|
#port = 2827
|
||||||
|
|
||||||
|
|
||||||
[i2cp]
|
[i2cp]
|
||||||
## Uncomment and set to 'true' to enable I2CP protocol
|
# Set to 'true' to enable I2CP protocol
|
||||||
# enabled = false
|
#enabled = false
|
||||||
## Address and port service will listen on
|
|
||||||
# address = 127.0.0.1
|
# Address and port service will listen on
|
||||||
# port = 7654
|
#address = 127.0.0.1
|
||||||
|
#port = 7654
|
||||||
|
|
||||||
|
|
||||||
[i2pcontrol]
|
[i2pcontrol]
|
||||||
## Uncomment and set to 'true' to enable I2PControl protocol
|
# Set to 'true' to enable I2PControl protocol
|
||||||
# enabled = false
|
#enabled = false
|
||||||
## Address and port service will listen on
|
|
||||||
# address = 127.0.0.1
|
# Address and port service will listen on
|
||||||
# port = 7650
|
#address = 127.0.0.1
|
||||||
## Authentication password. "itoopie" by default
|
#port = 7650
|
||||||
# password = itoopie
|
|
||||||
|
# Authentication password.
|
||||||
|
# Default: itoopie
|
||||||
|
#password = itoopie
|
||||||
|
|
||||||
|
|
||||||
[precomputation]
|
[precomputation]
|
||||||
## Enable or disable elgamal precomputation table
|
# Enable or disable elgamal precomputation table
|
||||||
## By default, enabled on i386 hosts
|
# Default on i386: true
|
||||||
# elgamal = true
|
# Default: false
|
||||||
|
#elgamal = true
|
||||||
|
|
||||||
|
|
||||||
[upnp]
|
[upnp]
|
||||||
## Enable or disable UPnP: automatic port forwarding (enabled by default in WINDOWS, ANDROID)
|
# Enable or disable UPnP: automatic port forwarding
|
||||||
# enabled = false
|
# By default enabled in Windows and Android
|
||||||
## Name i2pd appears in UPnP forwardings list (default = I2Pd)
|
#enabled = false
|
||||||
# name = I2Pd
|
|
||||||
|
# Name i2pd appears in UPnP forwardings list
|
||||||
|
# Default: I2Pd
|
||||||
|
#name = I2Pd
|
||||||
|
|
||||||
|
|
||||||
[reseed]
|
[reseed]
|
||||||
## Options for bootstrapping into I2P network, aka reseeding
|
# Options for bootstrapping into I2P network, aka reseeding
|
||||||
## Enable or disable reseed data verification.
|
# Enable or disable reseed data verification.
|
||||||
verify = true
|
verify = true
|
||||||
## URLs to request reseed data from, separated by comma
|
|
||||||
## Default: "mainline" I2P Network reseeds
|
# URLs to request reseed data from, separated by comma
|
||||||
# urls = https://reseed.i2p-projekt.de/,https://i2p.mooo.com/netDb/,https://netdb.i2p2.no/
|
# By default "mainline" I2P Network reseeds
|
||||||
## Path to local reseed data file (.su3) for manual reseeding
|
#urls = https://reseed.i2p-projekt.de/,https://i2p.mooo.com/netDb/,https://netdb.i2p2.no/
|
||||||
# file = /path/to/i2pseeds.su3
|
|
||||||
## or HTTPS URL to reseed from
|
# Path to a local reseed data file (.su3) or a HTTPS URL for manual reseeding
|
||||||
# file = https://legit-website.com/i2pseeds.su3
|
#file = /path/to/i2pseeds.su3
|
||||||
## Path to local ZIP file or HTTPS URL to reseed from
|
#file = https://legit-website.com/i2pseeds.su3
|
||||||
# zipfile = /path/to/netDb.zip
|
|
||||||
## If you run i2pd behind a proxy server, set proxy server for reseeding here
|
# Path to a local ZIP file or HTTPS URL to reseed from
|
||||||
## Should be http://address:port or socks://address:port
|
#zipfile = /path/to/netDb.zip
|
||||||
# proxy = http://127.0.0.1:8118
|
|
||||||
## Minimum number of known routers, below which i2pd triggers reseeding. 25 by default
|
# If you run i2pd behind a proxy server, set proxy server for reseeding here
|
||||||
# threshold = 25
|
# Example values:
|
||||||
|
# * http://address:port
|
||||||
|
# * socks://address:port
|
||||||
|
#proxy = http://127.0.0.1:8118
|
||||||
|
|
||||||
|
# Minimum number of known routers, below which i2pd triggers reseeding.
|
||||||
|
# Default: 25
|
||||||
|
#threshold = 25
|
||||||
|
|
||||||
|
|
||||||
[addressbook]
|
[addressbook]
|
||||||
## AddressBook subscription URL for initial setup
|
# AddressBook subscription URL for initial setup
|
||||||
## Default: inr.i2p at "mainline" I2P Network
|
# By default inr.i2p at "mainline" I2P Network
|
||||||
# defaulturl = http://joajgazyztfssty4w2on5oaqksz6tqoxbduy553y34mf4byv6gpq.b32.i2p/export/alive-hosts.txt
|
#defaulturl = http://joajgazyztfssty4w2on5oaqksz6tqoxbduy553y34mf4byv6gpq.b32.i2p/export/alive-hosts.txt
|
||||||
## Optional subscriptions URLs, separated by comma
|
|
||||||
# subscriptions = http://inr.i2p/export/alive-hosts.txt,http://stats.i2p/cgi-bin/newhosts.txt,http://rus.i2p/hosts.txt
|
# Optional subscriptions URLs, separated by comma
|
||||||
|
#subscriptions = http://inr.i2p/export/alive-hosts.txt,http://stats.i2p/cgi-bin/newhosts.txt,http://rus.i2p/hosts.txt
|
||||||
|
|
||||||
|
|
||||||
[limits]
|
[limits]
|
||||||
## Maximum active transit sessions (default:2500)
|
# Maximum active transit sessions
|
||||||
# transittunnels = 2500
|
# Default: 2500
|
||||||
## Limit number of open file descriptors (0 - use system limit)
|
#transittunnels = 2500
|
||||||
# openfiles = 0
|
|
||||||
## Maximum size of corefile in Kb (0 - use system limit)
|
# Limit number of open file descriptors
|
||||||
# coresize = 0
|
# Special values:
|
||||||
## Threshold to start probabalistic backoff with ntcp sessions (0 - use system limit)
|
# * 0 - use system limit
|
||||||
# ntcpsoft = 0
|
# Default: 0
|
||||||
## Maximum number of ntcp sessions (0 - use system limit)
|
#openfiles = 0
|
||||||
# ntcphard = 0
|
|
||||||
|
# Maximum size of corefile in Kb
|
||||||
|
# Special values:
|
||||||
|
# * 0 - use system limit
|
||||||
|
#coresize = 0
|
||||||
|
|
||||||
|
# Threshold to start probabilistic backoff with ntcp sessions
|
||||||
|
# Special values:
|
||||||
|
# * 0 - use system limit
|
||||||
|
#ntcpsoft = 0
|
||||||
|
|
||||||
|
# Maximum number of ntcp sessions
|
||||||
|
# Special values:
|
||||||
|
# * 0 - use system limit
|
||||||
|
#ntcphard = 0
|
||||||
|
|
||||||
|
|
||||||
[trust]
|
[trust]
|
||||||
## Enable explicit trust options. false by default
|
# Enable explicit trust options.
|
||||||
# enabled = true
|
# Default: false
|
||||||
## Make direct I2P connections only to routers in specified Family.
|
#enabled = true
|
||||||
# family = MyFamily
|
|
||||||
## Make direct I2P connections only to routers specified here. Comma separated list of base64 identities.
|
# Make direct I2P connections only to routers in specified Family.
|
||||||
# routers =
|
#family = MyFamily
|
||||||
## Should we hide our router from other routers? false by default
|
|
||||||
# hidden = true
|
# Make direct I2P connections only to routers specified here. Comma separated
|
||||||
|
# list of base64 identities.
|
||||||
|
#routers =
|
||||||
|
|
||||||
|
# Should we hide our router from other routers?
|
||||||
|
# Default: false
|
||||||
|
#hidden = true
|
||||||
|
|
||||||
|
|
||||||
[exploratory]
|
[exploratory]
|
||||||
## Exploratory tunnels settings with default values
|
# Exploratory tunnels settings with default values
|
||||||
# inbound.length = 2
|
#inbound.length = 2
|
||||||
# inbound.quantity = 3
|
#inbound.quantity = 3
|
||||||
# outbound.length = 2
|
#outbound.length = 2
|
||||||
# outbound.quantity = 3
|
#outbound.quantity = 3
|
||||||
|
|
||||||
|
|
||||||
[persist]
|
[persist]
|
||||||
## Save peer profiles on disk (default: true)
|
# Save peer profiles on disk
|
||||||
# profiles = true
|
# Default: true
|
||||||
|
#profiles = true
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue