add i2ptunnel.config docs

This commit is contained in:
zzz
2014-11-18 15:54:06 +00:00
parent 600041c1e2
commit 49807eba92

View File

@@ -194,7 +194,48 @@ Configured via the application gui.
<h3>I2PTunnel (i2ptunnel.config)</h3>
<p>{% trans -%}
Configured via the /i2ptunnel application in the router console.
{%- endtrans %}</p>
{%- endtrans %}
{% trans -%}
Properties are as follows:
{%- endtrans %}
<pre>
# Display description for UI
tunnel.N.description=
# Router IP address or host name. Ignored if in router context.
tunnel.N.i2cpHost=127.0.0.1
# Router I2CP port. Ignored if in router context.
tunnel.N.i2cpPort=nnnn
# For clients only. Local listen IP address or host name.
tunnel.N.interface=127.0.0.1
# For clients only. Local listen port.
tunnel.N.listenPort=nnnn
# Display name for UI
tunnel.N.name=
# Each option is passed to I2CP and streaming with "tunnel.N.option." stripped off. See those docs.
tunnel.N.option.*=
# For servers and clients with persistent keys only. Absolute path or relative to config directory.
tunnel.N.privKeyFile=filename
# For proxies only. Comma- or space-separated host names.
tunnel.N.proxyList=example.i2p[,example2.i2p]
# For clients only. Default false.
tunnel.N.sharedClient=true|false
# For HTTP servers only. Host name to be passed to the local server in the HTTP headers.
tunnel.N.spoofedHost=
# Default true
tunnel.N.startOnLoad=true|false
# For clients only. Comma- or space-separated host names or host:port.
tunnel.N.targetDestination=example.i2p[:nnnn][,example2.i2p[:nnnn]]
# For servers only. Local IP address or host name to connect to.
tunnel.N.targetHost=
# For servers only.
tunnel.N.targetPort=nnnn
# The type of i2ptunnel
tunnel.N.type=client|connectclient|httpbidirserver|httpclient|httpserver|ircclient|ircserver|
server|socksirctunnel|sockstunnel|streamrclient|streamrserver
</pre>
Note: Each 'N' is a tunnel number starting with 0.
There may not be any gaps in numbering.
</p>
<h3>{% trans %}Router Console{% endtrans %}</h3>
<p>{% trans -%}