Add an error code.
[radsecproxy.git] / README
1 This is unreleased radsecproxy 2.0-alpha.
2
3 radsecproxy is a generic RADIUS proxy that supports both UDP and TLS
4 (RadSec) RADIUS transports.  There is also experimental support for
5 TCP and DTLS.
6
7 It should build on most Linux and BSD platforms by simply typing
8 "./configure && make".  It is possible to specify which RADIUS
9 transport the build should support.  Without any special options to
10 configure, all transports supported by the system will be enabled.
11 See the output from "configure --help" for how to change this.
12
13 Known build issues:
14 - Older BSD's (like NetBSD 4.x) need newer OpenSSL in order to support
15   DTLS.  Workaround: ./configure --disable-dtls.
16 - FreeBSD 6.x needs newer OpenSSL to build at all.
17
18 To use radsecproxy you need to create a config file which normally is
19 called "/etc/radsecproxy.conf".  You can also specify the location
20 with the "-c" command line option (see below).  For further
21 instructions, please see the enclosed example file and the
22 documentation at
23 http://software.uninett.no/radsecproxy/?page=documentation
24
25 There are five options that may be specified on the command line:
26 "-c configfile" to specify a non-default config file path.
27 "-d loglevel" to set a loglevel of 1, 2, 3, 4 and 5 where 5 is the
28               most detailed.
29 "-f" to run the proxy in the foreground with logging to stderr.
30      Without "-f" the default is to detach as a daemon and log to
31      syslog.
32 "-v" just prints version information and exits.
33 "-p" (pretend) makes the proxy go through the configuration files as
34      normal, but stops before creating any sockets or doing any
35      serious work.  This is useful for validating config files.