7279c41863e8d0cefbc3b2a35099fa0a0890ead2
[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. It is stable, and is currently
5 being used in many deployments with millions of users.
6
7   Please see the main web page (http://www.freeradius.org) for more
8 information.
9
10 2. INSTALLATION
11
12   To install the server, please see the INSTALL file in this
13 directory.
14
15 3. DEBUGGING THE SERVER
16
17   Run the server in debugging mode, (radiusd -X) and READ the output.
18 We really can't emphasize this enough.
19
20   Read the FAQ.  Many questions are answered there.
21
22   Read the configuration files.  Many parts of the server have NO
23 documentation, other than comments in the configuration file.
24
25   Search the mailing lists.  There is a Google link on the bottom of
26   the page:
27
28         http://www.freeradius.org/list/users.html
29
30   Type some key words into the search box, and you should find
31 discussions about common problems and solution.
32
33
34 4. ADDITIONAL INFORMATION
35
36   See 'doc/README' for more information about FreeRADIUS.
37
38   There is now an O'Reilly book available, which we recommend for
39 people new to RADIUS.  It covers an earlier version of the server, but
40 much of the information is applicable to this version also.
41
42 http://www.amazon.com/exec/obidos/ASIN/0596003226/freeradiusorg-20/
43
44   It contains information about RADIUS in general, and FreeRADIUS in
45 particular.
46
47
48   For other RADIUS information, the Livington internet site had a lot
49 of information on radius online.  Unfortunately Livingston, and the
50 site, don't exist anymore but there's a copy of the site still at:
51
52         http://portmasters.com/www.livingston.com/
53
54   Especially worth a read is the "RADIUS for Unix administrators guide"
55
56 HTML:  http://portmasters.com/tech/docs/radius/1185title.html
57 PDF:   http://portmasters.com/tech/docs/pdf/radius.pdf
58
59
60 5. PROBLEMS AND CONCERNS
61
62   We understand that the server may be difficult to configure,
63 install, or administer.  It is, after all, a complex system with many
64 different configuration possibilities.  If you have any comments, bug
65 reports, problems, or concerns, please send them to the
66 'freeradius-users' list (see the URL above).  We will do our best to
67 answer your questions, to fix the problems, and to generally improve
68 the server in any way we can.
69
70   What you should NOT do is complain that the developers aren't
71 answering your questions quickly enough, or fixing the problems
72 quickly enough, or that they're being mean for telling you to do some
73 work yourself.  FreeRADIUS is the cumulative effort of many years of
74 work by many people, and you've gotten it for free.  No one gets paid
75 to work on FreeRADIUS, and no one is getting paid to answer your
76 questions.  This is free software, and the only way it gets better is
77 if you contribute work back to the project.
78
79   We will note that the people who complain the loudest about the
80 developers being mean usually can't program, can't write
81 documentation, won't pay others to do that work, demand that their
82 every desire be satisifed immediately by the developers for free, and
83 worst of all, don't understand why their attitude is unproductive.
84 They seem to believe that because they've received something (the
85 server) for free, that they have every right to demand more free
86 support and development from the list.  That's simply not true.
87
88   So please submit bug reports, suggestions, or patches.  That
89 feedback gives the developers a guide as to where they should focus
90 their work.  If you like the server, feel free to mail the list and
91 say so.