PageSourceSearch

https://www.freeradius.org/documentation/

html freeradius.org collected 2026-10-01 08:40:01 UTC 21,148 bytes, 431 lines download raw bytes

1<!DOCTYPE html>
2<html ng-app="freeradius"><head>
3    <!-- Google tag (gtag.js) -->
vendor: 68 bytes, lines 3-4
3
4    <script async src="https://www.googletagmanager.com/gtag/js?id=
4G-4N38WRR2V1
vendor: 16 bytes, lines 4-5
4"></script>
5    
5<script>
6      
vendor: 145 bytes, lines 6-9
6window.dataLayer = window.dataLayer || [];
7      function gtag(){dataLayer.push(arguments);}
8      gtag('js', new Date());
9      gtag('config', '
9G-4N38WRR2V1
vendor: 8 bytes, lines 9-10
9');
10    
10</script>
10
11    <meta charset="utf-8">
12    <meta http-equiv="X-UA-Compatible" content="IE=edge">
13    <meta name="viewport" content="width=device-width, initial-scale=1">
14
15    <title>Documentation</title>
16    <meta name="description" content="The world's leading RADIUS server. The project includes a GPL AAA server, BSD licensed client and PAM and Apache modules. Full support is available from InkBridge Networks.
17">
18
19    <link rel="stylesheet" href="/css/main.css">
20    <link rel="stylesheet" href="/css/swiper-bundle.min.css">
21    <link rel="canonical" href="https://freeradius.org/documentation/">
22    <link rel="alternate" type="application/rss+xml" title="FreeRADIUS" href="https://freeradius.org/feed.xml">
23
24    <link rel="apple-touch-icon" sizes="57x57" href="/apple-touch-icon-57x57.png">
25    <link rel="apple-touch-icon" sizes="60x60" href="/apple-touch-icon-60x60.png">
26    <link rel="apple-touch-icon" sizes="72x72" href="/apple-touch-icon-72x72.png">
27    <link rel="apple-touch-icon" sizes="76x76" href="/apple-touch-icon-76x76.png">
28    <link rel="apple-touch-icon" sizes="114x114" href="/apple-touch-icon-114x114.png">
29    <link rel="apple-touch-icon" sizes="120x120" href="/apple-touch-icon-120x120.png">
30    <link rel="apple-touch-icon" sizes="144x144" href="/apple-touch-icon-144x144.png">
31    <link rel="apple-touch-icon" sizes="152x152" href="/apple-touch-icon-152x152.png">
32    <link rel="apple-touch-icon" sizes="180x180" href="/apple-touch-icon-180x180.png">
33    <link rel="icon" type="image/png" href="/favicon-32x32.png" sizes="32x32">
34    <link rel="icon" type="image/png" href="/favicon-194x194.png" sizes="194x194">
35    <link rel="icon" type="image/png" href="/favicon-96x96.png" sizes="96x96">
36    <link rel="icon" type="image/png" href="/android-chrome-192x192.png" sizes="192x192">
37    <link rel="icon" type="image/png" href="/favicon-16x16.png" sizes="16x16">
38    <link rel="manifest" href="/manifest.json">
39    <link rel="mask-icon" href="/safari-pinned-tab.svg" color="#5bbad5 ">
40    <meta name="msapplication-TileColor" content="#da532c ">
41    <meta name="msapplication-TileImage" content="/mstile-144x144.png">
42    <meta name="theme-color" content="#ffffff ">
43
44</head>
45<body><header class="header">
46    <div class="sites-nav">
47      <span>OUR SITES</span>
48      <a href="https://inkbridgenetworks.com/">InkBridge Networks</a>
49      <a href="https://wiki.freeradius.org/">FreeRADIUS Wiki</a>
50    </div>
51  <nav class="navbar">
52    <div class="navbar-brand">
53      <a class="navbar-item" href="/"><img width="190" src="/img/wordmark.svg" alt=""></a>
54      <button class="navbar-burger" data-target="topbar-nav">
55        <svg viewBox="0 0 18 15">
56          <path fill="#424242" d="M18,1.484c0,0.82-0.665,1.484-1.484,1.484H1.484C0.665,2.969,0,2.304,0,1.484l0,0C0,0.665,0.665,0,1.484,0 h15.031C17.335,0,18,0.665,18,1.484L18,1.484z"></path>
57          <path fill="#424242" d="M18,7.516C18,8.335,17.335,9,16.516,9H1.484C0.665,9,0,8.335,0,7.516l0,0c0-0.82,0.665-1.484,1.484-1.484 h15.031C17.335,6.031,18,6.696,18,7.516L18,7.516z"></path>
58          <path fill="#424242" d="M18,13.516C18,14.335,17.335,15,16.516,15H1.484C0.665,15,0,14.335,0,13.516l0,0 c0-0.82,0.665-1.484,1.484-1.484h15.031C17.335,12.031,18,12.696,18,13.516L18,13.516z"></path>
59        </svg>
60      </button>
61    </div>
62    <div id="topbar-nav" class="navbar-menu">
63      <div class="navbar-mid">
64
65        <a class="navbar-item" href="/releases/">Releases</a>
66
67        <a class="navbar-item" href="/documentation/">Documentation</a>
68
69        <a class="navbar-item" href="/modules/">Modules</a>
70
71        <a class="navbar-item" href="/community/">Community</a>
72
73        <a class="navbar-item" href="/about/">About</a>
74
75        <a class="navbar-item" href="/support/">Support</a>
76
77      </div>
78      <div class="navbar-end">
79        <div class="navbar-item">
80          <span class="control">
81            <a ng-cloak ng-href="/releases/" stable-download class="button is-primary">Download {{stableBranch.last_release.name}}</a>
82          </span>
83        </div>
84      </div>
85    </div>
86  </nav>
87</header>
88<div class="page-content">
89
90        <article class="post">
91  <header class="post-header">
92    <div class="post-hero hero-documentation">
93      <div class="wrapper">
94        <h1 class="post-title">Documentation</h1>
95        <p class="post-subtitle">A FreeRADIUS resource portal</p>
96      </div>
97    </div>
98  </header><div class="sub-nav">
99    <div class="wrapper">
100        <nav class="inline_nav" sub-nav>
101            <ul>
102                <li class="active">
103                    <a class="subnav_link" href="#intro">Intro to docs</a>
104                </li><li class="">
105                    <a class="subnav_link" href="#getting_started">Getting started</a>
106                </li><li class="">
107                    <a class="subnav_link" href="#wiki">Community wiki</a>
108                </li><li class="">
109                    <a class="subnav_link" href="#more_resources">More Resources</a>
110                </li></ul>
111        </nav>
112    </div>
113</div>
114<div class="post-content">
115    <div class="wrapper base_padding_v" id="intro">
116	<h3 class="section-title">FreeRADIUS Documentation</h3>
117	<div class="row base_margin_b">
118		<div class="columns medium-8">
119			<p><a href="https://freeradius.org/documentation/freeradius-server/">Full documentation</a> is automatically built from the <a href="https://github.com/FreeRADIUS/freeradius-server/tree/v3.2.x/doc/">doc</a> directory which comes with the server.  Every configuration file contains detailed documentation on what the file does, and what can be configured.  The <a href="https://github.com/FreeRADIUS/freeradius-server/tree/v3.2.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>
120			<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>
121		</div>
122		<div class="quick-links columns medium-4 text_accent-blue">
123			<a href="https://github.com/FreeRADIUS/freeradius-server/blob/master/doc/antora/modules/developers/pages/bugs.adoc">
124				<div class="link block">
125					<img src="../img/debug.svg" alt="" class="icon">
126					<span class="h5 text-mid">Debugging the server</span><img class="arrow" src="../img/arrow-right.svg">
127				</div>
128			</a>
129			<a href="http://wiki.freeradius.org/guide/Getting%20Started">
130				<div class="link block">
131					<img src="../img/start.svg" alt="" class="icon">
132					<span class="h5 text-mid">Getting started</span><img class="arrow" src="../img/arrow-right.svg">
133				</div>
134			</a>
135			<a href="/commercial_support/">
136				<div class="link block">
137					<img src="../img/support.svg" alt="" class="icon">
138					<span class="h5 text-mid">Commercial Support</span><img class="arrow" src="../img/arrow-right.svg">
139				</div>
140			</a>
141	    </div>
142	</div>
143
144
145	<div class="alert-box row">
146		<img class="columns medium-1" src="../img/alert-blue.svg">
147		<div  class="columns medium-11">
148			<p><span class="emphasis text-dark">Many people try to find documentation by searching for things online.  This method is not generally productive.</span> It is easy to get lost in a mess of contradictory and confusing documentation, which leads to frustration and a badly configured server.</p>
149			<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>
150			<p><span class="emphasis text-dark">Do not use AI and expect to get configuration that works.</span> Results show time and time again that you will at best get something that does <em>not</em> work, and at worst is completely insecure. Learn how the server works and configure it using your own intelligence.</p>
151			<p><span class="emphasis text-dark">The server contains a substantial amount of documentation and examples. </span> We strongly suggest reading the configuration files before editing them.  We also suggest a slow and methodical approach to changing the configuration.  Making many changes at once will generally not work.</p>
152		</div>
153	</div>
154
155
156	<div class="base_padding_v" id="getting_started">
157		<h3 class="section-title">New to RADIUS? Start here.</h3>
158		<div class="row">
159			<div class="columns medium-6">
160				<div class="circle-number h5">1</div>
161
162				<h5>Quick Start guide</h5>
163
164				<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>
165
166				<a href="/doc/getting_started.html" class="headline-link">Visit GETTING STARTED</a>
167			</div>
168
169			<div class="columns medium-6">
170				<div class="circle-number h5">2</div>
171
172				<h5>FreeRADIUS Technical Guide (PDF)</h5>
173
174				<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>
175
176				<a href="https://networkradius.com/doc/FreeRADIUS%20Technical%20Guide.pdf" class="headline-link"> Download the FreeRADIUS Technical Guide (PDF)</a>
177			</div>
178		</div>
179	</div>
180</div>
181
182<div class="grey-block" id="wiki">
183	<div class="wrapper base_padding_v">
184		<h3 class="section-title">FreeRADIUS Wiki</h3>
185		<div class="row">
186			<div class="columns medium-8">
187				<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>
188
189				<h5>Contributing to the documentation</h5>
190				<p>You can help! Just edit the wiki. It takes less than five minutes, and it will help thousands of other people.</p>
191
192			</div>
193			<div class="quick-links columns medium-4 text_accent-blue">
194				<a href="http://wiki.freeradius.org/Home">
195					<div class="link block">
196						<img src="../img/wiki.svg" alt="" class="icon">
197						<span class="h5 text-mid">Visit Wiki</span><img class="arrow" src="../img/arrow-right.svg">
198					</div>
199				</a>
200			</div>
201		</div>
202	</div>
203</div>
204
205<div class="wrapper base_padding_v" id="more_resources">
206	<h3 class="section-title">Resources</h3>
207	<div class="row base_padding_v">
208
209
210
211		<div class="columns medium-6">
212			<div class="quick-links text_accent-blue">
213				<a href="https://freeradius.org/documentation/freeradius-server/">
214					<div class="link">
215						<span class="h5">Full server documentation </span><img class="arrow" src="../img/arrow-right.svg">
216					</div>
217				</a>
218			</div>
219
220			<p>Our documentation is a work in process and is as yet incomplete. However, we have extensive documentation on the following topics:</p>
221			<p>
222				<span class="emphasis text-mid">Links of interest:</span>
223				<ul>
224					<li><a href="https://www.freeradius.org/documentation/freeradius-server/current/installation/upgrade.html">Upgrading to 3.0</a></li>
225					<li><a href="https://freeradius.org/documentation/freeradius-server/current/unlang/keywords.html">Unlang keywords</a> <span class="italic">i.e., "if", "update", etc.</span></li>
226					<li><a href="https://freeradius.org/documentation/freeradius-server/current/unlang/condition/index.html">Conditional syntax</a> <span class="italic">i.e., how to use "if" statements in unlang</span></li>
227					<li><a href="https://freeradius.org/documentation/freeradius-server/current/unlang/xlat/index.html">String expansions</a> <span class="italic">i.e., "%{User-Name}"</span></li>
228					<li><a href="https://freeradius.org/documentation/freeradius-server/current/unlang/module.html">Modules</a> <span class="italic"></span></li>
229				</ul>
230			</p>
231			<a href="https://networkradius.com/doc.html" class="headline-link">Visit FREERADIUS RESOURCES from InkBridge Networks</a>
232		</div>
233
234
235
236		<div class="columns medium-6">
237			<div class="quick-links text_accent-blue">
238				<a href="https://www.inkbridgenetworks.com/blog">
239					<div class="link">
240						<span class="h5">InkBridge Networks articles</span><img class="arrow" src="../img/arrow-right.svg">
241					</div>
242				</a>
243			</div>
244
245			<p>InkBridge Networks (formerly Network RADIUS) regularly release articles and best practice guides.</p>
246			<p>
247				<span class="emphasis text-mid">Articles of interest:</span>
248				<ul>
249					<li><a href="https://networkradius.com/articles/2021/02/04/active-directory-with-FreeRADIUS.html">Can you use Active Directory with FreeRADIUS?</a></li>
250					<li><a href="https://networkradius.com/articles/2021/02/10/ISP-RADIUS-design.html">ISP RADIUS Design</a></li>
251					<li><a href="https://networkradius.com/articles/2020/12/10/design-blueprint-for-universities.html">RADIUS for Universities</a></li>
252					<li><a href="https://networkradius.com/articles/2021/05/20/DHCP-enhancements-in-FreeRADIUS-3.html">DHCP enhancements in FreeRADIUS&nbsp;3</a></li>
253					<li><a href="https://networkradius.com/articles/2021/06/09/8-most-common-RADIUS-mistakes.html">8 Most common RADIUS mistakes</a></li>
254				</ul>
255			</p>
256
257			<a href="https://inkbridgenetworks.com/" class="headline-link">Get support from InkBridge Networks</a>
258		</div>
259
260
261
262	</div>
263	<hr>
264	<div class="row base_padding_v">
265
266
267		<div class="columns medium-6">
268			<div class="quick-links text_accent-blue">
269				<a href="/radiusd/man/">
270					<div class="link">
271						<span class="h5">Online manual pages </span><img class="arrow" src="../img/arrow-right.svg">
272					</div>
273				</a>
274			</div>
275
276			<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>
277
278			<p>
279				<span class="emphasis text-mid">Links of interest:</span>
280				<ul>
281					<li><a href="/radiusd/man/index.html#programs">Programs documentation</a></li>
282					<li><a href="/radiusd/man/index.html#files">Configuration files documentation</a></li>
283					<li><a href="/radiusd/man/index.html#modules">Modules documentation</a></li>
284				</ul>
285			</p>
286			<a href="/radiusd/man/" class="headline-link">Visit ONLINE MANUAL PAGES</a>
287		</div>
288
289
290
291		<div class="columns medium-6">
292			<div class="quick-links text_accent-blue">
293				<a href="http://doc.freeradius.org/">
294					<div class="link">
295						<span class="h5">API Documentation </span><img class="arrow" src="../img/arrow-right.svg">
296					</div>
297				</a>
298			</div>
299
300			<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 
300notes describing hidden or advanced features that may be useful for users.</p>
301
302			<p class="italic">The API documentation site is not useful for people who want to configure FreeRADIUS.</p>
303
304			<a href="http://doc.freeradius.org/" class="headline-link">Visit DOXYGEN DOC SITE</a>
305		</div>
306
307
308
309	</div>
310	<hr>
311	<div class="row base_padding_v">
312
313
314
315		<div class="columns medium-6">
316			<div class="quick-links text_accent-blue">
317				<a href="http://deployingradius.com/">
318					<div class="link">
319						<span class="h5">deployingradius.com</span><img class="arrow" src="../img/arrow-right.svg">
320					</div>
321				</a>
322			</div>
323
324			<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>
325			<p>
326				<span class="emphasis text-mid">Links of interest:</span>
327				<ul>
328					<li><a href="http://deployingradius.com/documents/configuration/eap.html">Configuring EAP (TLS, PEAP, TTLS)</a></li>
329					<li><a href="http://deployingradius.com/documents/configuration/active_directory.html">Configure Active Directory for authentication</a></li>
330					<li><a href="http://deployingradius.com/documents/configuration/setup.html">Setting up the server</a></li>
331					<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>
332				</ul>
333			</p>
334
335			<a href="http://deployingradius.com/" class="headline-link">Visit DEPLOYINGRADIUS.COM</a>
336		</div>
337
338
339
340		<div class="columns medium-6 end">
341			<div class="quick-links text_accent-blue">
342				<a href="/rfc/">
343					<div class="link">
344						<span class="h5">RADIUS standards</span><img class="arrow" src="../img/arrow-right.svg">
345					</div>
346				</a>
347			</div>
348
349			<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>
350
351			<a href="/rfc/" class="headline-link">Visit LIST OF RFCs</a>
352		</div>
353
354
355
356	</div>
357</div>
358
359  </div>
360
361</article>
362
363
364    </div><footer class="global_footer bg_block-dark lg_padding_v">
365
366    <div class="wrapper">
367        <div class="row">
368            <div class="columns medium-4">
369                <div class="footer_main">
370                    <img class="footer_logo" width="150" src="/img/wordmark-white.svg" alt="">
371                    <a ng-cloak ng-href="/releases/" stable-download class="button bg_accent-green h5">Download {{stableBranch.last_release.name}}</a>
372                    <div class="footer-social">
373                        <a href="https://github.com/FreeRADIUS"><img class="icon_small" src="/img/github-white.svg" alt=""></a>
374                         <a href="https://twitter.com/freeradius"><img class="icon_small" src="/img/twitter-white.svg" alt=""></a>
375                        <a href="http://stackoverflow.com/tags/freeradius/info"><img class="icon_small" src="/img/stackoverflow-white.svg" alt=""></a>
376                    </div>
377                    <p>&copy; 2018-2025 The FreeRADIUS Server Project and Contributors</p>
378                </div>
379            </div>
380            <div class="columns medium-8">
381                <nav class="footer_nav h6 row small-up-2">
382                    <ul>
383                        <li><a href="/documentation/">Docs</a></li>
384                        <li><a href="http://wiki.freeradius.org/Home">Wiki</a></li>
385                        <li><a href="http://freeradius.org/radiusd/man/">Manual Pages</a></li>
386                        <li><a href="http://deployingradius.com/">Useful How-To's</a></li>
387                        <li><a href="http://networkradius.com/doc.html">Full Server Docs</a></li>
388                        <li><a href="http://doc.freeradius.org/">API Docs</a></li>
389                    </ul>
390                    <ul>
391                        <li><a href="/modules/">Modules</a></li>
392                        <li><a href="/modules/">Packages</a></li>
393                        <li><a href="https://github.com/FreeRADIUS/freeradius-server/issues/new">Report A Bug</a></li>
394                    </ul>
395                    <ul>
396                        <li><a href="/community/">Community</a></li>
397                        <li><a href="/support/">Mailing Lists</a></li>
398                        <li><a href="/community/#contributing">
398Contribute</a></li>
399                        <li><a href="/community/#developer_docs">Developer Docs</a></li>
400                    </ul>
401                    <ul>
402                        <li><a href="/about/">About</a></li>
403                        <li><a href="/about/#project">The Project</a></li>
404                        <li><a href="/about/#usage_statistics">Why We're No. 1</a></li>
405                        <li><a href="/about/#security">Security</a></li>
406                        <li><a href="/about/#team">Team</a></li>
407                    </ul>
408                    <ul>
409                        <li><a href="/support/">Support</a></li>
410                        <li><a href="https://github.com/FreeRADIUS/freeradius-server/issues/new">Issue Tracker</a></li>
411                        <li><a href="/security/">Security Issues</a></li>
412                        <li><a href="http://stackoverflow.com/questions/tagged/freeradius">FAQs</a></li>
413                        <li><a href="/support/">Newsletters</a></li>
414                        <li><a href="/commercial_support/">Commercial Support</a></li>
415                        <li><a href="/support/">Community Support</a></li>
416                    </ul>
417                </nav>
418            </div>
419        </div>
420    </div>
421
422</footer>
423<script src="/js/jquery-3.6.4.min.js"></script>
vendor: 1 bytes, line 423
423
424<script src="/js/angular.min.js"></script>
vendor: 1 bytes, line 424
424
425<script src="/js/app.js"></script>
vendor: 1 bytes, line 425
425
426<script src="/js/nav.js"></script>
vendor: 1 bytes, line 426
426
427<script src="/js/swiper-element-bundle.min.js"></script>
vendor: 1 bytes, line 427
427
428<script src="/js/swiper-nav.js"></script>
428
429</body>
430
431</html>

Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.