some minor updates
[radsecproxy.git] / README
diff --git a/README b/README
index ee65233..f0c876a 100644 (file)
--- a/README
+++ b/README
@@ -1,16 +1,36 @@
-This is the very first experimental version of a generic RADIUS proxy
-that can support various RADIUS clients over UDP or TLS (RadSec).
+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).
 
-It should build on most Linux 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.
+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.
 
-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.
+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
 
-For more information, feedback etc. contact <venaas@uninett.no>.
+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.
 
-Stig Venaas, 2007.01.08
+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.
+
+For more information, feedback etc. please see the information
+at http://software.uninett.no/radsecproxy/
+
+Stig Venaas <venaas@uninett.no> -- 2007.06.05