Skip to content

Commit a353a4d

Browse files
noladenolade
committed
Nav topo changes and files added
1 parent 2b8351c commit a353a4d

File tree

15 files changed

+487
-49
lines changed

15 files changed

+487
-49
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]

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

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
#Getting Help
2+
3+
##Email and weblinks go here
4+
5+
## Official Support
6+
InkBridge Networks
7+
freeRADIUS org
8+
9+
##How can I get training for my staff?
10+
Inkbridge Networks offers a range of on-site training courses to meet your needs. Courses include:
11+
• Introduction to RADIUS An introductory course for all administrators who are unfamiliar with
12+
RADIUS. Basic RADIUS concepts that are key to understanding RADIUS-based systems are
13+
introduced.
14+
introduced.
15+
• Advanced RADIUS A course for senior administrators who are already familiar with RADIUS. It
16+
introduces advanced RADIUS concepts that will help system administrators design, deploy, maintain
17+
and debug their systems.
18+
• Programming with RADIUS A course for developers who wish to create their own customized
19+
solutions.
20+
21+
##How can I get a consultant to help me?
22+
23+
Our goal at Network RADIUS SARL is to help you build a world-class system and to make sure it operates
24+
smoothly. Network RADIUS SARL are experts at designing a customized RADIUS solution that meet your
25+
needs. Your customized network will include the appropriate number of RADIUS and database servers for
26+
your particular business needs. We install the RADIUS server and database and create the necessary
27+
tables, schemas, queries, and replication.
28+
29+
We can configure multiple forms of authorization on the same system simultaneously. The system can
30+
include:
31+
• 802.1x
32+
• 802.1x
33+
• PEAP
34+
• PEAP
35+
• EAP-TTLS
36+
• EAP-TTLS
37+
• EAP-TLS
38+
• EAP-TLS
39+
• Authentication against Active Directory
40+
• MAC authentication
41+
• MAC authentication
42+
• MAC auth bypass (MAB)
43+
• MAC auth bypass (MAB)
44+
45+
Existing systems can be migrated to our product or we can configure our product to work with your
46+
databases. The final result is a system that is robust, high performance, and easy to maintain. Contact us
47+
at sales@networkradius.com for more information.

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

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
2+
= Getting Started with FreeRADIUS
3+
4+
FreeRADIUS can be installed using the pre-built packages available
5+
from https://packages.networkradius.com[Network RADIUS,
6+
window="_blank"]. That page contains packages for all common OS
7+
distributions. New packages are available as soon as a new version
8+
has been released. Packages for older releases are also available for
9+
historical purposes.
10+
11+
FreeRADIUS can also be installed from the source code. Please see the
12+
xref:howto:installation/index.adoc[installation guide] for instructions.
13+
14+
WARNING: Many Operating System distributions ship versions of FreeRADIUS
15+
which are years out of date. Those versions may contain bugs which have
16+
been fixed in newer releases. We recommend using the
17+
https://packages.networkradius.com[Network RADIUS, window="_blank"] packages where
18+
possible.
19+
20+
Administrators who are new to FreeRADIUS should read the
21+
xref:concepts:index.adoc[concepts section] as it describes the concepts behind
22+
FreeRADIUS. It is vital for newcomers to understand these concepts, as the rest
23+
of the documentation assumes familiarity with them.
24+
25+
A detailed xref:reference:unlang/index.adoc[unlang] reference guide is also available.
26+
This section describes the syntax and functionality of the keywords,
27+
data types, etc. used in the `unlang` processing language.
28+
29+
All of the xref:reference:raddb/index.adoc[configuration files] are available in
30+
hypertext format. It can often be easier to read the configuration files
31+
in a nicely formatted version, instead of as a fixed-width font in a
32+
text editor.
33+
34+
For specific problem solving, we recommend the xref:howto:index.adoc[how-to]
35+
guides. These guides give instructions for reaching high-level goals, or for
36+
configuring and testing individual
37+
xref:howto:modules/configuring_modules.adoc[modules].
38+
39+
There is also xref:developers:index.adoc[developer documentation]. This section
40+
documents the APIs for developers. Most people can ignore it.
41+
42+
== Debugging
43+
44+
If you have ANY problems, concerns, or surprises when running the
45+
server, the the server should be run in debugging mode as root, from the
46+
command line:
47+
48+
```
49+
# radiusd -X
50+
```
51+
52+
It will produce a large number of messages. The answers to many
53+
questions, and the solution to many problems, can usually be found in
54+
these messages. When run in a terminal window, error messages will be
55+
shown in red text, and warning messages will be shown in yellow text.
56+
57+
For other use-cases, please look for `ERROR` or `WARNING` in the
58+
debug output. In many cases, those messages describe exactly what is
59+
going wrong, and how to fix it.
60+
61+
For further details, about the debug output see the
62+
https://wiki.freeradius.org/radiusd-X[radiusd-X, window="_blank"] page on the
63+
https://wiki.freeradius.org[wiki, window="_blank"].
64+
65+
== Getting Help
66+
67+
We also recommend joining the
68+
https://lists.freeradius.org/mailman/listinfo/freeradius-users[mailing
69+
list] in order to ask questions and receive answers. The developers are
70+
not on Stack Overflow, IRC, or other web sites. While the FreeRADIUS
71+
source is available on
72+
https://github.com/FreeRADIUS/freeradius-server/[GitHub, window="_blank"], questions
73+
posted there will not be answered.
74+
75+
Before posting to the list, please read the
76+
https://wiki.freeradius.org/list-help[list help, window="_blank"] page. That page explains
77+
how to run the server in debugging mode; how to understand the debug
78+
output; and what information to post to the list.
79+
80+
Commercial support for FreeRADIUS is available from
81+
https://networkradius.com/freeradius-support/[Network RADIUS, window="_blank"].

‎doc/antora/modules/ROOT/pages/index.adoc‎

Lines changed: 0 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -118,46 +118,6 @@ release. We do _not_ recommend using version 3 configuration files
118118
with version 4. The configuration files are _not_ compatible across a
119119
major version upgrade.
120120

121-
== Getting Started with FreeRADIUS
122-
123-
FreeRADIUS can be installed using the pre-built packages available
124-
from https://packages.networkradius.com[Network RADIUS,
125-
window="_blank"]. That page contains packages for all common OS
126-
distributions. New packages are available as soon as a new version
127-
has been released. Packages for older releases are also available for
128-
historical purposes.
129-
130-
FreeRADIUS can also be installed from the source code. Please see the
131-
xref:howto:installation/index.adoc[installation guide] for instructions.
132-
133-
WARNING: Many Operating System distributions ship versions of FreeRADIUS
134-
which are years out of date. Those versions may contain bugs which have
135-
been fixed in newer releases. We recommend using the
136-
https://packages.networkradius.com[Network RADIUS, window="_blank"] packages where
137-
possible.
138-
139-
Administrators who are new to FreeRADIUS should read the
140-
xref:concepts:index.adoc[concepts section] as it describes the concepts behind
141-
FreeRADIUS. It is vital for newcomers to understand these concepts, as the rest
142-
of the documentation assumes familiarity with them.
143-
144-
A detailed xref:reference:unlang/index.adoc[unlang] reference guide is also available.
145-
This section describes the syntax and functionality of the keywords,
146-
data types, etc. used in the `unlang` processing language.
147-
148-
All of the xref:reference:raddb/index.adoc[configuration files] are available in
149-
hypertext format. It can often be easier to read the configuration files
150-
in a nicely formatted version, instead of as a fixed-width font in a
151-
text editor.
152-
153-
For specific problem solving, we recommend the xref:howto:index.adoc[how-to]
154-
guides. These guides give instructions for reaching high-level goals, or for
155-
configuring and testing individual
156-
xref:howto:modules/configuring_modules.adoc[modules].
157-
158-
There is also xref:developers:index.adoc[developer documentation]. This section
159-
documents the APIs for developers. Most people can ignore it.
160-
161121
== Debugging
162122

163123
If you have ANY problems, concerns, or surprises when running the

‎doc/antora/modules/concepts/nav.adoc‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
* xref:index.adoc[Concepts]
2-
** General
3-
*** xref:aaa.adoc[AAA]
2+
** xref:overview.adoc[General]
3+
*** xref:architecture.adoc[Architecture]
4+
*** xref:authproto.adoc[Protocols]
5+
*** xref:database.adoc[Data Storage]
6+
** xref:aaa.adoc[AAA]
7+
*** xref:processing.adoc[Processing]
48
** Modules
59
*** LDAP
610
**** xref:modules/ldap/authentication.adoc[Authentication]
11+
** xref:resources.adoc[Resources]

‎doc/antora/modules/concepts/pages/aaa.adoc‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,3 +57,23 @@ xref:reference:unlang/list.adoc[attribute lists]:
5757

5858
All of these lists are available to all modules. All of these lists are available in xref:reference:unlang/index.adoc[Unlang]
5959

60+
=== Accounting
61+
62+
Accounting refers to the recording of resources a user consumes during the time they are on the network.
63+
The information gathered can include the amount of system time used, the amount of data sent, or the
64+
quantity of data received by the user during a session.
65+
66+
During a network session, the NAS periodically sends an accounting of user activity to the server. This
67+
accounting is a summary, and the collected data is used for billing purposes.
68+
ISPs are a large consumer of accounting data, because each user is billed for every minute of network
69+
access. However, corporations have not, historically, relied on network accounting information gathered
70+
by RADIUS because employees were not traditionally billed for network access. As their need for ongoing
71+
network monitoring increases, though, so does the need to store and process accounting information.
72+
The accounting summary sent by the NAS to the server does not include detailed information such as web
73+
sites visited or even how many bytes were transferred using a particular protocol (SMTP, HTTP, and so
74+
forth). That type of detailed information is only available to the NAS, and it does not send that data to the
75+
server.
76+
77+
If detailed information about user activity is required, network administrators can obtain it through other
78+
protocols such as sFlow or NetFlow. Network administrators may find it difficult to tie the pieces together to get a more comprehensive
79+
understanding of user activity.

‎doc/antora/modules/concepts/pages/architecture.adoc‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
= Architecture
2+
3+
RADIUS is a network protocol, a system that defines rules and conventions for communication between
4+
network device. Like many protocols, RADIUS uses a client-server model. A RADIUS client (also called a
5+
Network Access Server, or NAS) sends requests to a RADIUS server. The RADIUS server then processes the
6+
request and sends back a response.
7+
Common NAS products include wireless access points such as the Linksys WRT54G and dial-up
8+
equipment commonly available from large network manufacturers. Common RADIUS server products
9+
include Cisco ACS, Microsoft IAS, Funk (now Juniper) Steel Belted RADIUS, Open Systems Radiator, and
10+
FreeRADIUS.
11+
12+
While the RADIUS protocol shares the general concept of client-server communication with many other
13+
protocols such as HTTP and SMTP, the specifics of RADIUS communications differ. This section describes
14+
the RADIUS system in more detail, including the specific roles of the NAS, the server, and databases such
15+
as MySQL and Lightweight Directory Access Protocol (LDAP).
16+
17+
==RADIUS Components
18+
19+
===User / Device
20+
Requests access to the network. A device may be a laptop, modem, or VOIP Phone
21+
22+
===Network Access Server (NAS)
23+
Provides access to the network for the user/device. The NAS can be a switch, Wireless Access Point, or VPN Terminator.
24+
25+
===Authentication Server
26+
Receives authentication requests from the NAS and returns authentication results to the NAS.
27+
Optionally requests user and configuration information from the database or directory. The server may
28+
return configuration parameters to the NAS. Receives accounting information from the NAS. Some exanples of a RADIUS server
29+
are FreeRADIUS, Radiator, NPS, or IAS.
30+
31+
===Data Store
32+
Optional database or directory with user authentication and authorisation information. RADIUS server communicates with the
33+
data store using DB API or LDAP. Types of data stores include SQL Database, Kerberos Service Server, or an
34+
LDAP Directory.

‎doc/antora/modules/concepts/pages/authproto.adoc‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
= RADIUS
2+
3+
RADIUS is a protocol for remote user Authorization, Authentication and Accounting. Its primary use is for Internet Service Providers, though it may as well be used on any network that needs a centralised authentication and/or accounting service for its workstations.
4+
5+
RADIUS is often used in larger Wi-Fi (wireless) networks for authentication purposes, replacing the simple shared key methods which are uncomfortable if a Wi-Fi network reaches a specific size.
6+
7+
The protocol originally was designed by the well known terminal server manufacturer Livingston for use with their Portmaster series of terminal servers. Since then it has been implemented by hundreds other vendors and has a become an Internet Standard RFC.
8+
9+
The DIAMETER protocol is the designated successor, but RADIUS is still commonly used today.
10+
11+
== Protocol dependencies
12+
13+
UDP: RADIUS uses UDP as its underlying protocol. The registered UDP port for RADIUS traffic is 1812; the early deployment of RADIUS used UDP port 1645, which conflicted with the "datametrics" service. When RADIUS is used for accounting rather than authentication and configuration, the registered UDP port is 1813; the early deployment used port 1646, which conflicted with the "sa-msg-port" service.
14+
15+
== External links
16+
17+
* RFC 2865 Remote Authentication Dial In User Service (RADIUS)
18+
* RFC 2866 RADIUS Accounting
19+
* RFC 2867 RADIUS Accounting Modifications for Tunnel Protocol Support
20+
* RFC 2868 RADIUS Attributes for Tunnel Protocol Support
21+
* RFC 2869 RADIUS Extensions
22+
* RADIUS attributes and packet type codes
23+
24+
== See Also
25+
26+
* FreeRADIUS
27+
* RADIUS-Clients
28+
* Other RADIUS Servers

‎doc/antora/modules/concepts/pages/database.adoc‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
= Databases
2+
3+
== RADIUS Information
4+
5+
https://www.freeradius.org/[FreeRADIUS]
6+
https://www.inkbridgenetworks.com/[Inkbridge Networks]
7+
https://www.iana.org/assignments/radius-types/radius-types.xhtml[RADIUS Packet Types]
8+
9+
== RFCs
10+
11+
https://datatracker.ietf.org/doc/html/rfc2865[RFC 2865] Remote Authentication Dial In User Service (RADIUS)
12+
https://datatracker.ietf.org/doc/html/rfc2866[RFC 2866] RADIUS Accounting
13+
https://datatracker.ietf.org/doc/html/rfc2867[RFC 2867] RADIUS Accounting Modifications for Tunnel Protocol Support
14+
https://datatracker.ietf.org/doc/html/rfc2868[RFC 2868] RADIUS Attributes for Tunnel Protocol Support
15+
https://datatracker.ietf.org/doc/html/rfc2869[RFC 2869] RADIUS Extensions
16+
17+
https://datatracker.ietf.org/doc/html/rfc3758[RFC 3748] Extensible Authentication Protocol (EAP)
18+
https://datatracker.ietf.org/doc/html/rfc3579[RFC 3579] - RADIUS (Remote Authentication Dial In User Service) Support For Extensible Authentication Protocol (EAP)
19+
20+
21+

‎doc/antora/modules/concepts/pages/index.adoc‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,12 @@ FreeRADIUS server.
66
It is intended to provide more theoretical information about particular subjects
77
than would be appropriate to include inline in module configurations or as
88
sidebars in howto guides.
9+
10+
11+
* xref:concepts:index.adoc[Concepts] and introduction for newcomers
12+
* The xref:reference:raddb/index.adoc[configuration files] located in `/etc/raddb/`, or `/etc/freeradius/`
13+
* The syntax of the xref:reference:unlang/index.adoc[unlang] processing language
14+
* Various xref:howto:index.adoc[how-to] guides
15+
* xref:howto:installation/index.adoc[Installing] and xref:howto:installation/upgrade.adoc[upgrading] FreeRADIUS
16+
* xref:developers:index.adoc[Developer documentation]
17+

0 commit comments

Comments
 (0)