X-Git-Url: https://www.tinc-vpn.org/git/browse?p=tinc;a=blobdiff_plain;f=doc%2Ftinc.conf.5.in;h=750e0cf2b77fd7cc7603d5fa792b0095c26568c3;hp=7257bfe025c163f4fbbed5fb7e296c253608a1f5;hb=2077451e07f93edc520cf5bc31815624a2b03fdd;hpb=013a2e159e42c46808ea8d0b6abd57525db30a50 diff --git a/doc/tinc.conf.5.in b/doc/tinc.conf.5.in index 7257bfe0..750e0cf2 100644 --- a/doc/tinc.conf.5.in +++ b/doc/tinc.conf.5.in @@ -1,8 +1,8 @@ .Dd 2002-04-09 .Dt TINC.CONF 5 .\" Manual page created by: -.\" Ivo Timmermans -.\" Guus Sliepen +.\" Ivo Timmermans +.\" Guus Sliepen .Sh NAME .Nm tinc.conf .Nd tinc daemon configuration @@ -199,11 +199,13 @@ while no routing table is managed. .It Va Name Li = Ar name Bq required This is the name which identifies this tinc daemon. It must be unique for the virtual private network this daemon will connect to. -.It Va PingTimeout Li = Ar seconds Pq 60 +.It Va PingInterval Li = Ar seconds Pq 60 The number of seconds of inactivity that .Nm tinc will wait before sending a probe to the other end. -If that other end doesn't answer within that same amount of time, +.It Va PingTimeout Li = Ar seconds Pq 5 +The number of seconds to wait for a response to pings or to allow meta +connections to block. If the other end doesn't respond within this time, the connection is terminated, and the others will be notified of this. .It Va PriorityInheritance Li = yes | no Po no Pc Bq experimental @@ -219,6 +221,11 @@ Note that there must be exactly one of or .Va PrivateKeyFile specified in the configuration file. +.It Va TunnelServer Li = yes | no Po no Pc Bq experimental +When this option is enabled tinc will no longer forward information between other tinc daemons, +and will only allow nodes and subnets on the VPN which are present in the +.Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /hosts/ +directory. .El .Sh HOST CONFIGURATION FILES The host configuration files contain all information needed @@ -246,6 +253,7 @@ Any cipher supported by OpenSSL is recognised. Furthermore, specifying .Qq none will turn off packet encryption. +It is best to use only those ciphers which support CBC mode. .It Va Compression Li = Ar level Pq 0 This option sets the level of compression used for UDP packets. Possible values are 0 (off), 1 (fast zlib) and any integer up to 9 (best zlib), @@ -268,6 +276,11 @@ The length of the message authentication code used to authenticate UDP packets. Can be anything from .Qq 0 up to the length of the digest produced by the digest algorithm. +.It Va PMTU Li = Ar mtu Po 1514 Pc Bq experimental +This option controls the initial path MTU to this node. +.It Va PMTUDiscovery Li = yes | no Po no Pc Bq experimental +When this option is enabled, tinc will try to discover the path MTU to this node. +After the path MTU has been discovered, it will be enforced on the VPN. .It Va Port Li = Ar port Pq 655 The port number on which this tinc daemon is listening for incoming connections. .It Va PublicKey Li = Ar key Bq obsolete @@ -314,7 +327,7 @@ Setting this options also implicitly sets IndirectData. .Sh SCRIPTS Apart from reading the server and host configuration files, tinc can also run scripts at certain moments. -On Windows (not Cygwin), the scripts should have the extension +Under Windows (not Cygwin), the scripts should have the extension .Pa .bat . .Bl -tag -width indent .It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /tinc-up @@ -333,6 +346,15 @@ becomes reachable. This script is started when the tinc daemon with name .Ar HOST becomes unreachable. +.It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /host-up +This script is started when any host becomes reachable. +.It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /host-down +This script is started when any host becomes unreachable. +.It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /subnet-up +This script is started when a Subnet becomes reachable. +The Subnet and the node it belongs to are passed in environment variables. +.It Pa @sysconfdir@/tinc/ Ns Ar NETNAME Ns Pa /subnet-down +This script is started when a Subnet becomes unreachable. .El .Pp The scripts are started without command line arguments, but can make use of certain environment variables. @@ -357,10 +379,13 @@ This should be used for commands like .Pa ifconfig . .It Ev NODE When a host becomes (un)reachable, this is set to its name. +If a subnet becomes (un)reachable, this is set to the owner of that subnet. .It Ev REMOTEADDRESS When a host becomes (un)reachable, this is set to its real address. .It Ev REMOTEPORT When a host becomes (un)reachable, this is set to the port number it uses for communication with other tinc daemons. +.It Ev SUBNET +When a subnet becomes (un)reachable, this is set to the subnet. .El .Sh FILES The most important files are: @@ -383,7 +408,7 @@ its connection to the virtual network device. .El .Sh SEE ALSO .Xr tincd 8 , -.Pa http://tinc.nl.linux.org/ , +.Pa http://www.tinc-vpn.org/ , .Pa http://www.linuxdoc.org/LDP/nag2/ . .Pp The full documentation for