diff --git a/README.md b/README.md index e467c732..b890029b 100644 --- a/README.md +++ b/README.md @@ -30,9 +30,9 @@ Supported OS [![Build status](https://ci.appveyor.com/api/projects/status/458fhbki14gaplyj/branch/openssl?svg=true)](https://ci.appveyor.com/project/mlt/i2pd/branch/openssl) --- Linux x86/x64 - Proved working. --- Mac OS X - Not well tested. (Only works with clang, not GCC) --- Windows - At least builds and runs. +* Linux x86/x64 - Proved working. +* Mac OS X - Not well tested. (Only works with clang, not GCC) +* Windows - At least builds and runs. More documentation ------------------ diff --git a/debian/i2pd.conf b/debian/i2pd.conf index c32716ce..69b02ba0 100644 --- a/debian/i2pd.conf +++ b/debian/i2pd.conf @@ -8,13 +8,13 @@ ircaddress=127.0.0.1 ircport=6668 ircdest=irc.postman.i2p -; other services (disabled by default) -; -; samaddress=127.0.0.1 -; samport=7656 -; -; bobaddress=127.0.0.1 -; bobport=2827 -; -; i2pcontroladdress=127.0.0.1 -; i2pcontrolport=7650 +# other services (disabled by default) +# +# samaddress=127.0.0.1 +# samport=7656 +# +# bobaddress=127.0.0.1 +# bobport=2827 +# +# i2pcontroladdress=127.0.0.1 +# i2pcontrolport=7650 diff --git a/debian/tunnels.conf b/debian/tunnels.conf index 43cb495a..3cf35552 100644 --- a/debian/tunnels.conf +++ b/debian/tunnels.conf @@ -1 +1 @@ -; see examples in /usr/share/doc/i2pd/configuration.md.gz +# see examples in /usr/share/doc/i2pd/configuration.md.gz diff --git a/docs/configuration.md b/docs/configuration.md index 79e30dc9..44ec9d8d 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -39,46 +39,47 @@ Config files ------------ INI-like, syntax is the following : = . +Comments are "#", not ";" as you may expect. See [boost ticket](https://svn.boost.org/trac/boost/ticket/808) All command-line parameters are allowed as keys, for example: i2p.conf: - log = 1 - v6 = 0 - ircdest = irc.postman.i2p + log = 1 + v6 = 0 + ircdest = irc.postman.i2p tunnels.cfg (filename of this config is subject of change): - ; outgoing tunnel sample, to remote service - ; mandatory parameters: - ; * type -- always "client" - ; * port -- local port to listen to - ; * destination -- i2p hostname - ; optional parameters (may be omitted) - ; * keys -- our identity, if unset, will be generated on every startup, - ; if set and file missing, keys will be generated and placed to this file - [IRC] - type = client - port = 6668 - destination = irc.echelon.i2p - keys = irc-keys.dat - ; - ; incoming tunnel sample, for local service - ; mandatory parameters: - ; * type -- always "server" - ; * host -- ip address of our service - ; * port -- port of our service - ; * keys -- file with LeaseSet of address in i2p - ; optional parameters (may be omitted) - ; * inport -- optional, i2p service port, if unset - the same as 'port' - ; * accesslist -- comma-separated list of i2p addresses, allowed to connect - ; every address is b32 without '.b32.i2p' part - [LOCALSITE] - type = server - host = 127.0.0.1 - port = 80 - keys = site-keys.dat - inport = 81 - accesslist = [,] + # outgoing tunnel sample, to remote service + # mandatory parameters: + # * type -- always "client" + # * port -- local port to listen to + # * destination -- i2p hostname + # optional parameters (may be omitted) + # * keys -- our identity, if unset, will be generated on every startup, + # if set and file missing, keys will be generated and placed to this file + [IRC] + type = client + port = 6668 + destination = irc.echelon.i2p + keys = irc-keys.dat + # + # incoming tunnel sample, for local service + # mandatory parameters: + # * type -- always "server" + # * host -- ip address of our service + # * port -- port of our service + # * keys -- file with LeaseSet of address in i2p + # optional parameters (may be omitted) + # * inport -- optional, i2p service port, if unset - the same as 'port' + # * accesslist -- comma-separated list of i2p addresses, allowed to connect + # every address is b32 without '.b32.i2p' part + [LOCALSITE] + type = server + host = 127.0.0.1 + port = 80 + keys = site-keys.dat + inport = 81 + accesslist = [,] Also see [this page](https://github.com/PurpleI2P/i2pd/wiki/tunnels.cfg) for more tunnel examples.