Re-arranged the documentation, to make it easier to follow for
[freeradius.git] / README
1 1. INTRODUCTION
2
3   The FreeRADIUS Server Project is a high performance and highly
4 configurable GPL'd free RADIUS server. The server is similar in some
5 respects to Livingston's 2.0 server.  While FreeRADIUS started as a
6 variant of the Cistron RADIUS server, they don't share a lot in common
7 any more.  It now has many more features than Cistron or Livingston,
8 and is much more configurable.
9
10   FreeRADIUS is an Internet authentication daemon, which implements
11 the RADIUS protocol, as defined in RFC 2865 (and others).  It allows
12 Network Access Servers (NAS boxes) to perform authentication for
13 dial-up users.  There are also RADIUS clients available for Web
14 servers, firewalls, Unix logins, and more.  Using RADIUS allows
15 authentication and authorization for a network to be centralized, and
16 minimizes the amount of re-configuration which has to be done when
17 adding or deleting new users.
18
19   Please see the main web page (http://www.freeradius.org) for more
20 up-to-date information.
21
22 2. INSTALLATION
23
24   To install the server, please see the INSTALL file in this
25 directory.
26
27 3. DEBUGGING THE SERVER
28
29   Run the server in debugging mode, (radiusd -X) and READ the output.
30 We really can't emphasize this enough.
31
32   Read the FAQ.  Many questions are answered there.
33
34   Read the configuration files.  Many parts of the server have NO
35 documentation, other than comments in the configuration file.
36
37   Search the mailing lists.  There is a Google link on the bottom of
38   the page:
39
40         http://www.freeradius.org/list/users.html
41
42   Type some key words into the search box, and you should find
43 discussions about common problems and solution.
44
45
46 4. ADDITIONAL INFORMATION
47
48   See 'doc/README' for more information about FreeRADIUS.
49
50   For more general RADIUS information, the Livington internet site had
51 a lot of information on radius online.  Unfortunately Livingston, and
52 the site, don't exist anymore but there's a copy of the site still at:
53
54         http://portmasters.com/www.livingston.com/
55
56   Especially worth a read is the "RADIUS for Unix administrators guide"
57
58 HTML:  http://portmasters.com/tech/docs/radius/1185title.html
59 PDF:   http://portmasters.com/tech/docs/pdf/radius.pdf