i2pd/contrib/i2pd.conf
Zetok Zalbavar f078a49115
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
2019-07-24 20:44:46 +01:00

337 lines
7.4 KiB
Text

# Configuration file for a typical i2pd user
# See https://i2pd.readthedocs.io/en/latest/user-guide/configuration/
# for more options you can use in this file.
# Lines that begin with "# " (hashtag space) try to explain what's going on.
# Lines that begin with just "#" are disabled commands: you can enable them by
# 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
# 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
# Where to write pidfile
# By default i2pd doesn't create pidfile
#pidfile = /var/run/i2pd.pid
# Logging
#
# 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
# Path to logfile (default - autodetect)
#logfile = /var/log/i2pd.log
# Log level
# Valid values listed from smallest amount of logging to highest:
# * none - disables logging
# * error
# * warn
# * info - logs go to stdout
# * debug - logs go to stdout
#loglevel = info
# Write full CLF-formatted date and time to log
# By default i2pd write only time, no date
#logclftime = true
# Daemon mode. Router will go to background after start.
#daemon = true
# Specify a family the router belongs to
# By default there's no family specified
#family =
# External IP address to listen for connections
# By default i2pd sets IP automatically
#host = 1.2.3.4
# Port to listen for connections
# By default i2pd picks random port.
# Value range: 0-65535
#port = 0
# Enable communication through IPv4
# Default: 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
[http]
# Web Console settings
# Set to 'false' to disable Web Console
# Default: true
#enabled = true
# Address and port service will listen on
address = 127.0.0.1
port = 7070
# Path to web console
# Default: /
#webroot = /
# Enable Web Console authentication
#auth = true
#user = i2pd
#pass = changeme
[httpproxy]
# httpproxy section also accepts I2CP parameters, like "inbound.length" etc.
# Set to 'false' to disable HTTP Proxy
# Default: true
#enabled = true
# Address and port service will listen on
address = 127.0.0.1
port = 4444
# Optional keys file for proxy local destination
#keys = http-proxy-keys.dat
# Enable address helper for adding .i2p domains with "jump URLs"
# Default: true
#addresshelper = true
# Address of a proxy server inside I2P, which is used to visit regular Internet
#outproxy = http://false.i2p
[socksproxy]
# socksproxy section also accepts I2CP parameters, like "inbound.length" etc.
# Set to 'false' to disable SOCKS Proxy
# Default: true
#enabled = true
# Address and port service will listen on
address = 127.0.0.1
port = 4447
# Optional keys file for proxy local destination
#keys = socks-proxy-keys.dat
# Socks outproxy.
# Set to 'true' to enable using of SOCKS outproxy
# Default: false
#outproxy.enabled = false
# 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]
# Set to 'true' to enable SAM Bridge
enabled = true
# Address and port service will listen on
#address = 127.0.0.1
#port = 7656
[bob]
# Set to 'true' to enable BOB command channel
#enabled = false
# Address and port service will listen on
#address = 127.0.0.1
#port = 2827
[i2cp]
# Set to 'true' to enable I2CP protocol
#enabled = false
# Address and port service will listen on
#address = 127.0.0.1
#port = 7654
[i2pcontrol]
# Set to 'true' to enable I2PControl protocol
#enabled = false
# Address and port service will listen on
#address = 127.0.0.1
#port = 7650
# Authentication password.
# Default: itoopie
#password = itoopie
[precomputation]
# Enable or disable elgamal precomputation table
# Default on i386: true
# Default: false
#elgamal = true
[upnp]
# Enable or disable UPnP: automatic port forwarding
# By default enabled in Windows and Android
#enabled = false
# Name i2pd appears in UPnP forwardings list
# Default: I2Pd
#name = I2Pd
[reseed]
# Options for bootstrapping into I2P network, aka reseeding
# Enable or disable reseed data verification.
verify = true
# URLs to request reseed data from, separated by comma
# By default "mainline" I2P Network reseeds
#urls = https://reseed.i2p-projekt.de/,https://i2p.mooo.com/netDb/,https://netdb.i2p2.no/
# Path to a local reseed data file (.su3) or a HTTPS URL for manual reseeding
#file = /path/to/i2pseeds.su3
#file = https://legit-website.com/i2pseeds.su3
# Path to a local ZIP file or HTTPS URL to reseed from
#zipfile = /path/to/netDb.zip
# If you run i2pd behind a proxy server, set proxy server for reseeding here
# 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 subscription URL for initial setup
# By default inr.i2p at "mainline" I2P Network
#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
[limits]
# Maximum active transit sessions
# Default: 2500
#transittunnels = 2500
# Limit number of open file descriptors
# Special values:
# * 0 - use system limit
# Default: 0
#openfiles = 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]
# Enable explicit trust options.
# Default: false
#enabled = true
# Make direct I2P connections only to routers in specified Family.
#family = MyFamily
# 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 tunnels settings with default values
#inbound.length = 2
#inbound.quantity = 3
#outbound.length = 2
#outbound.quantity = 3
[persist]
# Save peer profiles on disk
# Default: true
#profiles = true