1.3.0 release

1 files changed, 21 insertions, 12 deletions

diff --git a/README b/README
index c75e250b..3227422b 100644
--- a/README
+++ b/README
@@ -19,11 +19,12 @@ Features
 7.  Supported authentication types: PAP, CHAP (md5), Microsoft CHAP Extentions (including version 2), not supported - EAP
 8.  Supported MPPE
 9.  Compression is not supported
-10. Extensible logging engine with per session logging support, implemented log to file and log to PostgreSQL targets
-11. Extensible user/password database, implemented Radius, chap-secret sources
-12. Extensible IP pool, implemented Radius and static pools
+10. Extensible logging engine with per session logging support, implemented log to file, log to remote host and log to PostgreSQL targets
+11. Extensible user/password database, implemented Radius, pppd compatible chap-secrets sources
+12. Extensible IP pool, implemented Radius, chap-secrets and static pools
 13. Supported pppd compatible ip-up/ip-down scripts
 14. Builtin tbf shaper manager
+15. Command line interface via telnet
 
 
 Requirment
@@ -31,22 +32,29 @@ Requirment
 1. modern linux distribution
 2. kernel-2.6.25 or later
 4. cmake-2.6 or later
-5. libnl-2.0 or probably later (required for l2tp and builtin shaper)
+5. libnl-2.0 or probably later (required for builtin shaper)
 
 
 Compilation and instalation
 -----------
 Make sure you have configured kernel headers in /usr/src/linux,
 or specify other location via KDIR.
-1. cd /path/to/accel-pptp-1.1
+1. cd /path/to/accel-pptp-1.3.0
 2. mkdir build
 3. cd build
-4. cmake [-DBUILD_DRIVER=TRUE] [-DKDIR=/usr/src/linux] [-DCMAKE_INSTALL_PREFIX=/usr/local] [-DCMAKE_BUILD_TYPE=Debug] [-DLOG_PGSQL=TRUE] [-DSHAPER=TRUE] ..
-   Please note that the double dot record in the end of the command is essential. You'll get error if you miss it.
-   BUILD_DRIVER, KDIR, CMAKE_INSTALL_PREFIX, CMAKE_BUILD_TYPE, LOG_PGSQL, SHAPER  are optional,
-   but while pptp is not present in mainline kernel you probably need BUILD_DRIVER.
-5. make
-6. make install
+4. cmake [-DBUILD_DRIVER=FALSE] [-DKDIR=/usr/src/linux] [-DCMAKE_INSTALL_PREFIX=/usr/local] [-DCMAKE_BUILD_TYPE=Release] [-DLOG_PGSQL=FALSE] [-DSHAPER=FALSE] [-DRADIUS=TRUE] ..
+   Please note that the double dot record in the end of the command is essential. You'll probably get error or misconfigured sources if you miss it.
+   BUILD_DRIVER, KDIR, CMAKE_INSTALL_PREFIX, CMAKE_BUILD_TYPE, LOG_PGSQL, SHAPER, RADIUS  are optional,
+   But while pptp is not present in mainline kernel you probably need BUILD_DRIVER.
+   For example:
+   cmake -DBUILD_DRIVER=TRUE ..
+   will configure sources to build pptp driver, search kernel headers at /usr/src/linux, install to /usr/local,
+   build with no debug, pgsql and shaper support, build with radius support.
+5. If you want to use chap-secrets for authentication purpose then you need to disable radius support, configure as following:
+   cmake -DBUILD_DRIVER=TRUE -DRADIUS=FALSE ..
+   of course you can include additional options if needed.
+6. make
+7. make install
 
 
 Configuration
@@ -56,7 +64,8 @@ read man accel-pptp.conf
 
 Warning !!!
 -----------
-1. This driver conflicts with ip_gre driver (in kernel), so make sure that ip_gre is not built-in or loaded at run time.
+1. The pptp driver conflicts with ip_gre driver (in kernel), so make sure that ip_gre is not built-in or loaded at run time
+   (don't matter if you have 2.6.37 or later kernel).
 2. Never mix connections of accel-pptp and original pptpd, before starting accel-pptp make sure that no connections
    of original pptpd exists.