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