X-Git-Url: http://www.project-moonshot.org/gitweb/?a=blobdiff_plain;f=README;h=0d434daf2316e0ad80bd9b11371bdeaa2224ea73;hb=refs%2Fheads%2Fmaint-1.6;hp=f0c876ac1cac37774456232efd8782d0861a2a5d;hpb=380b907aa703c3bbdb9a74255c4955afda028bb4;p=radsecproxy.git

diff --git a/README b/README
index f0c876a..0d434da 100644
--- a/README
+++ b/README
@@ -1,36 +1,38 @@
-This is a revision from the radsecproxy 1.1 devel branch.
-radsecproxy is a generic RADIUS proxy that can support various
-RADIUS clients over UDP or TLS (RadSec).
+This is radsecproxy 1.6.5 from 2013-09-06.
 
-It should build on most Linux and BSD platforms by simply typing
-"make". You may also try to use autoconf, but this is currently
-unsupported.
+radsecproxy is a generic RADIUS proxy that supports both UDP and TLS
+(RadSec) RADIUS transports.  There is also experimental support for
+TCP and DTLS.
 
-To use it you need to create a config file which normally is
-called "/etc/radsecproxy.conf". If this is not found, the
-proxy will look for radsecproxy.conf in the current directory.
-You can also specify the location with the "-c" command line
-option (see below). For further instructions, please see the
-enclosed example file and the documentation at
-http://software.uninett.no/radsecproxy/?page=documentation
+It should build on most Unix and OSX platforms by simply typing
+"./configure && make".  It is possible to specify which RADIUS
+transport the build should support.  Without any special options to
+configure, all transports supported by the system will be enabled.
+See the output from "configure --help" for how to change this.
 
-There are four options that may be specified on the command line.
-"-c configfile" to specify a non-default config file path;
-"-d loglevel" to set a loglevel of 1, 2, 3 or 4 where 4 is the most
-detailed; and "-f" to run the proxy in the foreground with logging
-to stderr. Without "-f" the default is to detach as a daemon and
-log to syslog. Finally "-v" just prints version information and
-exits.
+Known build issues:
+- Older BSD's (like NetBSD 4.x) need newer OpenSSL in order to support
+  DTLS.  Workaround: ./configure --disable-dtls.
 
-Thanks to Stefan Winter and Andreas Solberg for making me do this,
-and the funding from GEANT2. Stefan as well as Kolbjørn Barmen
-and Maja Wolniewicz have helped with early testing of the code.
-All of the above plus Milan Sova have provided good feedback on
-several implementation choices. Finally thanks to Hans Zandbelt
-for providing the autoconf stuff. I may have forgotten someone,
-let me know if you feel left out.
+- FreeBSD 6.x need newer OpenSSL to build at all.  OpenSSL 1.0.0c from
+  ports is fine f.ex., configure radsecproxy with `--with-ssl=/usr/local'.
 
-For more information, feedback etc. please see the information
-at http://software.uninett.no/radsecproxy/
+To use radsecproxy you need to create a config file which normally is
+called "/etc/radsecproxy.conf".  You can also specify the location
+with the "-c" command line option (see below).  For further
+instructions, please see the enclosed example file and the
+documentation at
+http://software.uninett.no/radsecproxy/?page=documentation
 
-Stig Venaas <venaas@uninett.no> -- 2007.06.05
+The following options may be specified on the command line:
+"-c configfile" to specify a non-default config file path.
+"-d loglevel" to set a loglevel of 1, 2, 3, 4 and 5 where 5 is the
+              most detailed.
+"-f" to run the proxy in the foreground with logging to stderr.
+     Without "-f" the default is to detach as a daemon and log to
+     syslog.
+"-i pidfile" to name a file to which the PID is written.
+"-v" just prints version information and exits.
+"-p" (pretend) makes the proxy go through the configuration files as
+     normal, but stops before creating any sockets or doing any
+     serious work.  This is useful for validating config files.