Next: , Previous: , Up: Configuration files   [Contents][Index]


4.4.2 Host configuration variables

Address = <IP address|hostname> [<port>] [recommended]

This variable is only required if you want to connect to this host. It must resolve to the external IP address where the host can be reached, not the one that is internal to the VPN. If no port is specified, the default Port is used. Multiple Address variables can be specified, in which case each address will be tried until a working connection has been established.

Cipher = <cipher> (blowfish)

The symmetric cipher algorithm used to encrypt UDP packets using the legacy protocol. Any cipher supported by LibreSSL or OpenSSL is recognized. Furthermore, specifying "none" will turn off packet encryption. It is best to use only those ciphers which support CBC mode. This option has no effect for connections using the SPTPS protocol, which always use AES-256-CTR.

ClampMSS = <yes|no> (yes)

This option specifies whether tinc should clamp the maximum segment size (MSS) of TCP packets to the path MTU. This helps in situations where ICMP Fragmentation Needed or Packet too Big messages are dropped by firewalls.

Compression = <level> (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), 10 (fast lzo) and 11 (best lzo).

Digest = <digest> (sha1)

The digest algorithm used to authenticate UDP packets using the legacy protocol. Any digest supported by LibreSSL or OpenSSL is recognized. Furthermore, specifying "none" will turn off packet authentication. This option has no effect for connections using the SPTPS protocol, which always use HMAC-SHA-256.

IndirectData = <yes|no> (no)

When set to yes, other nodes which do not already have a meta connection to you will not try to establish direct communication with you. It is best to leave this option out or set it to no.

MACLength = <bytes> (4)

The length of the message authentication code used to authenticate UDP packets using the legacy protocol. Can be anything from 0 up to the length of the digest produced by the digest algorithm. This option has no effect for connections using the SPTPS protocol, which never truncate MACs.

PMTU = <mtu> (1514)

This option controls the initial path MTU to this node.

PMTUDiscovery = <yes|no> (yes)

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.

MTUInfoInterval = <seconds> (5)

The minimum amount of time between sending periodic updates about relay path MTU. Useful for quickly determining MTU to indirect nodes.

Port = <port> (655)

This is the port this tinc daemon listens on. You can use decimal portnumbers or symbolic names (as listed in /etc/services).

PublicKey = <key> [obsolete]

This is the RSA public key for this host.

PublicKeyFile = <path> [obsolete]

This is the full path name of the RSA public key file that was generated by ‘tinc generate-keys’. It must be a full path, not a relative directory.

From version 1.0pre4 on tinc will store the public key directly into the host configuration file in PEM format, the above two options then are not necessary. Either the PEM format is used, or exactly one of the above two options must be specified in each host configuration file, if you want to be able to establish a connection with that host.

Subnet = <address[/prefixlength[#weight]]>

The subnet which this tinc daemon will serve. Tinc tries to look up which other daemon it should send a packet to by searching the appropiate subnet. If the packet matches a subnet, it will be sent to the daemon who has this subnet in his host configuration file. Multiple subnet lines can be specified for each daemon.

Subnets can either be single MAC, IPv4 or IPv6 addresses, in which case a subnet consisting of only that single address is assumed, or they can be a IPv4 or IPv6 network address with a prefixlength. For example, IPv4 subnets must be in a form like 192.168.1.0/24, where 192.168.1.0 is the network address and 24 is the number of bits set in the netmask. Note that subnets like 192.168.1.1/24 are invalid! Read a networking HOWTO/FAQ/guide if you don’t understand this. IPv6 subnets are notated like fec0:0:0:1::/64. MAC addresses are notated like 0:1a:2b:3c:4d:5e.

Prefixlength is the number of bits set to 1 in the netmask part; for example: netmask 255.255.255.0 would become /24, 255.255.252.0 becomes /22. This conforms to standard CIDR notation as described in RFC1519

A Subnet can be given a weight to indicate its priority over identical Subnets owned by different nodes. The default weight is 10. Lower values indicate higher priority. Packets will be sent to the node with the highest priority, unless that node is not reachable, in which case the node with the next highest priority will be tried, and so on.

TCPonly = <yes|no> (no)

If this variable is set to yes, then the packets are tunnelled over a TCP connection instead of a UDP connection. This is especially useful for those who want to run a tinc daemon from behind a masquerading firewall, or if UDP packet routing is disabled somehow. Setting this options also implicitly sets IndirectData.

Weight = <weight>

If this variable is set, it overrides the weight given to connections made with another host. A higher weight means a lower priority is given to this connection when broadcasting or forwarding packets.


Next: , Previous: , Up: Configuration files   [Contents][Index]