[contrib] update example config file comments, remove ssu option

Signed-off-by: r4sas <r4sas@i2pmail.org>

contrib/i2pd.conf

@@ -19,7 +19,7 @@
 ## Default: ~/.i2pd/certificates or /var/lib/i2pd/certificates
 # certsdir = /var/lib/i2pd/certificates
 
-## Where to write pidfile (default: i2pd.pid, not used in Windows)
+## Where to write pidfile (default: /run/i2pd.pid, not used in Windows)
 # pidfile = /run/i2pd.pid
 
 ## Logging configuration section
@@ -31,7 +31,7 @@
 ##  * file - log entries to a file
 ##  * syslog - use syslog, see man 3 syslog
 # log = file
-## Path to logfile (default - autodetect)
+## Path to logfile (default: autodetect)
 # logfile = /var/log/i2pd/i2pd.log
 ## Log messages above this level (debug, info, *warn, error, critical, none)
 ## If you set it to none, logging will be disabled
@@ -40,6 +40,7 @@
 # logclftime = true
 
 ## Daemon mode. Router will go to background after start. Ignored on Windows
+## (default: true)
 # daemon = true
 
 ## Specify a family, router belongs to (default - none)
@@ -70,58 +71,60 @@
 ## don't just uncomment this
 # port = 4567
 
-## Enable communication through ipv4
+## Enable communication through ipv4 (default: true)
 ipv4 = true
-## Enable communication through ipv6
+## Enable communication through ipv6 (default: false)
 ipv6 = false
 
-## Enable SSU transport
-ssu = false
-
 ## Bandwidth configuration
-## L limit bandwidth to 32KBs/sec, O - to 256KBs/sec, P - to 2048KBs/sec,
+## L limit bandwidth to 32 KB/sec, O - to 256 KB/sec, P - to 2048 KB/sec,
 ## X - unlimited
-## Default is L (regular node) and X if floodfill mode enabled. If you want to
-## share more bandwidth without floodfill mode, uncomment that line and adjust
-## value to your possibilities
+## Default is L (regular node) and X if floodfill mode enabled.
+## If you want to share more bandwidth without floodfill mode, uncomment
+## that line and adjust value to your possibilities. Value can be set to
+## integer in kilobytes, it will apply that limit and flag will be used
+## from next upper limit (example: if you set 4096 flag will be X, but real
+## limit will be 4096 KB/s). Same can be done when floodfill mode is used,
+## but keep in mind that low values may be negatively evaluated by Java
+## router algorithms.
 # bandwidth = L
-## Max % of bandwidth limit for transit. 0-100. 100 by default
+## Max % of bandwidth limit for transit. 0-100 (default: 100)
 # share = 100
 
 ## Router will not accept transit tunnels, disabling transit traffic completely
-## (default = false)
+## (default: false)
 # notransit = true
 
-## Router will be floodfill
+## Router will be floodfill (default: false)
 ## Note: that mode uses much more network connections and CPU!
 # floodfill = true
 
 [ntcp2]
-## Enable NTCP2 transport (default = true)
+## Enable NTCP2 transport (default: true)
 # enabled = true
-## Publish address in RouterInfo (default = true)
+## Publish address in RouterInfo (default: true)
 # published = true
 ## Port for incoming connections (default is global port option value)
 # port = 4567
 
 [ssu2]
-## Enable SSU2 transport
+## Enable SSU2 transport (default: true)
 # enabled = true
-## Publish address in RouterInfo
+## Publish address in RouterInfo (default: true)
 # published = true
-## Port for incoming connections (default is global port option value or port + 1 if SSU is enabled)
+## Port for incoming connections (default is global port option value)
 # port = 4567
 
 [http]
 ## Web Console settings
-## Uncomment and set to 'false' to disable Web Console
+## Enable the 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 "/"
+## Address and port service will listen on (default: 127.0.0.1:7070)
+# address = 127.0.0.1
+# port = 7070
+## Path to web console (default: /)
 # webroot = /
-## Uncomment following lines to enable Web Console authentication
+## Enable Web Console authentication (default: false)
 ## You should not use Web Console via public networks without additional encryption.
 ## HTTP authentication is not encryption layer!
 # auth = true
@@ -134,12 +137,12 @@ port = 7070
 # lang = english
 
 [httpproxy]
-## Uncomment and set to 'false' to disable HTTP Proxy
+## Enable the 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
+## Address and port service will listen on (default: 127.0.0.1:4444)
+# address = 127.0.0.1
+# port = 4444
+## Optional keys file for proxy local destination (default: http-proxy-keys.dat)
 # keys = http-proxy-keys.dat
 ## Enable address helper for adding .i2p domains with "jump URLs" (default: true)
 ## You should disable this feature if your i2pd HTTP Proxy is public,
@@ -150,15 +153,15 @@ port = 4444
 ## httpproxy section also accepts I2CP parameters, like "inbound.length" etc.
 
 [socksproxy]
-## Uncomment and set to 'false' to disable SOCKS Proxy
+## Enable the 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
+## Address and port service will listen on (default: 127.0.0.1:4447)
+# address = 127.0.0.1
+# port = 4447
+## Optional keys file for proxy local destination (default: 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
+## Enable using of SOCKS outproxy (works only with SOCKS4, default: false)
 # outproxy.enabled = false
 ## Address and port of outproxy
 # outproxy = 127.0.0.1
@@ -166,34 +169,34 @@ port = 4447
 ## socksproxy section also accepts I2CP parameters, like "inbound.length" etc.
 
 [sam]
-## Comment or set to 'false' to disable SAM Bridge
-enabled = true
-## Address and ports service will listen on
+## Enable the SAM bridge (default: true)
+# enabled = false
+## Address and ports service will listen on (default: 127.0.0.1:7656, udp: 7655)
 # address = 127.0.0.1
 # port = 7656
 # portudp = 7655
 
 [bob]
-## Uncomment and set to 'true' to enable BOB command channel
+## Enable the BOB command channel (default: false)
 # enabled = false
-## Address and port service will listen on
+## Address and port service will listen on (default: 127.0.0.1:2827)
 # address = 127.0.0.1
 # port = 2827
 
 [i2cp]
-## Uncomment and set to 'true' to enable I2CP protocol
+## Enable the I2CP protocol (default: false)
 # enabled = false
-## Address and port service will listen on
+## Address and port service will listen on (default: 127.0.0.1:7654)
 # address = 127.0.0.1
 # port = 7654
 
 [i2pcontrol]
-## Uncomment and set to 'true' to enable I2PControl protocol
+## Enable the I2PControl protocol (default: false)
 # enabled = false
-## Address and port service will listen on
+## Address and port service will listen on (default: 127.0.0.1:7650)
 # address = 127.0.0.1
 # port = 7650
-## Authentication password. "itoopie" by default
+## Authentication password (default: itoopie)
 # password = itoopie
 
 [precomputation]
@@ -204,11 +207,11 @@ enabled = true
 [upnp]
 ## Enable or disable UPnP: automatic port forwarding (enabled by default in WINDOWS, ANDROID)
 # enabled = false
-## Name i2pd appears in UPnP forwardings list (default = I2Pd)
+## Name i2pd appears in UPnP forwardings list (default: I2Pd)
 # name = I2Pd
 
 [meshnets]
-## Enable connectivity over the Yggdrasil network
+## Enable connectivity over the Yggdrasil network  (default: false)
 # yggdrasil = false
 ## You can bind address from your Yggdrasil subnet 300::/64
 ## The address must first be added to the network interface
@@ -216,7 +219,7 @@ enabled = true
 
 [reseed]
 ## Options for bootstrapping into I2P network, aka reseeding
-## Enable or disable reseed data verification.
+## Enable reseed data verification (default: true)
 verify = true
 ## URLs to request reseed data from, separated by comma
 ## Default: "mainline" I2P Network reseeds
@@ -232,7 +235,7 @@ verify = true
 ## If you run i2pd behind a proxy server, set proxy server for reseeding here
 ## Should be http://address:port or socks://address:port
 # proxy = http://127.0.0.1:8118
-## Minimum number of known routers, below which i2pd triggers reseeding. 25 by default
+## Minimum number of known routers, below which i2pd triggers reseeding (default: 25)
 # threshold = 25
 
 [addressbook]
@@ -252,13 +255,13 @@ verify = true
 # coresize = 0
 
 [trust]
-## Enable explicit trust options. false by default
+## 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? false by default
+## Should we hide our router from other routers? (default: false)
 # hidden = true
 
 [exploratory]
@@ -279,6 +282,6 @@ verify = true
 # aesni = true
 ## Use CPU AVX instructions set when work with cryptography when available (default: true)
 # avx = true
-## Force usage of CPU instructions set, even if they not found
+## Force usage of CPU instructions set, even if they not found (default: false)
 ## DO NOT TOUCH that option if you really don't know what are you doing!
 # force = false