Browse Source

* fix comments in default config (#311)

pull/308/head
hagen 9 years ago
parent
commit
638a69e5f0
  1. 6
      README.md
  2. 20
      debian/i2pd.conf
  3. 2
      debian/tunnels.conf
  4. 39
      docs/configuration.md

6
README.md

@ -30,9 +30,9 @@ Supported OS @@ -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
------------------

20
debian/i2pd.conf vendored

@ -8,13 +8,13 @@ ircaddress=127.0.0.1 @@ -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

2
debian/tunnels.conf vendored

@ -1 +1 @@ @@ -1 +1 @@
; see examples in /usr/share/doc/i2pd/configuration.md.gz
# see examples in /usr/share/doc/i2pd/configuration.md.gz

39
docs/configuration.md

@ -39,6 +39,7 @@ Config files @@ -39,6 +39,7 @@ Config files
------------
INI-like, syntax is the following : <key> = <value>.
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:
@ -49,30 +50,30 @@ i2p.conf: @@ -49,30 +50,30 @@ i2p.conf:
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
# 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
#
# 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

Loading…
Cancel
Save