* update docs

docs/configuration.md

@@ -4,9 +4,12 @@ i2pd configuration
 Command line options
 --------------------
 
+Options specified on the command line take precedence over those in the config file.
+If you are upgrading your very old router (< 2.3.0) see also [this](config_opts_after_2.3.0.md) page.
+
+* --help                - Show builtin help message (default value of option will be shown in braces)
 * --conf=               - Config file (default: ~/.i2pd/i2pd.conf or /var/lib/i2pd/i2pd.conf)
                           This parameter will be silently ignored if the specified config file does not exist.
-                          Options specified on the command line take precedence over those in the config file.
 * --tunconf=            - Tunnels config file (default: ~/.i2pd/tunnels.conf or /var/lib/i2pd/tunnels.conf)
 * --pidfile=            - Where to write pidfile (dont write by default)
 * --log=                - Logs destination: stdout, file (stdout if not set, file - otherwise, for compatibility)
@@ -24,6 +27,8 @@ Command line options
 * --family=             - Name of a family, router belongs to
 * --svcctl=             - Windows service management (--svcctl="install" or --svcctl="remove")
 
+All options below still possible in cmdline, but better write it in config file:
+
 * --http.address=       - The address to listen on (HTTP server)
 * --http.port=          - The port to listen on (HTTP server)
 
@@ -69,11 +74,13 @@ i2pd.conf:
     [httpproxy]
     port = 4444
     # ^^ this will be --httproxy.port= in cmdline
-    # another one
+    # another comment
     [sam]
     enabled = true
 
-tunnels.conf
+See also commented config with examples of all options in ``docs/i2pd.conf``.
+
+tunnels.conf:
 
     # outgoing tunnel sample, to remote service
     # mandatory parameters:
@@ -107,6 +114,7 @@ tunnels.conf
     host = 127.0.0.1
     port = 80
     keys = site-keys.dat
+    #
     [IRC-SERVER]
     type = server
     host = 127.0.0.1

docs/family.md

@@ -6,27 +6,31 @@ There are two possibilities: create new family or joing to existing.
 
 New family
 -----------
+
 You must create family self-signed certificate and key.  
 The only key type supposted is prime256v1.
 Use the following list of commands:  
-openssl ecparam -name prime256v1 -genkey -out <your family name>.key  
-openssl req -new -key <your family name>.key -out <your family name>.csr  
-touch v3.ext  
-openssl x509 -req -days 3650 -in <your family name>.csr -signkey <your family name>.key -out <your family name>.crt -extfile v3.ext  
 
-specify <your family name>.family.i2p.net for CN.
+    openssl ecparam -name prime256v1 -genkey -out <your family name>.key  
+    openssl req -new -key <your family name>.key -out <your family name>.csr  
+    touch v3.ext
+    openssl x509 -req -days 3650 -in <your family name>.csr -signkey <your family name>.key -out <your family name>.crt -extfile v3.ext  
+
+Specify <your family name>.family.i2p.net for CN (Common Name) when requested.
 
-Once you are done with it place <your family name>.key and <your family name>.crt to <ip2d data>/family folder (for exmple ~/.i2pd/family).
+Once you are done with it place <your-family-name>.key and <your-family-name>.crt to <ip2d data>/family folder (for exmple ~/.i2pd/family).
 You should provide these two files to other members joining your family.
 If you want to register you family and let I2P network recorgnize it, create pull request for you .crt file into contrib/certificate/family.
-It will appear in i2pd and I2P next releases packages. Don't place .key file, it must be shared betwwen you family members only.
+It will appear in i2pd and I2P next releases packages. Dont place .key file, it must be shared between you family members only.
+
+How to join existing family
+---------------------------
 
-Join existing family
+Once you and that family agree to do it, they must give you .key and .crt file and you must place in <i2pd datadir>/certificates/family/ folder.
---------------------
-Once you and that family agree to do it, they must give you .key and .crt file and you must place to <ip2d data>/family folder.
 
 Publish your family
-------------------
+-------------------
-Run i2pd with parameter 'family=<your family name>', make sure you have <your family name>.key and <your family name>.crt in your 'family' folder.
-If everything is set properly, you router.info will contain two new fields: 'family' and 'family.sig'.
 
+Run i2pd with parameter 'family=<your-family-name>', make sure you have <your-family-name>.key and <your-family-name>.crt in your 'family' folder.
+If everything is set properly, you router.info will contain two new fields: 'family' and 'family.sig'.
+Otherwise your router will complain on startup with log messages starting with "Family:" prefix and severity 'warn' or 'error'.

docs/i2pd.conf

@@ -8,107 +8,102 @@
 
 ## Tunnels config file
 ## Default: ~/.i2pd/tunnels.conf or /var/lib/i2pd/tunnels.conf
-#tunconf = /var/lib/i2pd/tunnels.conf
+# tunconf = /var/lib/i2pd/tunnels.conf
 
 ## Where to write pidfile (don't write by default)
-#pidfile = /var/run/i2pd.pid
+# pidfile = /var/run/i2pd.pid
 
 ## Logging configuration section
-## By default logs go to stdout with level info
+## By default logs go to stdout with level 'info' and higher
 ##
-## Logs destination (stdout, file, syslog)
+## Logs destination (valid values: stdout, file, syslog)
-## stdout - print log entries to stdout
+##  * stdout - print log entries to stdout
-## file - log entries to a file
+##  * file - log entries to a file
-## syslog - use syslog, see man 3 syslog
+##  * syslog - use syslog, see man 3 syslog
-#log = file
+# log = file
 ## Path to logfile (default - autodetect)
-#logfile = /var/log/i2pd.log
+# logfile = /var/log/i2pd.log
 ## Log messages above this level (debug, *info, warn, error)
-#loglevel = info
+# loglevel = info
 
 ## Path to storage of i2pd data (RI, keys, peer profiles, ...)
 ## Default: ~/.i2pd or /var/lib/i2pd
-#datadir = /var/lib/i2pd
+# datadir = /var/lib/i2pd
 
 ## Daemon mode. Router will go to background after start
-#daemon = true
+# daemon = true
 ## Run as a service. Router will use system folders like ‘/var/lib/i2pd’
-#service = true
+# service = true
 
 ## External IP address to listen for connections
 ## By default i2pd sets IP automatically
-#host = 1.2.3.4
+# host = 1.2.3.4
+
 ## Port to listen for connections
 ## By default i2pd picks random port. You MUST pick a random number too,
 ## don't just uncomment this
-#port = 4321
+# port = 4321
-##Enable communication through ipv6
+
+## Enable communication through ipv6
 ipv6 = true
+
 ## Bandwidth configuration
 ## L limit bandwidth to 32Kbs/sec, O - to 256Kbs/sec, P - unlimited
 ## Default is P for floodfill, L for regular node
-#bandwidth = L
+# bandwidth = L
 
 ## Router will not accept transit tunnels at startup
-#notransit = true
+# notransit = true
 
 ## Router will be floodfill
-#floodfill = true
+# floodfill = true
 
-## Section for Web Console
-## By default it's available at 127.0.0.1:7070 even if it's not configured
 [http]
-## The address to listen on
+## Uncomment and set to 'false' to disable Web Console
+# enabled = true
+## Address and port service will listen on
 address = 127.0.0.1
-## The port to listen on
 port = 7070
 
-## Section for HTTP proxy
-## By default it's available at 127.0.0.1:4444 even if it's not configured
 [httpproxy]
-## The address to listen on
+## Uncomment and set to 'false' to disable HTTP Proxy
-address = 127.0.0.1 
+# enabled = true
-## The port to listen on
+## Address and port service will listen on
-port = 4444 
+# address = 127.0.0.1
+# port = 4444
 ## Optional keys file for proxy local destination
-#keys = http-proxy-keys.dat 
+# keys = http-proxy-keys.dat
-## Uncomment if you want to disable HTTP proxy
+
-#enabled = false
+[socksproxy]
-
+## Uncomment and set to 'false' to disable SOCKS Proxy
-## Section for Socks proxy
+# enabled = true
-## By default it's available at 127.0.0.1:4447 even if it's not configured
+## Address and port service will listen on
-#[socksproxy]
+# address = 127.0.0.1
-## The address to listen on
+# port = 4447
-#address = 127.0.0.1 
-## The port to listen on
-#port = 4447 
 ## Optional keys file for proxy local destination
-#keys = socks-proxy-keys.dat 
+# keys = socks-proxy-keys.dat
-## Uncomment if you want to disable Socks proxy
-#enabled = false
 ## Socks outproxy. Example below is set to use Tor for all connections except i2p
-## Address of outproxy
+## Address and port of outproxy
-#outproxy = 127.0.0.1 
+# outproxy = 127.0.0.1
-## Outproxy remote port
+# outproxyport = 9050
-#outproxyport = 9050 
+
-
+[sam]
-## Section for SAM bridge
+## Uncomment and set to 'true' to enable SAM Bridge
-#[sam]
+# enabled = false
-## The address to listen on
+## Address and port service will listen on
-#address = 127.0.0.1 
+# address = 127.0.0.1
-## Port of SAM bridge
+# port = 7656
-#port = 7656
+
-
+[bob]
-## Section for BOB command channel
+## Uncomment and set to 'true' to enable BOB command channel
-#[bob]
+# enabled = false
-## The address to listen on
+## Address and port service will listen on
-#address = 127.0.0.1
+# address = 127.0.0.1
-## Port of BOB command channel. Usually 2827. BOB is off if not specified
+# port = 2827
-#port = 2827 
+
-
+[i2pcontrol]
-## Section for I2PControl protocol 
+## Uncomment and set to 'true' to enable I2PControl protocol
-#[i2pcontrol]
+# enabled = false
-## The address to listen on
+## Address and port service will listen on
-#address = 127.0.0.1 
+# address = 127.0.0.1
-## Port of I2P control service
+# port = 7650
-#port = 7650