Skip to content

Commit a415d20

Browse files
committed
Nav topo changes and files added. Incorporated editorial comments from PR and updated spacing/heading levels.
1 parent 2b8351c commit a415d20

File tree

19 files changed

+1469
-191
lines changed

19 files changed

+1469
-191
lines changed

doc/antora/modules/ROOT/nav.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
* xref:index.adoc[Introduction]
2-
** xref:radiusd_x.adoc[radiusd -X]
2+
** xref:getstarted.adoc[Getting Started]
3+
*** xref:radiusd_x.adoc[Debugging]
4+
*** xref:gethelp.adoc[Getting Help]
35
** xref:faq.adoc[FAQ]
Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# Getting Help
2+
3+
## Official Documentation
4+
5+
A lot of information can be found online for FreeRADIUS, but most of this information is out-of-date or
6+
incorrect. Avoid third party documentation refer to the documentation created by FreeRADIUS and InkBridge Networks
7+
as outlined below:
8+
9+
* https://www.freeradius.org[FreeRADIUS]
10+
* https://www.inkbridgenetworks.com[InkBridge Networks]
11+
12+
## What Email list do I use?
13+
14+
There are several mailing lists associated with the FreeRADIUS server project. The lists are on
15+
the http://freeradius.org/list/[freeRADIUS] website. The current lists are:
16+
17+
* *mailto:freeradius-users@lists.freeradius.org[freeradius-users]*
18+
This list is for all users of FreeRADIUS and deals with general questions related to FreeRADIUS
19+
* *mailto:freeradius-devel@lists.freeradius.org[freeradius-devel]*
20+
This list is for developers who are writing code for FreeRADIUS.The content is highly technical and is
21+
not suited to the average user.
22+
* *mailto:freeradius-announce@lists.freeradius.org[reeradius-announce]*
23+
This list is for all users of FreeRADIUS. Announcements about FreeRADIUS, including new versions
24+
and security issues, are made here.
25+
26+
## How can I get training for my staff?
27+
28+
https://www.inkbridgenetworks.com/[Inkbridge Networks] offers a range of training courses to meet your needs. Courses include:
29+
30+
* *Introduction to RADIUS* is an introductory course for all administrators who are unfamiliar with
31+
RADIUS. Basic RADIUS concepts that are key to understanding RADIUS-based systems are
32+
introduced.
33+
* *Advanced RADIUS* is a course for senior administrators who are already familiar with RADIUS. It
34+
introduces advanced RADIUS concepts that will help system administrators design, deploy, maintain
35+
and debug their systems.
36+
* *Programming with RADIUS* is a course for developers who wish to create their own customized
37+
solutions.
38+
39+
## How do I get support from a consultant?
40+
41+
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
42+
smoothly. InkBridge Networks are experts at designing a customized RADIUS solution that meet your needs. Your customized network will include
43+
the appropriate number of RADIUS and database servers for your particular business needs. We install the RADIUS server and database and generate
44+
the necessary tables, schemas, queries, and replication.
45+
46+
We can configure multiple forms of authorization on the same system simultaneously. The system can
47+
include:
48+
49+
* 802.1x
50+
* PEAP
51+
* EAP-TTLS
52+
* EAP-TLS
53+
* Authentication against Active Directory
54+
* MAC authentication
55+
* MAC auth bypass (MAB)
56+
57+
Existing systems can be migrated to our product or we can configure our product to work with your
58+
databases. The final result is a system that is robust, high performance, and easy to maintain. Contact us
59+
at sales@networkradius.com for more information.
Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
2+
= Getting Started with FreeRADIUS
3+
4+
This page describes how to perform the initial install and configuration of FreeRADIUS using a package.
5+
FreeRADIUS pre-built packages are available from https://packages.inkbridgenetworks.com[InkBridge Networks].
6+
This site contains the most current packages for all common OS platforms for the latest FreeRADIUS release.
7+
8+
FreeRADIUS can also be installed from the source code. Please see the
9+
xref:howto:installation/index.adoc[installation guide] for instructions.
10+
11+
== Get the Source
12+
13+
This page describes how to perform the initial install and configuration of FreeRADIUS.
14+
FreeRADIUS can be installed using the pre-built packages available from https://packages.inkbridgenetworks.com[InkBridge Networks].
15+
This site contains packages for all common OS platforms and has the most current packages
16+
for the latest release.
17+
18+
FreeRADIUS can also be installed from the source code. Please see the
19+
xref:howto:installation/index.adoc[installation guide] for instructions.
20+
21+
[NOTE]
22+
====
23+
Debian-based systems call the server daemon *freeradius* instead of radiusd and the configuration files are located in *`/etc/freeradius/`* instead of `/etc/raddb/`.
24+
====
25+
26+
== Start the server
27+
28+
Once the server has been downloaded and installed, start the server in debugging mode (as user root) by issuing the command:
29+
30+
. `radiusd -X`
31+
32+
If the message on your screen says *Ready to process requests*, the server is installed and configured properly.
33+
For help decoding the the output from radiusd -X, refer to the xref:radiusd_x.adoc[Debugging] for more details.
34+
35+
== Initial Tests
36+
37+
Test basic authentication by editing the users file (raddb/mods-config/files/authorize) and add the following line at the top of the file:
38+
39+
. testing Cleartext-Password := "password"
40+
41+
Save the file and restart the server in debugging mode (radiusd -X).
42+
Open a second terminal window and run radtest by issuing the command:
43+
44+
. `radtest testing password 127.0.0.1 0 testing123`
45+
46+
The expected result is that the server responds with an Access-Accept. If it doesn't, the debug log will show why.
47+
48+
If you do see an Access-Accept, then congratulations, the following authentication methods now work for the testing user:
49+
50+
PAP, CHAP, MS-CHAPv1, MS-CHAPv2, PEAP, EAP-TTLS, EAP-GTC, EAP-MD5.
51+
52+
Your next step is to add more users.
53+
54+
55+
== Add a Client
56+
57+
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.
58+
59+
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:
60+
61+
client new {
62+
ipaddr = 192.0.2.1
63+
secret = testing123
64+
}
65+
You should change the IP address 192.0.2.1 to be the address of the client which will be sending Access-Request packets.
66+
67+
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.
68+
69+
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
70+
71+
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.
72+
73+
## Configure the Server
74+
75+
To create complex configurations with a minimum of effort, follow the steps to configure the server *ONE* change at a time:
76+
77+
. Start with a "known working" configuration, such as supplied by the default installation.
78+
. Make one small change to the configuration file.
79+
. Start the server in debugging mode (radiusd -X).
80+
. Verify that the results are what you expect.
81+
82+
Your next step is to configure more server components.
83+
84+
## More Information
85+
86+
For specific problem solving, we recommend the xref:howto:index.adoc[Howto] guide.
87+
For configuring and testing individual modules, refer to
88+
xref:howto:modules/configuring_modules.adoc[Modules].
89+
90+
All of the xref:reference:raddb/index.adoc[Configuration Files] are available in
91+
hypertext format.
92+
93+
A detailed xref:reference:unlang/index.adoc[unlang] reference guide that describes the syntax and functionality of the keywords,
94+
data types, etc. used in the `unlang` processing language.
95+
96+
There is also xref:developers:index.adoc[Developers] documentation that includes
97+
the APIs references.

0 commit comments

Comments
 (0)