Enable tls psk

[libradsec.git] / README

diff --git a/README b/README
index 43be4c6..4c0d277 100644 (file)
--- a/README
+++ b/README
@@ -1,23 +1,48 @@
-This is a beta version of a generic RADIUS proxy that can support
-various RADIUS clients over UDP or TLS (RadSec).
+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.
 
-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.
 
-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.
+The canonical pickup point is
+http://git.nordu.net/?p=radsecproxy.git;a=shortlog;h=refs/heads/libradsec
 
-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.
 
-For more information, feedback etc. contact <venaas@uninett.no>.
+The source code is licensed under a 3-clause BSD license. See the
+LICENSE file.
 
-Stig Venaas, 2007.05.14
+
+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.