README.rst

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