diff --git a/README.md b/README.md index 5120899c..ed6b3203 100644 --- a/README.md +++ b/README.md @@ -92,12 +92,37 @@ Cmdline options 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. -Config file ------------ +Config files +------------ INI-like, syntax is the following : = . All command-line parameters are allowed as keys, for example: +i2p.conf: + log = 1 v6 = 0 ircdest = irc.postman.i2p + +tunnels.cfg (filename of this config is subject of change): + + ; outgoing tunnel, to remote service + [tunnel1] + type = client ; mandatory + port = ; mandatory, bind our side of tunnel to this local port + keys = ; optional + destination = ; mandatory + destinationport = ; optional, port of remote i2p service + ; + ; incoming tunnel, for local service(s) + [tunnel2] + type = server ; mandatory + host = ; mandatory, hostname of our i2p service + keys = ; mandatory, hostname keys + port = ; mandatory, forward incoming connections from i2p + ; to this port + inport = ; optional, i2p service port + accesslist = [,] ; optional, comma-separated list of i2p idents, + ; allowed to connect to service + +Note: '' type is a string like or