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