updated files for 1.3-beta release
[libradsec.git] / README
1 This is a revision from the radsecproxy 2.0 devel branch.
2
3 radsecproxy is a generic RADIUS proxy that can support various
4 RADIUS clients over UDP or TLS (RadSec).
5
6 It should build on most Linux and BSD platforms by simply typing
7 "make". You may also try to use autoconf. It is possible to
8 specify which RADIUS transport the build should support. With
9 just doing "make" one will support only UDP and TLS. See the
10 Makefile for how to change this. With autoconf (configure) there
11 will normally be support for all transport. You can use the
12 configure options --enable-udp, --enable-tcp, --enable-tls and
13 --enable-dtls where each of them may be set to yes or no to
14 enable or disable them.
15
16 To use it you need to create a config file which normally is
17 called "/etc/radsecproxy.conf". You can also specify the location
18 with the "-c" command line option (see below). For further
19 instructions, please see the enclosed example file and the
20 documentation at
21 http://software.uninett.no/radsecproxy/?page=documentation
22
23 There are five options that may be specified on the command line.
24 "-c configfile" to specify a non-default config file path;
25 "-d loglevel" to set a loglevel of 1, 2, 3 or 4 where 4 is the most
26 detailed; and "-f" to run the proxy in the foreground with logging
27 to stderr. Without "-f" the default is to detach as a daemon and
28 log to syslog. "-v" just prints version information and exits, while
29 "-p" (pretend) makes the proxy go through the configuration files as
30 normal, but stops before creating any sockets or doing any serious
31 work. This is useful for validating config files.
32
33 Thanks to Stefan Winter and Andreas Solberg for talking me into
34 doing this, and the funding from GEANT2. Stefan as well as Kolbjørn
35 Barmen, Ralf Paffrath and Maja Wolniewicz have helped with early
36 testing of the code.
37
38 All of the above plus Milan Sova have provided good feedback on
39 several implementation choices. Finally thanks to Hans Zandbelt
40 for providing the autoconf stuff. I may have forgotten someone,
41 let me know if you feel left out.
42
43 For more information, feedback etc. please see the information
44 at http://software.uninett.no/radsecproxy/
45
46 Stig Venaas <venaas@uninett.no> -- 2009.02.18