FreeRADIUS Documentation

For people new to RADIUS, we strongly recommend reading the FreeRADIUS technical guide. It explains how RADIUS works, and gives a good introduction to FreeRADIUS.

Configuring the server can be a complex task. This task is made easier in recent versions, as we continually improve the documentation and "default" configurations. The configuration files and documentation that comes with the server should be your first source of information. Most things are documented there, along with explanations as to what to do, and why.

The wiki has a lot more documentation on many subjects. The wiki should be your second source of information about the server.

Many people try to find documentation by typing keywords into google. This method is not generally productive. Most of the links are to other people asking the same question, or to out-dated third party documentation. Most people can easily get lost in a mess of contradictory and confusing documentation, leading to frustration and a badly configured server.

Nearly all third-party documentation and How-To's are wrong and outdated. We strongly suggest that you do not follow any documentation which is more than 4 years old. If you do follow such ancient documentation, the result will likely be a server that does not work.

New users of the server should read the getting started page. It describes how to set up a test user, and how to add a new client. These are the two basic steps which start all new installations.

The debugging page describes how to debug the server. PLEASE READ IT. Many problems can be solved by running the server in debugging mode, and reading the output.

If you are using Version 1 or 2 of the server, we suggest upgrading to Version 3. Version 1 is no longer supported, and Version 2 is EOL

If all else fails, commercial support is available.

Where the Documentation is located

The server comes with documentation. The doc/ directory contains a number of files, named for their functionality. The configuration files contain enormous amounts of documentation. Each configuration directive is documented in comments where it is used. The raddb/sites-available directory contains many example "virtual servers". Each example has comments describing what it does, when it should be used, and how to configure it.


The Wiki has a fair amount of documentation and How-To's. It is a good starting resource.

The Wiki is searchable. Simply type in a few keywords, and you will get pages which often answer your questions and help you solve problems. You can also edit the wiki to add or update information.

Manual pages

The on-line man pages contain documentation for programs, configuration files, and modules.

All of the "man" pages are available on any system running FreeRADIUS. We suggest typing man radiusd, and reading it. It contains instructions for configuring and debugging the server.

Useful How-To's

The web site Deploying RADIUS has a number of useful documents that are kept up to date with newer versions of the server. These documents include:

Full Server Documentation

The Network RADIUS site has full server documentation. It is a work in process, and is as yet incomplete. However, it has exensive documentation on:

API Documentation

The Doxygen doc site has a copy of the API documentation. This is primarily for developers, but may also be useful for notes describing hidden or advanced options.

The API documentation site is not useful for people who want to configure FreeRADIUS.

Older Documents

Novell eDirectory Integration

An administration guide to FreeRADIUS and Novell eDirectory is available. For the latest version of the "Integrating Novell eDirectory with FreeRADIUS" administration guide, refer to Novell's site.