Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion doc/antora/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
* xref:index.adoc[Introduction]
** xref:radiusd_x.adoc[radiusd -X]
** xref:getstarted.adoc[Getting Started]
*** xref:radiusd_x.adoc[Debugging]
*** xref:gethelp.adoc[Getting Help]
** xref:faq.adoc[FAQ]
59 changes: 59 additions & 0 deletions doc/antora/modules/ROOT/pages/gethelp.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# Getting Help

## Official Documentation

A lot of information can be found online for FreeRADIUS, but most of this information is out-of-date or
incorrect. Avoid third party documentation refer to the documentation created by FreeRADIUS and InkBridge Networks
as outlined below:

* https://www.freeradius.org[FreeRADIUS]
* https://www.inkbridgenetworks.com[InkBridge Networks]

## What Email list do I use?

There are several mailing lists associated with the FreeRADIUS server project. The lists are on
the http://freeradius.org/list/[freeRADIUS] website. The current lists are:

* *mailto:freeradius-users@lists.freeradius.org[freeradius-users]*
This list is for all users of FreeRADIUS and deals with general questions related to FreeRADIUS
* *mailto:freeradius-devel@lists.freeradius.org[freeradius-devel]*
This list is for developers who are writing code for FreeRADIUS.The content is highly technical and is
not suited to the average user.
* *mailto:freeradius-announce@lists.freeradius.org[reeradius-announce]*
This list is for all users of FreeRADIUS. Announcements about FreeRADIUS, including new versions
and security issues, are made here.

## How can I get training for my staff?

https://www.inkbridgenetworks.com/[Inkbridge Networks] offers a range of training courses to meet your needs. Courses include:

* *Introduction to RADIUS* is an introductory course for all administrators who are unfamiliar with
RADIUS. Basic RADIUS concepts that are key to understanding RADIUS-based systems are
introduced.
* *Advanced RADIUS* is a course for senior administrators who are already familiar with RADIUS. It
introduces advanced RADIUS concepts that will help system administrators design, deploy, maintain
and debug their systems.
* *Programming with RADIUS* is a course for developers who wish to create their own customized
solutions.

## How do I get support from a consultant?

Our goal at https://www.inkbridgenetworks.com/support[InkBridge Networks] is to help you build a world-class system and to make sure it operates
smoothly. InkBridge Networks are experts at designing a customized RADIUS solution that meet your needs. Your customized network will include
the appropriate number of RADIUS and database servers for your particular business needs. We install the RADIUS server and database and generate
the necessary tables, schemas, queries, and replication.

We can configure multiple forms of authorization on the same system simultaneously. The system can
include:

* 802.1x
* PEAP
* EAP-TTLS
* EAP-TLS
* Authentication against Active Directory
* MAC authentication
* MAC auth bypass (MAB)

Existing systems can be migrated to our product or we can configure our product to work with your
databases. The final result is a system that is robust, high performance, and easy to maintain. Contact us
at sales@networkradius.com for more information.
97 changes: 97 additions & 0 deletions doc/antora/modules/ROOT/pages/getstarted.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@

= Getting Started with FreeRADIUS

This page describes how to perform the initial install and configuration of FreeRADIUS using a package.
FreeRADIUS pre-built packages are available from https://packages.inkbridgenetworks.com[InkBridge Networks].
This site contains the most current packages for all common OS platforms for the latest FreeRADIUS release.

FreeRADIUS can also be installed from the source code. Please see the
xref:howto:installation/index.adoc[installation guide] for instructions.

== Get the Source

This page describes how to perform the initial install and configuration of FreeRADIUS.
FreeRADIUS can be installed using the pre-built packages available from https://packages.inkbridgenetworks.com[InkBridge Networks].
This site contains packages for all common OS platforms and has the most current packages
for the latest release.

FreeRADIUS can also be installed from the source code. Please see the
xref:howto:installation/index.adoc[installation guide] for instructions.

[NOTE]
====
Debian-based systems call the server daemon *freeradius* instead of radiusd and the configuration files are located in *`/etc/freeradius/`* instead of `/etc/raddb/`.
====

== Start the server

Once the server has been downloaded and installed, start the server in debugging mode (as user root) by issuing the command:

. `radiusd -X`

If the message on your screen says *Ready to process requests*, the server is installed and configured properly.
For help decoding the the output from radiusd -X, refer to the xref:radiusd_x.adoc[Debugging] for more details.

== Initial Tests

Test basic authentication by editing the users file (raddb/mods-config/files/authorize) and add the following line at the top of the file:

. testing Cleartext-Password := "password"

Save the file and restart the server in debugging mode (radiusd -X).
Open a second terminal window and run radtest by issuing the command:

. `radtest testing password 127.0.0.1 0 testing123`

The expected result is that the server responds with an Access-Accept. If it doesn't, the debug log will show why.

If you do see an Access-Accept, then congratulations, the following authentication methods now work for the testing user:

PAP, CHAP, MS-CHAPv1, MS-CHAPv2, PEAP, EAP-TTLS, EAP-GTC, EAP-MD5.

Your next step is to add more users.


== Add a Client

Devices that communicate directly with the RADIUS server are the clients that we need to configure next. These clients can be a wireless access point(WAP) or network access switch(NAS). or other form of NAS. The network clients or end-users such as laptops, tablets, etc. do not talk directly to the RADIUS server.

The above test runs radtest from localhost. It is useful to add a new client, which can be done by editing the clients.conf file. Add the following content:

client new {
ipaddr = 192.0.2.1
secret = testing123
}
You should change the IP address 192.0.2.1 to be the address of the client which will be sending Access-Request packets.

The client should also be configured to talk to the RADIUS server, by using the IP address of the machine running the RADIUS server. The client must use the same secret as configured above in the client section.

Then restart the server in debugging mode, and run a simple test using the testing user. You should see an Access-Accept in the server output

The following steps outline the best known method for configuring the server. Following them lets you create complex configurations with a minimum of effort. Failure to follow them leads to days of frustration and wasted effort.

## Configure the Server

To create complex configurations with a minimum of effort, follow the steps to configure the server *ONE* change at a time:

. Start with a "known working" configuration, such as supplied by the default installation.
. Make one small change to the configuration file.
. Start the server in debugging mode (radiusd -X).
. Verify that the results are what you expect.

Your next step is to configure more server components.

## More Information

For specific problem solving, we recommend the xref:howto:index.adoc[Howto] guide.
For configuring and testing individual modules, refer to
xref:howto:modules/configuring_modules.adoc[Modules].

All of the xref:reference:raddb/index.adoc[Configuration Files] are available in
hypertext format.

A detailed xref:reference:unlang/index.adoc[unlang] reference guide that describes the syntax and functionality of the keywords,
data types, etc. used in the `unlang` processing language.

There is also xref:developers:index.adoc[Developers] documentation that includes
the APIs references.
Loading
Loading