import from HEAD:
[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   The differences between 1.0.x and 1.1.0 are documented in the file
16 doc/ChangeLog.  What these differences mean for an administrator
17 upgrading from 1.0.x are as follows:
18
19   * You MUST use the new dictionaries.  This is NOT done by default,
20     because you may have edited the installed version of /etc/raddb/dictionary.
21     If you have not edited /etc/raddb/dictionary, then you can make
22     the server use the new dictionaries by copying the
23     raddb/dictionary file from this directory to /etc/raddb.  Without
24     this change, the server WILL NOT WORK PROPERLY.
25
26   * Sites using SQL for logging should look into using the new
27     rlm_sql_log module.  See it's "man" page for details.
28
29   * Sites using rlm_x99_token will have to update their configuration
30     to use rlm_otp.
31
32 3. DEBUGGING THE SERVER
33
34   Run the server in debugging mode, (radiusd -X) and READ the output.
35 We really can't emphasize this enough.
36
37   Read the FAQ.  Many questions are answered there.
38
39   Read the configuration files.  Many parts of the server have NO
40 documentation, other than comments in the configuration file.
41
42   Search the mailing lists.  There is a Google link on the bottom of
43   the page:
44
45         http://www.freeradius.org/list/users.html
46
47   Type some key words into the search box, and you should find
48 discussions about common problems and solution.
49
50
51   See the Wiki
52
53         http://wiki.freeradius.org
54
55 4. ADDITIONAL INFORMATION
56
57   See 'doc/README' for more information about FreeRADIUS.
58
59   There is now an O'Reilly book available, which we recommend for
60 people new to RADIUS.  It covers an earlier version of the server, but
61 much of the information is applicable to this version also.
62
63 http://www.amazon.com/exec/obidos/ASIN/0596003226/freeradiusorg-20/
64
65   It contains information about RADIUS in general, and FreeRADIUS in
66 particular.
67
68
69   For other RADIUS information, the Livington internet site had a lot
70 of information on radius online.  Unfortunately Livingston, and the
71 site, don't exist anymore but there's a copy of the site still at:
72
73         http://portmasters.com/www.livingston.com/
74
75   Especially worth a read is the "RADIUS for Unix administrators guide"
76
77 HTML:  http://portmasters.com/tech/docs/radius/1185title.html
78 PDF:   http://portmasters.com/tech/docs/pdf/radius.pdf
79
80
81 5. PROBLEMS AND CONCERNS
82
83   We understand that the server may be difficult to configure,
84 install, or administer.  It is, after all, a complex system with many
85 different configuration possibilities.  If you have any comments, bug
86 reports, problems, or concerns, please send them to the
87 'freeradius-users' list (see the URL above).  We will do our best to
88 answer your questions, to fix the problems, and to generally improve
89 the server in any way we can.
90
91   What you should NOT do is complain that the developers aren't
92 answering your questions quickly enough, or fixing the problems
93 quickly enough, or that they're being mean for telling you to do some
94 work yourself.  FreeRADIUS is the cumulative effort of many years of
95 work by many people, and you've gotten it for free.  No one gets paid
96 to work on FreeRADIUS, and no one is getting paid to answer your
97 questions.  This is free software, and the only way it gets better is
98 if you contribute work back to the project.
99
100   We will note that the people who complain the loudest about the
101 developers being mean usually can't program, can't write
102 documentation, won't pay others to do that work, demand that their
103 every desire be satisifed immediately by the developers for free, and
104 worst of all, don't understand why their attitude is unproductive.
105 They seem to believe that because they've received something (the
106 server) for free, that they have every right to demand more free
107 support and development from the list.  That's simply not true.
108
109   So please submit bug reports, suggestions, or patches.  That
110 feedback gives the developers a guide as to where they should focus
111 their work.  If you like the server, feel free to mail the list and
112 say so.