Pull fix for bug #436 from branch_1_1
[freeradius.git] / man / man5 / radiusd.conf.5
1 .TH radiusd.conf 5 "23 Jan 2004" "" "FreeRADIUS configuration file"
2 .SH NAME
3 radiusd.conf \- configuration file for the FreeRADIUS server
4 .SH DESCRIPTION
5 The \fBradiusd.conf\fP file resides in the radius database directory,
6 by default \fB/etc/raddb\fP.  It defines the global configuration for
7 the FreeRADIUS server.
8
9 .SH "FILE FORMAT"
10 The file consists of attribute-value pairs, sections, and comments.
11
12 Attribute-value pairs are of the form \fBname = value\fP.
13
14 A section begins with a section name, followed on the same line by an
15 open bracket \fB{\fP.  The section may contain other
16 sections, or attribute-value pairs.  The section ends with a close
17 bracket \fB}\fP, on a line by itself.
18
19 Any line beginning with a (\fB#\fP) is deemed to be a comment, and is
20 ignored.  Lines containing only whitespace are also ignored.
21
22 The file is line-based.  That is, each newline-terminated line
23 represents either a comment, a section name, or an attribute-value
24 pair.  It is not possible to specify multiple items on the same line,
25 and there are no continuation lines.
26
27 The value for a particular attribute may reference a previously
28 defined attribute by name. The standard shell reference format
29 \fB${name}\fP is used.  When the variable is in a section or
30 subsection, it may be referenced as \fB${section.subsection.name}\fP.
31 Forward references are not allowed.  Relative references are allowed,
32 via pre-pending the name with one or more of '.'.
33
34 The individidual configuration directives are too numerous to list
35 here, so this manual page only documents the file format.  Please read
36 the sample configuration file distributed with the server for comments
37 describing each of the allowed configuration directives.
38
39 .SH EXAMPLES
40 .PP
41 .DS
42         foo = bar
43
44 .DE
45 Sets variable \fBfoo\fP to have text value \fBbar\fP.
46
47 .DS
48         blogs = ${foo}
49
50 .DE
51 Sets variable \fBblogs\fP to the value of variable \fBfoo\fP from the
52 current section.  If there is no variable \fBfoo\fP in the current
53 section, then it looks for that variable in the body of the main
54 configuration file, e.g. \f${Blogdir}\fP
55
56 .DS
57         my_section {
58 .br
59                 baz = bud
60 .br
61         }
62
63 .DE
64 Defines a section named \fBmy_section\fP, containing variable
65 \fBbaz\fP.
66
67 .DS
68         blogs = ${.foo}
69
70 .DE
71 Sets variable \fBblogs\fP to the value of variable \fBfoo\fP,
72 from the current section.
73
74 .DS
75         blogs = ${..foo}
76
77 .DE
78 Sets variable \fBblogs\fP to the value of variable \fBfoo\fP, from the
79 section which contains the current section.
80
81 .DS
82         blogs = ${modules.detail.detailfile}
83
84 .DE
85 Sets variable \fBblogs\fP to the value of variable \fBdetailfile\fP,
86 of the \fBdetail\fP module, which is in the \fBmodules\fP section of
87 the configuration file.
88
89 .PP
90 .SH FILES
91 /etc/raddb/radiusd.conf
92 .SH "SEE ALSO"
93 .BR radiusd (8),
94 .BR users (5)
95 .BR clients (5)
96
97 .SH AUTHOR
98 Alan DeKok <aland@ox.org>