* Fri Mar 5 2004 David Parrish <david@dparrish.com> 1.1.0
[l2tpns.git] / INSTALL
1 Brief Installation guide for L2TPNS
2
3 1. Requirements
4
5     * libcli 1.5.0 or greater
6       You can get it from http://sourceforge.net/projects/libcli.
7
8     * A kernel with iptables support
9
10     * If you want to use throttling, you must have a kernel and a tc (iproute) which supports HTB.
11
12
13 2. Compile
14
15 ./configure --prefix=/usr --sysconfdir=/etc/l2tpns
16 make
17
18
19 3. Install
20
21     * make install. This does:
22         * Install the binaries into /usr/bin (l2tpns, cluster_master and nsctl)
23         * Create config dir /etc/l2tpns and create default config files
24         * Ensures that /dev/net/tun exists
25
26     * Modify config file. You probably need to change most of the config options.
27
28     * Set up basic firewall rules. This should be done in an init script.
29
30         iptables -t nat -N l2tpns
31         iptables -t nat -A PREROUTING -j l2tpns
32         iptables -t mangle -N l2tpns
33         iptables -t mangle -A PREROUTING -j l2tpns
34
35     * Set up walled garden firewall rules. This should be done in an init
36       script. This is not required unless you are using the garden plugin.
37
38         iptables -t nat -N garden >/dev/null 2>&1
39         iptables -t nat -F garden
40         iptables -t nat -A garden -p tcp -m tcp --dport 25 -j DNAT --to 192.168.1.1
41         iptables -t nat -A garden -p udp -m udp --dport 53 -j DNAT --to 192.168.1.1
42         iptables -t nat -A garden -p tcp -m tcp --dport 53 -j DNAT --to 192.168.1.1
43         iptables -t nat -A garden -p tcp -m tcp --dport 80 -j DNAT --to 192.168.1.1
44         iptables -t nat -A garden -p tcp -m tcp --dport 110 -j DNAT --to 192.168.1.1
45         iptables -t nat -A garden -p tcp -m tcp --dport 443 -j DNAT --to 192.168.1.1
46         iptables -t nat -A garden -p icmp -m icmp --icmp-type echo-request -j DNAT --to 192.168.1.1
47         iptables -t nat -A garden -p icmp -j ACCEPT
48         iptables -t nat -A garden -j DROP
49
50     * Set up IP address pools in /etc/l2tpns/ip_pool
51
52     * Set up clustering
53
54         * Run cluster_master on a separate machine
55         * Set the "cluster master" and "bind address" parameters in /etc/l2tpns/l2tpns.cfg
56
57     * Make l2tpns run on startup
58
59     * Test it out
60
61
62
63
64 This software is quite stable and is being used in a production
65 environment at a quite large ISP. However, you may have problems
66 setting it up, and if so, I would appreciate it if you would file
67 useful bug reports on the Source Forge page:
68
69 http://sourceforge.net/projects/l2tpns/
70
71 -- David Parrish