Polled from branch_1_1 fix for bug #348
[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 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   There is now an O'Reilly book available, which we recommend highly:
51
52 http://www.amazon.com/exec/obidos/ASIN/0596003226/freeradiusorg-20/
53
54   It contains information about RADIUS in general, and FreeRADIUS in
55 particular.
56
57
58   For other RADIUS information, the Livington internet site had a lot
59 of information on radius online.  Unfortunately Livingston, and the
60 site, don't exist anymore but there's a copy of the site still at:
61
62         http://portmasters.com/www.livingston.com/
63
64   Especially worth a read is the "RADIUS for Unix administrators guide"
65
66 HTML:  http://portmasters.com/tech/docs/radius/1185title.html
67 PDF:   http://portmasters.com/tech/docs/pdf/radius.pdf
68
69
70 5. PROBLEMS AND CONCERNS
71
72   We understand that the server may be difficult to configure,
73 install, or administer.  It is, after all, a complex system with many
74 different configuration possibilities.  If you have any comments, bug
75 reports, problems, or concerns, please send them to the
76 'freeradius-users' list (see the URL above).  We will do our best to
77 answer your questions, to fix the problems, and to generally improve
78 the server in any way we can.
79
80   What you should NOT do is complain that the developers aren't
81 answering your questions quickly enough, or fixing the problems
82 quickly enough, or that they're being mean for telling you to do some
83 work yourself.  FreeRADIUS is the cumulative effort of many years of
84 work by many people, and you've gotten it for free.  No one gets paid
85 to work on FreeRADIUS, and no one is getting paid to answer your
86 questions.  This is free software, and the only way it gets better is
87 if you contribute work back to the project.
88
89   We will note that the people who complain the loudest about the
90 developers being mean usually can't program, can't write
91 documentation, won't pay others to do that work, demand that their
92 every desire be satisifed immediately by the developers for free, and
93 worst of all, don't understand why their attitude is unproductive.
94 They seem to believe that because they've received something (the
95 server) for free, that they have every right to demand more free
96 support and development from the list.  That's simply not true.
97
98   So please submit bug reports, suggestions, or patches.  That
99 feedback gives the developers a guide as to where they should focus
100 their work.  If you like the server, feel free to mail the list and
101 say so.