We hope that you don't have any problems, installing FreeRADIUS, but if you do, read the FAQ first to see if it's happened to many other people. If you don't find the answer there, then ask the freeradius-users mailing list.

Getting the software

There are two ways of getting the server, and both are described on our instruction page.

Installation

Here's the quick-and-dirty step-by-step guide.

If you have any questions or problems, please read the following files:

Many of the modules are documented only in the comments in the radiusd.conf file, sorry. If this is insufficient, feel free to submit changes or updates.

If the server is installed properly on your local system, you should be able to type man rlm_foo to see the "man" page for the module "foo". See also the online man pages for hypertext versions.

Not all modules have "man" pages, so please read the radiusd.conf file for additional documentation.

Documentation

There is plenty of documentation in the doc/ directory, but it is not complete as of yet. We're working on it, but slowly. As always, patches are welcome.

Have we mentioned the RADIUS book? It covers a number of topics which aren't in the FreeRADIUS documentation, including detailed descriptions of the RADIUS attributes.

The RADIUS RFCs are available on-line. They are not meant for the average user, but they are the definitive reference for RADIUS. Any RADIUS protocol questions can usually be answered by reading the RFCs.

For a quick reference, the RADIUS attributes are listed here. The names in the list link to the definition of the attributes in the RFCs. If you're looking for an attribute to do something, or want to know what an attribute does, then the attribute list is the best place to start.

There are additional attributes not defined in the RFCs. These are usually vendor-specific attributes, and there is little to no documentation available outside of the vendor, for those attributes. The dictionary files (in the share/ directory) which are distributed with FreeRADIUS list the names of many vendor-specific attributes, and often contain pointers to the vendor web site which documents those attributes.

Getting help

If you've read the documentation, and still aren't satisfied, you should consider joining the freeradius-users list.

mailing list

A lot of the users of FreeRADIUS are on the freeradius-users list, and it's an excellent source of advice and information. There's a list of rules one must follow along with the instructions on how to join.

There is a mailing list for developers too, but it's for programmers and documentation-writers only. Don't ask a ``how do I'' question there, as it'll be ignored or flamed. There's a user-list for a reason; use it.

reporting bugs

If you and the list think you've found a bug, please report it to the developers via the mailing list. Also, make sure that the version you're using is the most recently released version of FreeRADIUS, and that you don't have any local patches applied..