Fix: session mismatch on group

[l2tpns.git] / Docs / manual.html

diff --git a/Docs/manual.html b/Docs/manual.html
index 4215189..8894599 100644 (file)
--- a/Docs/manual.html
+++ b/Docs/manual.html
@@ -60,8 +60,8 @@ H3 {
 </OL>
 
 <H2 ID="Overview">Overview</H2>
 </OL>
 
 <H2 ID="Overview">Overview</H2>

-l2tpns is half of a complete L2TP implementation.  It supports only the
-LNS side of the connection.<P>
+l2tpns a complete L2TP implementation. It supports the LAC, LNS and
+ PPPOE server.<P>

 
 L2TP (Layer 2 Tunneling Protocol) is designed to allow any layer 2
 protocol (e.g. Ethernet, PPP) to be tunneled over an IP connection.  l2tpns
 
 L2TP (Layer 2 Tunneling Protocol) is designed to allow any layer 2
 protocol (e.g. Ethernet, PPP) to be tunneled over an IP connection.  l2tpns


@@ -265,6 +265,24 @@ from the address of "bind_address" (For use in cases of specific configuration).
 If no address is given to iftun_address and bind_address, 1.1.1.1 is used.
 </LI>
 
 If no address is given to iftun_address and bind_address, 1.1.1.1 is used.
 </LI>
 

+<LI><B>bind_multi_address</B> (ip address)<BR>
+This parameter permit to listen several addresss of the l2tp udp protocol
+(and set several address to the tun interface).
+<BR>
+WHEN this parameter is set, It OVERWRITE the parameters "bind_address"
+and "iftun_address".
+<BR>
+these can be interesting when you want do load-balancing in cluster mode
+of the uploaded from the LAC. For example you can set a bgp.prepend(MY_AS)
+for Address1 on LNS1 and a bgp.prepend(MY_AS) for Address2 on LNS2
+(see BGP AS-path prepending).
+<BR>
+example of use with 2 address:
+<BR>
+set bind_multi_address "64.14.13.41, 64.14.13.42"
+
+</LI>
+

 <LI><B>tundevicename</B> (string)<BR>
 Name of the tun interface (default: "tun0").
 </LI>
 <LI><B>tundevicename</B> (string)<BR>
 Name of the tun interface (default: "tun0").
 </LI>


@@ -298,8 +316,13 @@ every connected use will be dumped to a file in this directory.  Each
 file dumped begins with a header, where each line is prefixed by #. 
 Following the header is a single line for every connected user, fields
 separated by a space.<BR> The fields are username, ip, qos,
 file dumped begins with a header, where each line is prefixed by #. 
 Following the header is a single line for every connected user, fields
 separated by a space.<BR> The fields are username, ip, qos,

-uptxoctets, downrxoctets.  The qos field is 1 if a standard user, and
-2 if the user is throttled.
+uptxoctets, downrxoctets, origin (optional). The qos field is 1 if a standard user, and
+2 if the user is throttled. The origin field is dump if account_all_origin is set to true
+(origin value: L=LAC data, R=Remote LNS data, P=PPPOE data).
+</LI>
+
+<LI><B>account_all_origin</B> (boolean)<BR>
+If set to true, all origin of the usage is dumped to the accounting file (LAC+Remote LNS+PPPOE)(default false).

 </LI>
 
 <LI><B>setuid</B> (int)<BR>
 </LI>
 
 <LI><B>setuid</B> (int)<BR>


@@ -379,6 +402,24 @@ Drop sessions who have not responded within idle_echo_timeout seconds
 (default: 240 (seconds))
 </LI>
 
 (default: 240 (seconds))
 </LI>
 

+<LI><B>auth_tunnel_change_addr_src</B> (boolean)<BR>
+This parameter authorize to change the source IP of the tunnels l2tp.
+This parameter can be used when the remotes BAS/LAC are l2tpns server
+configured in cluster mode, but that the interface to remote LNS are
+not clustered (the tunnel can be coming from different source IP)
+(default: no).
+</LI>
+
+<LI><B>disable_sending_hello</B> (boolean)<BR>
+Disable l2tp sending HELLO message for Apple compatibility.
+Some OS X implementation of l2tp no manage the L2TP "HELLO message".
+(default: no).
+</LI>
+
+</UL>
+
+<P><U><B>LAC configuration</B></U></P>
+<UL>

 <LI><B>bind_address_remotelns</B> (ip address)<BR>
 Address of the interface to listen the remote LNS tunnels.
 If no address is given, all interfaces are listened (Any Address).
 <LI><B>bind_address_remotelns</B> (ip address)<BR>
 Address of the interface to listen the remote LNS tunnels.
 If no address is given, all interfaces are listened (Any Address).


@@ -388,25 +429,56 @@ If no address is given, all interfaces are listened (Any Address).
 Port to bind for the Remote LNS (default: 65432).
 </LI>
 
 Port to bind for the Remote LNS (default: 65432).
 </LI>
 

-<LI><B>auth_tunnel_change_addr_src</B> (boolean)<BR>
-This parameter authorize to change the source IP of the tunnels l2tp.
-This parameter can be used when the remotes BAS/LAC are l2tpns server
-configured in cluster mode, but that the interface to remote LNS are
-not clustered (the tunnel can be coming from different source IP)
-(default: no).
-</LI>
-

 </UL>
 
 </UL>
 

-<P>The REMOTES LNS configuration is entered by the command:
+<P>A static REMOTES LNS configuration can be entered by the command:</P>

 <DL> <DD><B>setforward</B> <I>MASK</I> <I>IP</I> <I>PORT</I> <I>SECRET</I> </DL>
 
 where <I>MASK</I> specifies the mask of users who have forwarded to
 <DL> <DD><B>setforward</B> <I>MASK</I> <I>IP</I> <I>PORT</I> <I>SECRET</I> </DL>
 
 where <I>MASK</I> specifies the mask of users who have forwarded to

-remote LNS (ex: /myISP@company.com).</BR>
-where <I>IP</I> specifies the IP of the  remote LNS (ex: 66.66.66.55).</BR>
+remote LNS (ex: "/friendISP@company.com").</BR>
+where <I>IP</I> specifies the IP of the  remote LNS (ex: "66.66.66.55").</BR>

 where <I>PORT</I> specifies the L2TP Port of the remote LNS
 (Normally should be 1701) (ex: 1701).</BR>
 where <I>SECRET</I> specifies the secret password the remote LNS (ex: mysecret).</BR>
 where <I>PORT</I> specifies the L2TP Port of the remote LNS
 (Normally should be 1701) (ex: 1701).</BR>
 where <I>SECRET</I> specifies the secret password the remote LNS (ex: mysecret).</BR>

+</BR>
+The static Remote LNS configuration can be used when the friend ISP not 
+have a proxied Radius.</BR>
+If the proxied Radius is used, It will return the RADIUS attributes:</BR>
+       Tunnel-Type: 1 = L2TP</BR>
+       Tunnel-Medium-Type: 1 = IPv4</BR>
+       Tunnel-Password: 1 = "LESECRETL2TP"</BR>
+       Tunnel-Server-Endpoint: 1 = "88.xx.xx.x1"</BR>
+       Tunnel-Assignment-Id: 1 = "friendisp_lns1"</BR>
+       Tunnel-Type: 2 = L2TP</BR>
+       Tunnel-Medium-Type: 2 = IPv4</BR>
+       Tunnel-Password: 2 = "LESECRETL2TP"</BR>
+       Tunnel-Server-Endpoint: 2 = "88.xx.xx.x2"</BR>
+       Tunnel-Assignment-Id: 2 = "friendisp_lns2"</BR>    
+
+<P><U><B>PPPOE configuration</B></U></P>
+
+<UL>
+<LI><B>pppoe_if_to_bind</B> (string)<BR>
+PPPOE server interface to bind (ex: "eth0.12"), If not specified the server PPPOE is not enabled.
+For the pppoe clustering, all the interfaces PPPOE of the clusters must use the same HW address (MAC address).
+</LI>
+
+<LI><B>pppoe_service_name</B> (string)<BR>
+PPPOE service name (default: NULL).
+</LI>
+
+<LI><B>pppoe_ac_name</B> (string)<BR>
+PPPOE  access concentrator name (default: "l2tpns-pppoe").
+</LI>
+
+<LI><B>pppoe_only_equal_svc_name</B> (boolean)<BR>
+If set to yes, the PPPOE server only accepts clients with a "service-name"
+different from NULL and a "service-name" equal to server "service-name" (default: no).
+</LI>
+
+</UL>
+
+<P><U><B>BGP configuration</B></U></P>

 
 <P>BGP routing configuration is entered by the command:
 The routing configuration section is entered by the command
 
 <P>BGP routing configuration is entered by the command:
 The routing configuration section is entered by the command