forked from FreeRADIUS/www.freeradius.org
-
Notifications
You must be signed in to change notification settings - Fork 0
/
documentation.html
225 lines (187 loc) · 10.7 KB
/
documentation.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
---
layout: page
title: Documentation
subtitle: A FreeRADIUS resource portal
permalink: /documentation/
navorder: 200
hero: documentation
subnav:
- text: Intro to docs
link: '#intro'
- text: Getting started
link: '#getting_started'
- text: Community wiki
link: '#wiki'
- text: More Resources
link: '#more_resources'
---
<div class="wrapper base_padding_v" id="intro">
<h3 class="section-title">FreeRADIUS Documentation</h3>
<div class="row base_margin_b">
<div class="columns medium-8">
<p>Configuring the server can be a complex task. This task is made easier in recent versions, as we gradually improve the documentation and "default" configurations.</p>
<p>The server comes with documentation. The <a href="https://github.com/FreeRADIUS/freeradius-server/tree/v3.0.x/doc/">doc</a> directory contains a number of files, named for their functionality. The configuration files themselves contain enormous amounts of documentation and the <a href="https://github.com/FreeRADIUS/freeradius-server/tree/v3.0.x/raddb/sites-available/">raddb/sites-available</a> directory contains many example "virtual servers". Each example has comments describing what it does, when it should be used, and how to configure it.</p>
<p>If you are using version 1 or 2 of the server, we suggest upgrading to version 3. Versions 1 and 2 are both end-of-life and no longer supported.</p>
</div>
<div class="quick-links columns medium-4 text_accent-blue">
<a href="https://github.com/FreeRADIUS/freeradius-server/blob/v4.0.x/doc/bugs.md">
<div class="link block">
<img src="../img/debug.svg" alt="" class="icon">
<span class="h5 text-mid">Debugging the server</span><img class="arrow" src="../img/arrow-right.svg">
</div>
</a>
<a href="http://wiki.freeradius.org/guide/Getting%20Started">
<div class="link block">
<img src="../img/start.svg" alt="" class="icon">
<span class="h5 text-mid">Getting started</span><img class="arrow" src="../img/arrow-right.svg">
</div>
</a>
<a href="/commercial_support/">
<div class="link block">
<img src="../img/support.svg" alt="" class="icon">
<span class="h5 text-mid">Commercial Support</span><img class="arrow" src="../img/arrow-right.svg">
</div>
</a>
</div>
</div>
<div class="alert-box row">
<img class="columns medium-1" src="../img/alert-blue.svg">
<div class="columns medium-11">
<p><span class="emphasis text-dark">Many people try to find documentation by Googling keywords, but this method is not generally productive.</span> Most of the links are to other people asking the same question, or to out-dated third party documentation. It is easy to get lost in a mess of contradictory and confusing documentation, leading to frustration and a badly configured server.</p>
<p><span class="emphasis text-dark">Most third-party documentation and How-To's are wrong and outdated.</span> We strongly suggest that you do not follow any documentation which is more than 4 years old. If you do follow such ancient documentation, the result will likely be a server that does not work.</p>
</div>
</div>
<div class="base_padding_v" id="getting_started">
<h3 class="section-title">New to RADIUS? Start here.</h3>
<div class="row">
<div class="columns medium-6">
<div class="circle-number h5">1</div>
<h5>Quick Start guide</h5>
<p>New users of the server should read <a href="/doc/getting_started.html">Getting Started</a>. It describes how to set up a test user and how to add a new client. These are the two basic steps that start all new installations.</p>
<a href="/doc/getting_started.html" class="headline-link">Visit GETTING STARTED</a>
</div>
<div class="columns medium-6">
<div class="circle-number h5">2</div>
<h5>FreeRADIUS Technical Guide (PDF)</h5>
<p>This comprehensive guide covers RADIUS concepts, how RADIUS works, and how to install FreeRADIUS. It also describes configuration files distributed with the server and what they are used for.</p>
<a href="http://networkradius.com/doc/FreeRADIUS%20Technical%20Guide.pdf" class="headline-link"> Download the FreeRADIUS Technical Guide (PDF)</a>
</div>
</div>
</div>
</div>
<div class="grey-block" id="wiki">
<div class="wrapper base_padding_v">
<h3 class="section-title">FreeRADIUS Wiki</h3>
<div class="row">
<div class="columns medium-8">
<p>The Wiki has a fair amount of documentation and How-To's. It is a good starting resource. The Wiki is searchable: type in a few keywords, and you will get pages of documentation that often answer your questions and can help you solve problems.</p>
<h5>Contributing to the documentation</h5>
<p>You can help! Just edit the wiki. It takes less than five minutes, and it will help thousands of other people.</p>
</div>
<div class="quick-links columns medium-4 text_accent-blue">
<a href="http://wiki.freeradius.org/Home">
<div class="link block">
<img src="../img/wiki.svg" alt="" class="icon">
<span class="h5 text-mid">Visit Wiki</span><img class="arrow" src="../img/arrow-right.svg">
</div>
</a>
</div>
</div>
</div>
</div>
<div class="wrapper base_padding_v" id="more_resources">
<h3 class="section-title">Resources</h3>
<div class="row base_padding_v">
<div class="columns medium-6">
<div class="quick-links text_accent-blue">
<a href="/radiusd/man/">
<div class="link">
<span class="h5">Online manual pages </span><img class="arrow" src="../img/arrow-right.svg">
</div>
</a>
</div>
<p>All of the "man" pages are available on any system running FreeRADIUS. We suggest typing typing man radiusd, and reading the resulting text. These manual pages contain instructions for configuring and debugging the server.</p>
<p>
<span class="emphasis text-mid">Links of interest:</span>
<ul>
<li><a href="/radiusd/man/index.html#programs">Programs documentation</a></li>
<li><a href="/radiusd/man/index.html#files">Configuration files documentation</a></li>
<li><a href="/radiusd/man/index.html#modules">Modules documentation</a></li>
</ul>
</p>
<a href="/radiusd/man/" class="headline-link">Visit ONLINE MANUAL PAGES</a>
</div>
<div class="columns medium-6">
<div class="quick-links text_accent-blue">
<a href="http://deployingradius.com/">
<div class="link">
<span class="h5">deployingradius.com </span><img class="arrow" src="../img/arrow-right.svg">
</div>
</a>
</div>
<p>This web site has a number of useful how-to documents that are kept up to date with newer versions of the server.</p>
<p>
<span class="emphasis text-mid">Links of interest:</span>
<ul>
<li><a href="http://deployingradius.com/documents/configuration/eap.html">Configuring EAP (TLS, PEAP, TTLS)</a></li>
<li><a href="http://deployingradius.com/documents/configuration/active_directory.html">Configure Active Directory for authentication</a></li>
<li><a href="http://deployingradius.com/documents/configuration/setup.html">Setting up the server</a></li>
<li><a href="http://deployingradius.com/documents/protocols/compatibility.html">Authentication Protocols Table</a> <span class="italic">compatiblity with back-end databases and password storage methods</span></li>
</ul>
</p>
<a href="http://deployingradius.com/" class="headline-link">Visit DEPLOYINGRADIUS.COM</a>
</div>
</div>
<hr>
<div class="row base_padding_v">
<div class="columns medium-6">
<div class="quick-links text_accent-blue">
<a href="http://networkradius.com/doc.html">
<div class="link">
<span class="h5">Full server documentation </span><img class="arrow" src="../img/arrow-right.svg">
</div>
</a>
</div>
<p>Our documentation is a work in process and is as yet incomplete. However, we have extensive documentation on the following topics:</p>
<p>
<span class="emphasis text-mid">Links of interest:</span>
<ul>
<li><a href="http://networkradius.com/doc/current/upgrading/">Upgrading to 3.0</a></li>
<li><a href="http://networkradius.com/doc/current/unlang/keywords.html">Unlang keywords</a> <span class="italic">i.e., "if", "update", etc.</span></li>
<li><a href="http://networkradius.com/doc/current/unlang/condition.html">Conditional syntax</a> <span class="italic">i.e., how to use "if" statements in unlang</span></li>
<li><a href="http://networkradius.com/doc/current/raddb/mods-available/expansions.html">String expansions</a> <span class="italic">i.e., "%{User-Name}"</span></li>
<li><a href="http://networkradius.com/doc/current/raddb/mods-available/">Modules</a> <span class="italic">About ¾ of the modules are documented</span></li>
</ul>
</p>
<a href="http://networkradius.com/doc.html" class="headline-link">Visit NetworkRADIUS FULL SERVER DOCS</a>
</div>
<div class="columns medium-6">
<div class="quick-links text_accent-blue">
<a href="http://doc.freeradius.org/">
<div class="link">
<span class="h5">API Documentation </span><img class="arrow" src="../img/arrow-right.svg">
</div>
</a>
</div>
<p>The doc site holds a rendered copy of the doxygen annotations added to the FreeRADIUS code base. Doxygen content is primarily useful for developers, but it contains notes describing hidden or advanced features that may be useful for users.</p>
<p class="italic">The API documentation site is not useful for people who want to configure FreeRADIUS.</p>
<a href="http://doc.freeradius.org/" class="headline-link">Visit DOXYGEN DOC SITE</a>
</div>
</div>
<hr>
<div class="row base_padding_v">
<div class="columns medium-6">
<h5>Novell eDirectory Integration</h5>
<p>An administration guide to FreeRADIUS and Novell eDirectory is available.</p>
<a href="/doc/radiusadmin.pdf" class="headline-link">Download ADMINSTRATION GUIDE PDF</a>
<br><br>
<p>For the latest version of the "Integrating Novell eDirectory with FreeRADIUS" administration guide, refer to Novell's site.</p>
<a href="https://www.netiq.com/documentation/edir_radius/" class="headline-link">Visit NETIQ.COM</a>
</div>
<div class="columns medium-6 end">
<h5>RADIUS Standards</h5>
<p>Many Request for Comments (RFC) documents have been written over the years that build up the de-facto standards used in implementing RADIUS solutions. They are listed here for convenience.</p>
<a href="/rfc/" class="headline-link">Visit LIST OF RFCs</a>
</div>
</div>
</div>