The FreeRADIUS server  $Id: 15bac2a4c627c01d1aa2047687b3418955ac7f00 $
toc.c
Go to the documentation of this file.
1 /**
2  * @cond skip
3  * vim:syntax=doxygen
4  * @endcond
5  *
6  *
7 @mainpage
8 
9 @section main_intro Introduction
10 
11 FreeRADIUS is a high-performance modular RADIUS server, supporting PAP, CHAP,
12 EAP (including EAP-TLS, EAP-TTLS, EAP-PEAP with EAP-MSCHAP) and a very flexible
13 configuration model, including conditional request processing, querying of
14 LDAP and SQL databases, execution of external scripts and more.
15 
16 FreeRADIUS uses a thread pool to serve requests. Each request is processed
17 synchronously, and processing passes through a series of stages, and a list
18 of modules in each stage.
19 
20 @section main_toc Table of Contents
21 
22 - @subpage server_doc "1. Core server APIs"
23 - @subpage module_doc "2. Server modules"
24 - @subpage client_doc "3. Client APIs"
25 
26 @section main_branches GIT Branch
27 
28 @subsection branch_40x 4.0.x feature branch
29 
30 @note Submit pull requests for new features or modules against this branch.
31 
32 @code
33 git clone git@github.com:FreeRADIUS/freeradius-server.git
34 cd freeradius-server
35 git fetch origin v4.0.x:v4.0.x
36 git checkout v4.0.x
37 @endcode
38 - Web: https://github.com/FreeRADIUS/freeradius-server/tree/v4.0.x
39 
40 @subsection branch_32x 3.2.x stable + feature branch
41 
42 @code
43 git clone git@github.com:FreeRADIUS/freeradius-server.git
44 cd freeradius-server
45 git fetch origin v3.2.x:v3.2.x
46 git checkout v3.2.x
47 @endcode
48 - Web: https://github.com/FreeRADIUS/freeradius-server/tree/v3.2.x
49 
50 @subsection branch_30x 3.0.x stable branch
51 
52 @note This branch is now permanently feature frozen. Only security
53  fixes will be applied to it. New features or modules should be
54  submitted against the v3.2.x branch, or the v4.0.x branch.
55 @code
56 git clone git@github.com:FreeRADIUS/freeradius-server.git
57 cd freeradius-server
58 git fetch origin v3.0.x:v3.0.x
59 git checkout v3.0.x
60 @endcode
61 - Web: https://github.com/FreeRADIUS/freeradius-server/tree/v3.0.x
62 
63 @subsection branch_2xx 2.x.x EOL branch
64 
65 @note This branch is now permanently end of life. No bug fixes or
66  security fixes will be performed for this branch.
67 
68 @code
69 git clone git@github.com:FreeRADIUS/freeradius-server.git
70 cd freeradius-server
71 git fetch origin v2.x.x:v2.x.x
72 git checkout v2.x.x
73 @endcode
74 - Web: https://github.com/FreeRADIUS/freeradius-server/tree/v2.x.x
75 
76 @subsection branch_1xx 1.1.x EOL branch
77 
78 @note This branch is now permanently end of life. No bug fixes or
79  security fixes will be performed for this branch.
80 
81 @code
82 git clone git@github.com:FreeRADIUS/freeradius-server.git
83 cd freeradius-server
84 git fetch origin v2.x.x:v2.x.x
85 git checkout v2.x.x
86 @endcode
87 - Web: https://github.com/FreeRADIUS/freeradius-server/tree/v1.1.x
88 
89 @section main_website Website
90 
91 - https://freeradius.org
92 
93 @section mailinglist Mailing lists
94 
95 @subsection main_list FreeRADIUS-users
96 
97 This list is for users of the server
98 
99 @code
100 freeradius-users@lists.freeradius.org
101 @endcode
102 - Archives: https://lists.freeradius.org/pipermail/freeradius-users/
103 - List info: https://freeradius.org/support/
104 
105 @subsection dev_list FreeRADIUS-devel
106 
107 This list is for development of the server, including patches, and
108 new features. PLEASE DO NOT post questions related to the operation
109 of the server here - use the "users" list. Most of the developers
110 read both, and will answer your questions there if they have the time.
111 
112 @code
113 freeradius-devel@lists.freeradius.org
114 @endcode
115 - Archives: https://lists.freeradius.org/pipermail/freeradius-devel/
116 - List info: https://freeradius.org/support/
117 
118 */