The FreeRADIUS server
=====================
-0. BRANCH STATE
----------------
-|BuildStatus|_
+|BuildStatus|_ |CoverityStatus|_
-.. |BuildStatus| image:: https://travis-ci.org/FreeRADIUS/freeradius-server.png
-.. _BuildStatus: https://travis-ci.org/FreeRADIUS/freeradius-server
+.. contents::
+ :local:
-1. INTRODUCTION
----------------
+Introduction
+------------
The FreeRADIUS Server Project is a high performance and highly
configurable RADIUS server that is available under the terms of the
the Internet access for hundreds of millions of people, in sites
ranging from 10 users, to 10 million and more users.
-Version 2.0 of the server is intended to be backwards compatible
-with previous versions, but also to have many new features, such as:
-
-* simple policy language (see ``man unlang``)
-* virtual servers (raddb/sites-available/README)
-* IPv6 support
-* better proxy support (raddb/proxy.conf)
-* More EAP types
-* Debugging output should be MUCH easier to understand
-* VMPS support
-* More modules are marked "stable" (python, etc.)
-* SQL configuration has been cleaned up (see raddb/sql/*)
-* limited support for HUP
-* check configuration and exit (``radiusd -C``)
-* Server core is now event based (simpler, more powerful)
+Version 3.0 of the server is largely compatible with version 2.x, but
+we highly recommend that you recreate your configuration, rather than
+trying to get the older configuration to work.
+
+For a list of changes in version 3.0, please see ``doc/ChangeLog``.
+
+See ``raddb/README.rst`` for information on what to do to update your
+configuration.
Administrators upgrading from a previous version should install this
version in a different location from their existing systems. Any
version, in order to take advantage of the new features which can
greatly simply configuration.
-While every attempt has been made to ensure that this version is
-backwards compatible with previous versions, there may be cases where
-it is not backwards compatible. In most cases, incompatibilities are
-a side-effect of fixing bugs, or of adding new features. Some
-configuration differences are noted below:
-
-* The recommended format for clients has changed. See "clients.conf".
- The old format should still work, but should be changed to use the
- new format.
-
-* The recommended formant for realms has changed. See "proxy.conf"
- The old format should still work, but should be changed to use the
- new format. In addition, the new format has much more flexibility.
-
-* Any configuration using TTLS or PEAP should be updated to use
- virtual servers. See "virtual_server" in "eap.conf", and
- "raddb/sites-available/inner-tunnel". In most cases, using an
- "inner-tunnel" virtual server will make the configuration MUCH
- simpler.
-
-* A number of deprecated command-line options have been removed.
- (``-y -z -A -l -g``) See "man radiusd". These configurations can be
- controlled in "radiusd.conf", so it is not necessary to have them
- as command-line options.
-
Please see http://freeradius.org and http://wiki.freeradius.org for
more information.
-2. INSTALLATION
----------------
+Installation
+------------
To install the server, please see the INSTALL file in this directory.
-3. DEBUGGING THE SERVER
------------------------
+Debugging the Server
+--------------------
Run the server in debugging mode, (``radiusd -X``) and READ the output.
We cannot emphasize this point strongly enough. The vast majority of
discussions about common problems and solution.
-4. ADDITIONAL INFORMATION
--------------------------
+Additional Information
+----------------------
-See 'doc/README' for more information about FreeRADIUS.
+See ``doc/README`` for more information about FreeRADIUS.
There is an O'Reilly book available. It serves as a good
-introduction for anyone new to RADIUS. However, it is almost 5 years
+introduction for anyone new to RADIUS. However, it is almost 11 years
old, and is not much more than a basic introduction to the subject.
http://www.amazon.com/exec/obidos/ASIN/0596003226/freeradiusorg-20/
-For other RADIUS information, the Livington internet site had a lot
-of information about radius online. Unfortunately Livingston, and the
-site, don't exist anymore but there is a copy of the site still at:
-
-http://portmasters.com/www.livingston.com/
-
-Especially worth reading is the "RADIUS for Unix administrators guide"
-
-* HTML: http://portmasters.com/tech/docs/radius/1185title.html
-* PDF: http://portmasters.com/tech/docs/pdf/radius.pdf
-
-
-5. PROBLEMS AND CONCERNS
-------------------------
+Problems and Concerns
+---------------------
We understand that the server may be difficult to configure,
install, or administer. It is, after all, a complex system with many
2. Save a copy of the default configuration: It WORKS. Don't change it!
3. Verify that the server starts. (You ARE using debugging mode, right?)
4. Send it test packets using "radclient", or a NAS or AP.
-5. Verify that the server does what you expect.
- - If it does not work, change the configuration, and go to step (3)
- If you're stuck, revert to using the "last working" configuration.
- - If it works, proceed to step (6).
+5. Verify that the server does what you expect
+ - If it does not work, change the configuration, and go to step (3)
+ - If you're stuck, revert to using the "last working" configuration.
+ - If it works, proceed to step (6).
6. Save a copy of the working configuration, along with a note of what
you changed, and why.
7. Make a SMALL change to the configuration.
frustrating than quickly making forward progress!
-6. FEEDBACK
------------
+Feedback
+--------
If you have any comments, bug reports, problems, or concerns, please
send them to the 'freeradius-users' list (see the URL above). We will
Please submit bug reports, suggestions, or patches. That feedback
gives the developers a guide as to where they should focus their work.
If you like the server, feel free to mail the list and say so.
+
+.. |CoverityStatus| image:: https://scan.coverity.com/projects/58/badge.svg?
+.. _CoverityStatus: https://scan.coverity.com/projects/58
+
+.. |BuildStatus| image:: https://travis-ci.org/FreeRADIUS/freeradius-server.png
+.. _BuildStatus: https://travis-ci.org/FreeRADIUS/freeradius-server
projects / freeradius.git / blobdiff