X-Git-Url: http://www.project-moonshot.org/gitweb/?a=blobdiff_plain;f=README;h=b15ec68f7a42515ec72b2997bb204b6a4ca29ea1;hb=refs%2Fheads%2FRADSECPROXY-51;hp=43be4c6cf49867c1c41f4ebccada532c7dab0162;hpb=cb9e63ae8d870e1b2ece83eb0d4b66f9c443cbfd;p=radsecproxy.git

diff --git a/README b/README
index 43be4c6..b15ec68 100644
--- a/README
+++ b/README
@@ -1,23 +1,38 @@
-This is a beta version of a generic RADIUS proxy that can support
-various RADIUS clients over UDP or TLS (RadSec).
+This is unreleased radsecproxy 1.7-dev.
 
-It should build on most Linux and BSD platforms by simply typing
-"make". To use it you need to create three config files. These
-are the main config file "radsecproxy.conf" and server and client
-files "servers.conf" and "clients.conf". See the enclosed example
-files for further instructions.
+radsecproxy is a generic RADIUS proxy that supports both UDP and TLS
+(RadSec) RADIUS transports.  There is also experimental support for
+TCP and DTLS.
 
-The config files must be in either "/etc/radsecproxy" or the
-proxy's current work directory. You may alter the path near
-the top of radsecproxy.h if necessary.
+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 three 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.
+Known build issues:
+- Older BSD's (like NetBSD 4.x) need newer OpenSSL in order to support
+  DTLS.  Workaround: ./configure --disable-dtls.
 
-For more information, feedback etc. contact <venaas@uninett.no>.
+- 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'.
 
-Stig Venaas, 2007.05.14
+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
+
+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.