man/man5/rlm_detail.5

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