From: Guus Sliepen <guus@tinc-vpn.org>
Date: Thu, 19 Apr 2012 13:56:08 +0000 (+0200)
Subject: Document new proxy types.
X-Git-Tag: release-1.0.19~6
X-Git-Url: https://git.librecmc.org/?a=commitdiff_plain;h=5c0dd104f94519c3cb50e9ca44227656c5adc7ae;p=oweals%2Ftinc.git

Document new proxy types.
---

diff --git a/doc/tinc.conf.5.in b/doc/tinc.conf.5.in
index 35f986b..df74c5b 100644
--- a/doc/tinc.conf.5.in
+++ b/doc/tinc.conf.5.in
@@ -456,24 +456,38 @@ specified in the configuration file.
 When this option is used the priority of the tincd process will be adjusted.
 Increasing the priority may help to reduce latency and packet loss on the VPN.
 
-.It Va Proxy Li = Ar type Ar address Ar port Oo Ar username Oc Bq experimental
-Use the proxy at the given
-.Ar address
-and
-.Ar port
-when making outgoing connections.
+.It Va Proxy Li = socks4 | socks5 | http | exec Ar ... Bq experimental
+Use a proxy when making outgoing connections.
 The following proxy types are currently supported:
 .Bl -tag -width indent
-.It socks4
+.It socks4 Ar address Ar port Op Ar username
 Connects to the proxy using the SOCKS version 4 protocol.
 Optionally, a
 .Ar username
 can be supplied which will be passed on to the proxy server.
-
-.It http
+Only IPv4 connections can be proxied using SOCKS 4.
+.It socks5 Ar address Ar port Op Ar username Ar password
+Connect to the proxy using the SOCKS version 5 protocol.
+If a
+.Ar username
+and
+.Ar password
+are given, basic username/password authentication will be used,
+otherwise no authentication will be used.
+.It http Ar address Ar port
 Connects to the proxy and sends a HTTP CONNECT request.
+.It exec Ar command
+Executes the given
+.Ar command
+which should set up the outgoing connection.
+The environment variables
+.Ev NAME ,
+.Ev NODE ,
+.Ev REMOTEADDRES
+and
+.Ev REMOTEPORT
+are available.
 .El
-No authentication methods are currently supported.
 
 .It Va ReplayWindow Li = Ar bytes Pq 16
 vhis is the size of the replay tracking window for each remote node, in bytes.
diff --git a/doc/tinc.texi b/doc/tinc.texi
index 3decca0..8cf157f 100644
--- a/doc/tinc.texi
+++ b/doc/tinc.texi
@@ -1051,23 +1051,31 @@ When this option is used the priority of the tincd process will be adjusted.
 Increasing the priority may help to reduce latency and packet loss on the VPN.
 
 @cindex Proxy
-@item Proxy = <@var{type}> <@var{address}> <@var{port}> [<@var{username}>] [experimental]
-Use the proxy at the given @var{address} and @var{port} when making outgoing connections.
+@item Proxy = socks4 | socks4 | http | exec @var{...} [experimental]
+Use a proxy when making outgoing connections.
 The following proxy types are currently supported:
 
 @table @asis
 @cindex socks4
-@item socks4
+@item socks4 <@var{address}> <@var{port}> [<@var{username}>]
 Connects to the proxy using the SOCKS version 4 protocol.
 Optionally, a @var{username} can be supplied which will be passed on to the proxy server.
 
+@cindex socks5
+@item socks4 <@var{address}> <@var{port}> [<@var{username}> <@var{password}>]
+Connect to the proxy using the SOCKS version 5 protocol.
+If a @var{username} and @var{password} are given, basic username/password authentication will be used,
+otherwise no authentication will be used.
+
 @cindex http
-@item http
+@item http <@var{address}> <@var{port}>
 Connects to the proxy and sends a HTTP CONNECT request.
-@end table
-
-No authentication methods are currently supported.
 
+@cindex exec
+@item exec <@var{command}>
+Executes the given command which should set up the outgoing connection.
+The environment variables @env{NAME}, @env{NODE}, @env{REMOTEADDRES} and @env{REMOTEPORT} are available.
+@end table
 
 @cindex ReplayWindow
 @item ReplayWindow = <bytes> (16)