Skip to content

Commit 1f0df07

Browse files
noladealandekok
authored andcommitted
clean up documentation.
Add new howto pages.
1 parent 3ddabc1 commit 1f0df07

33 files changed

+3014
-285
lines changed

doc/antora/modules/ROOT/pages/faq.adoc

Lines changed: 11 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,12 @@ This FreeRADIUS FAQ contains both general and technical information about FreeRA
88
99
Read this FAQ before posting questions to the mailing lists as your question may be answered.
1010

11-
1211
== FreeRADIUS Overview
1312

1413
FreeRADIUS is the worlds leading RADIUS server used by Internet Service Providers (ISPs), cellular providers, and corporate and educational networks. RADIUS, which stands for “Remote Authentication Dial In User Service”, is a network protocol used to manage network access using xref:concepts:authproto.adoc[Authentication, Authorization and Accounting] processes.
1514

1615
FreeRADIUS is developed by a group of people who call themselves "The FreeRADIUS Project" and is sponsored by https://www.inkbridgenetworks.com/[InkBridge Networks].
1716

18-
1917
=== What is FreeRADIUS and what is it supposed to do?
2018

2119
The FreeRADIUS Server is a daemon for unix and unix like operating systems which allows one to set up a radius protocol server. The RADIUS protocol manages the communication between network devices to facilitate remote user
@@ -25,7 +23,6 @@ authentication and accounting practices. See xref:concepts:architecture.adoc[Arc
2523
* Authorizes those users or devices for specific network services.
2624
* Accounts for and tracks the usage of those services.
2725

28-
2926
=== How does FreeRADIUS differ from other radius servers?
3027

3128
FreeRADIUS is an open-source product with all the benefits of open-source software that includes flexibility, scalibility, and cost-effectivness. FreeRADIUS has many features not found in other free and commercial versions. Some of these features are:
@@ -41,58 +38,46 @@ FreeRADIUS is an open-source product with all the benefits of open-source softwa
4138
* Exec-Program-Wait capability that allows an external program to execute after authentication and output a list of A/V pairs, which is then added to the reply.
4239
* Supports PAM.
4340

44-
4541
=== Can I install FreeRADIUS on any platform?
4642

4743
Yes. FreeRADIUS is compatible with all known equipment and products which implement the RADIUS standards. FreeRADIUS runs on a large number of 32 and 64 bit Unix-like platforms. Where there are compatibility issues is ofent due to third-party vendors' implementation of the relevant standards.
4844

49-
5045
=== Can I get binary packages of FreeRADIUS?
5146

5247
Yes. You can find it on the official http://www.freeradius.org/[FreeRADIUS] site.
5348

54-
5549
=== Can I build and install FreeRADIUS from source?
5650

5751
Yes. The source is available at ftp://ftp.freeradius.org/pub/radius/[ftp] or on https://github.com/FreeRADIUS/freeradius-server[github]. See the xref:howto:installation/source.adoc[instructions] on how to build FreeRADIUS.
5852

59-
6053
=== Does FreeRADIUS Support IPv6?
6154

6255
Yes. FreeRADIUS v2 and later has full support for both IPv6 attributes and IPv6 network packets.
6356

64-
6557
=== Can I get more information?
6658

67-
Yes. The official site for http://www.freeradius.org/[FreeRADIUS] contains the server, documentation, and additional RADIUS programs.
68-
69-
The mailto:freeradius-announce@lists.freeradius.org[freeradius-announce], mailto:freeradius-users@lists.freeradius.org[freeradius-users], and mailto:freeradius-devel@lists.freeradius.org[freeradius-devel] mailing lists are available for you to subscribe to.
70-
71-
FreeRADIUS is supported by the https://www.inkbridgenetworks.com/[InkBridge Networks] team.
59+
Yes. The official site for http://www.freeradius.org/[FreeRADIUS] contains the server, documentation, and additional RADIUS programs. FreeRADIUS is supported by the https://www.inkbridgenetworks.com/[InkBridge Networks] team.
7260

61+
include::partial$mailinglist.adoc[]
7362

7463
== User Management
7564

76-
7765
=== Can I disconnect a user with FreeRADIUS?
7866

7967
No. A user with an active session can't be disconnected with FreeRADIUS. The RADIUS server doesn't actively maintain the user sessions and only receives information about these sessions from the NAS. This means that you have to signal your NAS to disconnect sessions. Depending on the NAS type and it's configuration, there are a number of ways to disconnect sessions.
8068

81-
82-
.Packet of Disconnect
69+
.Packet of disconnect
8370
[%collapsible]
8471
====
8572
Packet of Disconnect is the standard and recommended method to disconnect users. It is supported by many newer NAS and uses a RADIUS packet (usually sent to port 3799 although some NAS use 1700 (Mikrotik for example)) to signal that a NAS should terminate an active session.
8673
====
8774

88-
8975
.SNMP
9076
[%collapsible]
9177
====
9278
Many NAS support SNMP which can usually (among other things) be used to disconnect users, however implimentation details vary. Read your NAS documentation to find out whether it supports this, and which MIB to use.
9379
====
9480

95-
9681
.Radkill
9782
[%collapsible]
9883
====
@@ -101,7 +86,6 @@ The radkill tool is a TCL program written by Jason Straight for FreeRADIUS users
10186
Download the ftp://ftp.nmo.net/pub/radkill/radkill-latest.tar.gz[radkill] source archive and install the program on your server.
10287
====
10388

104-
10589
=== Can I send a message to PPP users?
10690

10791
Yes. RADIUS defines a Reply-Message attribute, which you can use to
@@ -110,7 +94,6 @@ passing text messages back to the user.
11094

11195
However, Microsoft windows users can't see PPP messages due to Microsoft's implementation of the PPP protocol. For macs, the only dialer that shows up the server's message is http://www.rockstar.com[FreePPP].
11296

113-
11497
=== Can I use Login-Time for groups instead of users?
11598

11699
Yes. There are several methods to manage login time for groups.
@@ -131,7 +114,6 @@ DEFAULT Group == "daysonly", Login-Time := "Any0800-2000"
131114
|DEFAULT Group == "weekends", Login-Time := "Sa-Su0800-2000"
132115
|===
133116

134-
135117
=== Can I permit access to any user regardless of password?
136118

137119
Yes. Edit the raddb/users file with the following entry on the first line (top of the file). This entry accepts everybody on to the network.
@@ -140,10 +122,8 @@ Yes. Edit the raddb/users file with the following entry on the first line (top o
140122

141123
If you want this to apply to a single user replace DEFAULT with username. You can also add Auth-Type Accept to radcheck or radgroupcheck entries in order to accept that user/group. This only works for PAP, and does NOT work for EAP-TLS, CHAP, MSCHAP, or WIMAX authentication.
142124

143-
144125
== Server Configuration
145126

146-
147127
=== Is there a way to bind FreeRADIUS to a specific IP address?
148128

149129
Yes. There are several ways to bind the IP address.
@@ -164,16 +144,18 @@ Yes. There are several ways to bind the IP address.
164144

165145
No. The RADIUS server only logs the messages which a NAS sends to it. If your NAS is not sending those messages or attributes, then the RADIUS server will not log them. Configure your NAS to send the information you want to the RADIUS server. Once the NAS is sending the information, the server can then log it.
166146

167-
168147
=== Do I need to use the Attribute Operators?
169148

170149
Yes. All of the attribute operators such as `:=`, `==`, `+=`, etc. are documented via the:
171150

172151
* xref:reference:raddb/mods-config/files/users.adoc[users] file,
173-
* xref:reference:unlang/condition/index.adoc[conditional expressions],
174-
* xref:reference:unlang/edit.adoc[attribute editing]
152+
* xref:reference:unlang/condition/index.adoc[conditional expressions],
153+
* xref:reference:unlang/edit.adoc[attribute editing].
175154

176-
Note that the xref:reference:unlang/update.adoc[update] is no longer necessary. The new xref:reference:unlang/edit.adoc[attribute editing] is much simpler, and is more powerful.
155+
[NOTE]
156+
===
157+
The xref:reference:unlang/update.adoc[update] is no longer necessary. The new xref:reference:unlang/edit.adoc[attribute editing] is much simpler, and is more powerful.
158+
===
177159

178160
=== Can I send multiple values for an attribute ?
179161

@@ -193,7 +175,6 @@ Yes. use the following example to configure multiple values on an attribute.
193175
0x0010: 302e 302e 302e 3020 3130
194176
====
195177

196-
197178
=== Isn't CHAP more secure?
198179

199180
No. If CHAP is implemented as the authentication protocol, a file resides on your network with cleartext passwords for all the users that log on using FreeRADIUS. This is a limitation of the CHAP protocol itself, not the RADIUS protocol. The CHAP protocol **requires** that you store the passwords in plain-text format.
@@ -213,15 +194,13 @@ As an administrator, decide which authentication method is required for your bus
213194
|passwords going cleartext over the phone line between the user and the terminal server.
214195
|===
215196

216-
217197
=== Can I limit access to only POP3 and SMTP?
218198

219199
Yes. The most common approach is to just assign non-globally-routable IP addresses to those users, such as https://datatracker.ietf.org/doc/html/rfc1918[RFC 1918] addresses. Make sure you have RADIUS authorization enabled on your NAS.
220200

221201
Depending on your internal network configuration, you may need to set up internal routes for those addresses, and if you don't want them to do anything besides SMTP and POP3 within your network, you'll have to set up ACLs on your dialup interfaces allowing only ports 25 and 110 through.
222202

223-
224-
.User entry in raddb/users file example:
203+
User entry in raddb/users file example
225204
[%collapsible]
226205
====
227206
@@ -231,7 +210,7 @@ Depending on your internal network configuration, you may need to set up interna
231210
Fall-Through = Yes
232211
====
233212

234-
.CISCO configuation example:
213+
.CISCO configuation example
235214
[%collapsible]
236215
====
237216
aaa authorization network default radius
@@ -243,7 +222,6 @@ Depending on your internal network configuration, you may need to set up interna
243222
The access list 160 gets applied on inbound packets and 161 on outbound packets.
244223
====
245224

246-
247225
=== Can I use Privledged Access Management (PAM) with FreeRADIUS?
248226

249227
Yes. Retrieve the redhat/radiusd.pam file from the distribution and save it as a new file in /etc/pam.d/radiusd.
@@ -266,7 +244,6 @@ and
266244

267245
With this method, I have NO users on /etc/password and NO need for lots of lines on /etc/raddb/users. time to search for a db enabled pam_listfile module
268246

269-
270247
=== Is the RADIUS server broken after an upgrade?
271248

272249
No. After upgrading to FreeRADIUS, some users are unable to fully use the network, but their access worked with the previous RADIUS server you were using.

doc/antora/modules/ROOT/pages/gethelp.adoc

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,16 +9,9 @@ A lot of information can be found online for FreeRADIUS, but most of this inform
99
1010
## What Email list do I use?
1111

12-
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:
13-
14-
* *mailto:freeradius-users@lists.freeradius.org[freeradius-users]*
15-
This list is for all users of FreeRADIUS and deals with general questions related to FreeRADIUS
16-
* *mailto:freeradius-devel@lists.freeradius.org[freeradius-devel]*
17-
This list is for developers who are writing code for FreeRADIUS.The content is highly technical and is
18-
not suited to the average user.
19-
* *mailto:freeradius-announce@lists.freeradius.org[freeradius-announce]*
20-
This list is for all users of FreeRADIUS. Announcements about FreeRADIUS, including new versions
21-
and security issues, are made here.
12+
There are several mailing lists associated with the FreeRADIUS server project. The lists are on the http://freeradius.org/list/[freeRADIUS] website.
13+
14+
include::partial$mailinglist.adoc[]
2215

2316
## How can I get training for my staff?
2417

doc/antora/modules/ROOT/pages/getstarted.adoc

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,6 @@ https://packages.inkbridgenetworks.com[InkBridge Networks]. This site
77
contains the most current packages for all common OS platforms for the
88
latest FreeRADIUS release.
99

10-
FreeRADIUS can also be installed from the source code. Please see the
11-
xref:howto:installation/index.adoc[installation guide] for instructions.
12-
1310
== Get the Source
1411

1512
This page describes how to perform the initial install and

0 commit comments

Comments
 (0)