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