man/man5/rlm_detail.5

   1 .\"     # DS - begin display
   2 .de DS
   3 .RS
   4 .nf
   5 .sp
   6 ..
   7 .\"     # DE - end display
   8 .de DE
   9 .fi
  10 .RE
  11 .sp
  12 ..
  13 .TH rlm_detail 5 "5 February 2004" "" "FreeRADIUS Module"
  14 .SH NAME
  15 rlm_detail \- FreeRADIUS Module
  16 .SH DESCRIPTION
  17 The \fIrlm_detail\fP module writes radius packets to 'detail' files.
  18 It is primarily used for storing accounting information, but can be
  19 used in other sections to write packet details as well.
  20 .PP
  21 The file format is similar to that of the old Livingston servers, and
  22 many 'detail' file parsers should work with FreeRADIUS.
  23 .PP
  24 The main configuration items to be aware of are:
  25 .IP detailfile
  26 The file name in which to store the radius packet records.  NOTE: this
  27 variable is run through dynamic string expansion, and can include
  28 FreeRADIUS variables to create a dynamic filename.
  29 .PP
  30      %{radacctdir}/%{Client-IP-Address}/detail-%Y%m
  31 .PP
  32      This will create one file per month, for each client.
  33      This accomplishes 'file rotation' automatically from
  34      within the server.
  35 .PP
  36 .IP detailperm
  37 The file permissions of the detailfile.
  38 If omitted, the default is 0600.
  39 .IP dirperm
  40 The directory permissions of the directory where the detail files are
  41 created.  The default is 0755.
  42 .IP locking
  43 This option is set to 'yes' or 'no'.  By default it is 'no'.  Set this
  44 to yes to enable file locking, which is used with the 'radrelay'
  45 program.
  46 .SH CONFIGURATION
  47 .PP
  48 .DS
  49 modules {
  50   ...
  51 .br
  52   detail {
  53 .br
  54     detailfile = %A/%{Client-IP-Address}/detail-%Y%m
  55 .br
  56     detailperm = 0600
  57 .br
  58     dirperm = 0755
  59 .br
  60     locking = no
  61 .br
  62   }
  63 .br
  64   ...
  65 .br
  66 }
  67   ...
  68 .br
  69 accounting {
  70  ...
  71 .br
  72  detail
  73  ...
  74 .br
  75 }
  76 .DE
  77 .PP
  78 .SH SECTIONS
  79 .BR authorization,
  80 .BR accounting,
  81 .BR pre_proxy,
  82 .BR post_proxy,
  83 .BR post_authentication
  84 .PP
  85 .SH FILES
  86 .I /etc/raddb/radiusd.conf
  87 .PP
  88 .SH "SEE ALSO"
  89 .BR radiusd (8),
  90 .BR radiusd.conf (5)
  91 .SH AUTHORS
  92 Chris Parker, cparker@segv.org