All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
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, exection 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_master Experimental Branch
29 
30 @code
31 git clone git@github.com:FreeRADIUS/freeradius-server.git
32 @endcode
33 - Web: http://github.com/FreeRADIUS/freeradius-server/tree/master
34 
35 @subsection branch_31x 3.1.x feature branch
36 
37 @note Submit pull requests for new features or modules against this branch.
38 
39 @code
40 git clone git@github.com:FreeRADIUS/freeradius-server.git
41 cd freeradius-server
42 git fetch origin v3.1.x:v3.1.x
43 git checkout v3.1.x
44 @endcode
45 - Web: http://github.com/FreeRADIUS/freeradius-server/tree/v3.1.x
46 
47 @subsection branch_30x 3.0.x stable branch
48 
49 @code
50 git clone git@github.com:FreeRADIUS/freeradius-server.git
51 cd freeradius-server
52 git fetch origin v3.0.x:v3.0.x
53 git checkout v3.0.x
54 @endcode
55 - Web: http://github.com/FreeRADIUS/freeradius-server/tree/v3.0.x
56 
57 @subsection branch_2xx 2.x.x EOL branch
58 
59 @note This branch is now permanently feature frozen. New features or modules
60  should be submitted against the v3.1.x branch.
61 
62 @code
63 git clone git@github.com:FreeRADIUS/freeradius-server.git
64 cd freeradius-server
65 git fetch origin v2.x.x:v2.x.x
66 git checkout v2.x.x
67 @endcode
68 - Web: http://github.com/FreeRADIUS/freeradius-server/tree/v2.x.x
69 
70 @subsection branch_1xx 1.1.x EOL branch
71 
72 @note This branch is now permanently feature frozen. New features or modules
73  should be submitted against the v3.1.x branch.
74 
75 @code
76 git clone git@github.com:FreeRADIUS/freeradius-server.git
77 cd freeradius-server
78 git fetch origin v2.x.x:v2.x.x
79 git checkout v2.x.x
80 @endcode
81 - Web: http://github.com/FreeRADIUS/freeradius-server/tree/v1.1.x
82 
83 @section main_website Website
84 
85 - http://www.freeradius.org
86 
87 @section mailinglist Mailing lists
88 
89 @subsection main_list FreeRADIUS-users
90 
91 This list is for users of the server
92 
93 @code
94 freeradius-users@lists.freeradius.org
95 @endcode
96 - Archives: http://lists.freeradius.org/pipermail/freeradius-users/
97 - List info: http://freeradius.org/list/users.html
98 
99 @subsection dev_list FreeRADIUS-devel
100 
101 This list is for development of the server, including patches, and
102 new features. PLEASE DO NOT post questions related to the operation
103 of the server here - use the "users" list. Most of the developers
104 read both, and will answer your questions there if they have the time.
105 
106 @code
107 freeradius-devel@lists.freeradius.org
108 @endcode
109 - Archives: http://lists.freeradius.org/pipermail/freeradius-devel/
110 - List info: http://freeradius.org/list/devel.html
111 
112 */