man/man5/radiusd.conf.5

   1 .TH radiusd.conf 5 "12 Jun 2007" "" "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 RADIUS server.
   8 .SH "CONTENTS"
   9 There are a large number of configuration parameters for the server.
  10 Most are documented in the file itself as comments.  This page
  11 documents only the format of the file.  Please read the
  12 \fBradiusd.conf\fP file itself for more information.
  13
  14 The configuration file parser is independent of the server
  15 configuration.  This means that you can put almost anything into the
  16 configuration file.  So long as it is properly formatted, the server
  17 will start.
  18
  19 When the server parses the configuration file, it looks only for those
  20 configurations it understands.  Extra configuration items are ignored.
  21 This "feature" can be (ab)used in certain interesting ways.
  22 .SH "FILE FORMAT"
  23 The file format is line-based, like many other Unix configuration
  24 files.  Each entry in the file must be placed on a line by itself,
  25 although continuations are supported.
  26
  27 The file consists of configuration items (variable = value pairs),
  28 sections, and comments.
  29 .IP Variables
  30 Variables can be set via:
  31
  32 .DS
  33 .br
  34         name = value
  35 .DE
  36
  37 Single and double-quoted strings are permitted:
  38
  39 .DS
  40 .br
  41         string1 = "hello world"
  42 .br
  43         string2 = 'hello mom'
  44 .DE
  45 .IP Sections
  46 A section begins with a section name, followed on the same line by an
  47 open bracket '\fB{\fP'.  Section may contain other sections, comments, or
  48 variables.  Sections may be nested to any depth, limited
  49 only by available memory.  A section ends with a close bracket
  50 '\fB}\fP', on a line by itself.
  51
  52 .DS
  53 .br
  54         section {
  55 .br
  56                 ...
  57 .br
  58         }
  59 .DE
  60
  61 Sections can sometimes have a second name following the first one.
  62 The situations where this is legal depend on the context.  See the
  63 examples and comments in the \fBradiusd.conf\fP file for more
  64 information.
  65
  66 .DS
  67 .br
  68         section foo {
  69 .br
  70                 ...
  71 .br
  72         }
  73 .DE
  74 .IP Comments
  75 Any line beginning with a (\fB#\fP) is deemed to be a comment, and is
  76 ignored.  Comments can appear after a variable or section definitions.
  77
  78 .DS
  79 .br
  80         # comment
  81 .br
  82         foo = bar # set variable 'foo' to value 'bar'
  83 .br
  84         section {       # start of section
  85 .br
  86         ...
  87 .br
  88         }               # end of section
  89 .DE
  90 .IP Continuations
  91 Long lines can be broken up via continuations, using '\\' as the last
  92 character of the line.  For example, the following entry:
  93
  94 .DS
  95 .br
  96         foo = "blah \\
  97 .br
  98         blah \\
  99 .br
 100         blah"
 101 .DE
 102
 103 will set the value of the variable "foo" to "blah blah blah".  Any CR
 104 or LF is not turned into a space, but all other whitespace is
 105 preserved in the final value.
 106 .SH "REFERENCES"
 107 The value of a variable can reference another variable.  These
 108 references are evaluated when the configuration file is loaded, which
 109 means that there is no run-time cost associated with them.  This
 110 feature is most useful for turning long, repeated pieces of text into
 111 short ones.
 112
 113 Variables are referenced by ${variable_name}, as in the following examples.
 114
 115 .DS
 116         foo = bar       # set variable 'foo' to value 'bar'
 117 .br
 118         who = ${foo}    # sets variable 'who' to value of variable 'foo'
 119 .br
 120         my = "${foo} a" # sets variable 'my' to "bar a"
 121 .DE
 122
 123 If the variable exists in a section or subsection, it can be
 124 referenced as ${section.subsection.variable}.  Forward references are
 125 not allowed.  Relative references are allowed, by pre-pending the name
 126 with one or more period.
 127
 128 .DS
 129         blogs = ${.foo}
 130
 131 .DE
 132 Will set variable \fBblogs\fP to the value of variable \fBfoo\fP,
 133 from the current section.
 134
 135 .DS
 136         blogs = ${..foo}
 137
 138 .DE
 139 Will set variable \fBblogs\fP to the value of variable \fBfoo\fP, from the
 140 section which contains the current section.
 141
 142 .DS
 143         blogs = ${modules.detail.detailfile}
 144
 145 .DE
 146 Will set variable \fBblogs\fP to the value of variable \fBdetailfile\fP,
 147 of the \fBdetail\fP module, which is in the \fBmodules\fP section of
 148 the configuration file.
 149 .SH FILES
 150 /etc/raddb/radiusd.conf
 151 .SH "SEE ALSO"
 152 .BR radiusd (8)
 153 .SH AUTHOR
 154 Alan DeKok <aland@freeradius.org>