Updated new requirements, pointers to the manual
[tinc] / README
1 This is the README file for tinc version 1.0.
2 Installation instructions may be found in the INSTALL file.
3
4 tinc is Copyright (C) 1998,1999,2000 Ivo Timmermans
5 <itimmermans@bigfoot.com>, Guus Sliepen <guus@sliepen.warande.net> and
6 others. For a complete list of authors see the AUTHORS file.
7
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or (at
11 your option) any later version. See the file COPYING for more details.
12
13
14 Requirements
15 ------------
16
17 Since 1.0pre3, we use OpenSSL for all cryptographic functions.  So you
18 need to install this library first; grab it from
19 http://www.openssl.org/.  We recommend version 0.9.5 or better.  If
20 this library is not installed on you system, configure will fail.  The
21 manual in doc/tinc.texi contains more detailed information on how to
22 install this library.
23
24
25 Features
26 --------
27
28 This version of tinc supports multiple virtual networks at once. To
29 use this feature, you may supply a netname via the -n or --net
30 options. The standard locations for the config files will then be
31 /etc/tinc/<net>/. Because of this feature, tinc will send packets
32 directly to their destinations, instead of to the uplink. If this
33 behaviour is undesirable (for instance because of firewalls or
34 other restrictions), please use an older version of tinc (I would
35 recommend tinc-0.2.19).
36
37 In this version, MAC addresses are stripped off before encoding and
38 sending a packet. When the packet reaches its destination, the MAC
39 addresses are rebuilt again. They then have the form
40 FE:FD:aa:bb:cc:dd. aa, bb, cc and dd are taken from the destination
41 and source IP address.  See the manual for more detailed information.
42
43 tincd regenerates its encryption key pairs. It does this on the first
44 activity after the keys have expired. This period is adjustable in the
45 configuration file, and the default time is 3600 seconds (one
46 hour). If you send a USR2 signal to the daemon, it'll regenerate
47 immediately.