X-Git-Url: http://www.project-moonshot.org/gitweb/?p=radsecproxy.git;a=blobdiff_plain;f=README;h=4c0d27756aae706a915b093c89c681c48eefd061;hp=788ee5ac2982e543a8c4827bdfff7588e4fef039;hb=HEAD;hpb=79651977517e254035141de0468cf87aa1d20e23

diff --git a/README b/README
index 788ee5a..4c0d277 100644
--- a/README
+++ b/README
@@ -1,31 +1,48 @@
-This is a beta version of a generic RADIUS proxy that can support
-various RADIUS clients over UDP or TLS (RadSec).
-
-It should build on most Linux and BSD platforms by simply typing
-"make". You may also try to use autoconf if you like.
-
-To use it you need to create a config file called
-"radsecproxy.conf" which must be in /etc/radsecproxy (unless
-you alter it in the header file), the current directory, or
-you can specify the location with the "-c" command line
-option (see below). See the enclosed example file for further
-instructions.
-
-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.
-
-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. contact <venaas@uninett.no>.
-
-Stig Venaas, 2007.05.24
+Libradsec is a RADIUS library for clients doing RADIUS over UDP or
+TLS. The goal is to add support for writing servers (and thus proxies)
+and to add transports TCP and DTLS.
+
+
+The canonical pickup point is
+http://git.nordu.net/?p=radsecproxy.git;a=shortlog;h=refs/heads/libradsec
+
+
+The source code is licensed under a 3-clause BSD license. See the
+LICENSE file.
+
+
+Libradsec depends on 
+- libconfuse
+- libevent2
+- openssl (unless configured with --disable-tls)
+
+
+To compile the library and the examples, do something like
+
+  sh autogen.sh && ./configure && make
+
+
+There are a couple of options that can be used when configuring. See
+
+  ./configure --help
+
+for the full list. Worth mentioning here is --enable-tls-psk.
+
+If the preprocessor has a hard time finding some of the header files
+are, try setting environment variable CPPFLAGS at configure
+time. Example:
+
+  CPPFLAGS="-I/usr/local/include" ./configure --enable-tls
+
+If the link editor has trouble finding any of the libraries needed,
+try setting environment variable LDFLAGS at configure time. Example:
+
+  LDFLAGS="-L/usr/local/lib" ./configure --enable-tls
+
+
+The parts of the library which has been tested has been so on Linux
+(Debian) with libconfuse (2.7), libevent (2.0.19) and OpenSSL
+(1.0.1c).
+
+The file HACKING contains more detailed info on the state of the
+various parts of the library.