README.rst

   1 The FreeRADIUS server
   2 =====================
   3
   4 |BuildStatus|_ |CoverityStatus|_
   5
   6 1. INTRODUCTION
   7 ---------------
   8
   9 The FreeRADIUS Server Project is a high performance and highly
  10 configurable RADIUS server that is available under the terms of the
  11 GNU GPLv2.  Using RADIUS allows authentication and authorization for a
  12 network to be centralized, and minimizes the number of changes that
  13 have to be done when adding or deleting new users to a network.
  14
  15 FreeRADIUS can authenticate users on systems such as 802.1x (WiFi),
  16 dialup, PPPoE, VPN's, VoIP, and many others.  It supports back-end
  17 databases such as MySQL, PostgreSQL, Oracle, Microsoft Active
  18 Directory, OpenLDAP, and many more.  It is used daily to authenticate
  19 the Internet access for hundreds of millions of people, in sites
  20 ranging from 10 users, to 10 million and more users.
  21
  22 Version 3.0 of the server is largely compatible with version 2.x, but
  23 we highly recommend that you recreate your configuration, rather than
  24 trying to get the older configuration to work.
  25
  26 For a list of changes in version 3.0, please see ``doc/ChangeLog``.
  27
  28 See ``raddb/README.rst`` for information on what to do to update your
  29 configuration.
  30
  31 Administrators upgrading from a previous version should install this
  32 version in a different location from their existing systems.  Any
  33 existing configuration should be carefully migrated to the new
  34 version, in order to take advantage of the new features which can
  35 greatly simply configuration.
  36
  37 Please see http://freeradius.org and http://wiki.freeradius.org for
  38 more information.
  39
  40
  41 2. INSTALLATION
  42 ---------------
  43
  44 To install the server, please see the INSTALL file in this directory.
  45
  46
  47 3. DEBUGGING THE SERVER
  48 -----------------------
  49
  50 Run the server in debugging mode, (``radiusd -X``) and READ the output.
  51 We cannot emphasize this point strongly enough.  The vast majority of
  52 problems can be solved by carefully reading the debugging output,
  53 which includes WARNINGs about common issues, and suggestions for how
  54 they may be fixed.
  55
  56 Read the FAQ.  Many questions are answered there.  See the Wiki
  57
  58 http://wiki.freeradius.org
  59
  60 Read the configuration files.  Many parts of the server have NO
  61 documentation, other than comments in the configuration file.
  62
  63 Search the mailing lists.  There is a Google link on the bottom of
  64 the page:
  65
  66 http://www.freeradius.org/list/users.html
  67
  68 Type some key words into the search box, and you should find
  69 discussions about common problems and solution.
  70
  71
  72 4. ADDITIONAL INFORMATION
  73 -------------------------
  74
  75 See ``doc/README`` for more information about FreeRADIUS.
  76
  77 There is an O'Reilly book available.  It serves as a good
  78 introduction for anyone new to RADIUS.  However, it is almost 11 years
  79 old, and is not much more than a basic introduction to the subject.
  80
  81 http://www.amazon.com/exec/obidos/ASIN/0596003226/freeradiusorg-20/
  82
  83 For other RADIUS information, the Livington internet site had a lot
  84 of information about radius online.  Unfortunately Livingston, and the
  85 site, don't exist anymore but there is a copy of the site still at:
  86
  87 http://portmasters.com/www.livingston.com/
  88
  89 Especially worth reading is the "RADIUS for Unix administrators guide"
  90
  91 * HTML:  http://portmasters.com/tech/docs/radius/1185title.html
  92 * PDF:   http://portmasters.com/tech/docs/pdf/radius.pdf
  93
  94
  95 5. PROBLEMS AND CONCERNS
  96 ------------------------
  97
  98 We understand that the server may be difficult to configure,
  99 install, or administer.  It is, after all, a complex system with many
 100 different configuration possibilities.
 101
 102 The most common problem is that people change large amounts of the
 103 configuration without understanding what they're doing, and without
 104 testing their changes.  The preferred method of operation is the
 105 following:
 106
 107 1. Start off with the default configuration files.
 108 2. Save a copy of the default configuration: It WORKS.  Don't change it!
 109 3. Verify that the server starts.  (You ARE using debugging mode, right?)
 110 4. Send it test packets using "radclient", or a NAS or AP.
 111 5. Verify that the server does what you expect.
 112       - If it does not work, change the configuration, and go to step (3)
 113         If you're stuck, revert to using the "last working" configuration.
 114       - If it works, proceed to step (6).
 115 6. Save a copy of the working configuration, along with a note of what
 116    you changed, and why.
 117 7. Make a SMALL change to the configuration.
 118 8. Repeat from step (3).
 119
 120 This method will ensure that you have a working configuration that
 121 is customized to your site as quickly as possible.  While it may seem
 122 frustrating to proceed via a series of small steps, the alternative
 123 will always take more time.  The "fast and loose" way will be MORE
 124 frustrating than quickly making forward progress!
 125
 126
 127 6. FEEDBACK
 128 -----------
 129
 130 If you have any comments, bug reports, problems, or concerns, please
 131 send them to the 'freeradius-users' list (see the URL above).  We will
 132 do our best to answer your questions, to fix the problems, and to
 133 generally improve the server in any way we can.
 134
 135 Please do NOT complain that the developers aren't answering your
 136 questions quickly enough, or aren't fixing the problems quickly
 137 enough.  Please do NOT complain if you're told to go read
 138 documentation.  We recognize that the documentation isn't perfect, but
 139 it *does* exist, and reading it can solve most common questions.
 140
 141 FreeRADIUS is the cumulative effort of many years of work by many
 142 people, and you've gotten it for free.  No one gets paid to work on
 143 FreeRADIUS, and no one is getting paid to answer your questions.  This
 144 is free software, and the only way it gets better is if you make a
 145 contribution back to the project ($$, code, or documentation).
 146
 147 We will note that the people who get most upset about any answers to
 148 their questions usually do not have any intention of contributing to
 149 the project.  We will repeat the comments above: no one is getting
 150 paid to answer your questions or to fix your bugs.  If you don't like
 151 the responses you are getting, then fix the bug yourself, or pay
 152 someone to address your concerns.  Either way, make sure that any fix
 153 is contributed back to the project so that no one else runs into the
 154 same issue.
 155
 156 Support is available.  See the "support" link at the top of the main
 157 web page:
 158
 159 http://freeradius.org
 160
 161 Please submit bug reports, suggestions, or patches.  That feedback
 162 gives the developers a guide as to where they should focus their work.
 163 If you like the server, feel free to mail the list and say so.
 164
 165 .. |CoverityStatus| image:: https://scan.coverity.com/projects/58/badge.svg?
 166 .. _CoverityStatus: https://scan.coverity.com/projects/58
 167
 168 .. |BuildStatus| image:: https://travis-ci.org/FreeRADIUS/freeradius-server.png
 169 .. _BuildStatus: https://travis-ci.org/FreeRADIUS/freeradius-server