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 "27 June 2013" "" "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 file
  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 permissions
  37 The file permissions of the file.
  38 If omitted, the default is 0600.
  39 .IP locking
  40 This option is set to 'yes' or 'no'.  By default it is 'no'.  Set this
  41 to yes to enable file locking, which is used with the 'radrelay'
  42 program.
  43 .SH CONFIGURATION
  44 .PP
  45 .DS
  46 modules {
  47   ...
  48 .br
  49   detail {
  50 .br
  51     filename = %A/%{Client-IP-Address}/detail-%Y%m
  52 .br
  53     permissions = 0600
  54 .br
  55     dir_permissions = 0755
  56 .br
  57     locking = no
  58 .br
  59   }
  60 .br
  61   ...
  62 .br
  63 }
  64   ...
  65 .br
  66 accounting {
  67  ...
  68 .br
  69  detail
  70  ...
  71 .br
  72 }
  73 .DE
  74 .PP
  75 .SH SECTIONS
  76 .BR authorization,
  77 .BR accounting,
  78 .BR pre_proxy,
  79 .BR post_proxy,
  80 .BR post_authentication
  81 .PP
  82 .SH FILES
  83 .I /etc/raddb/radiusd.conf
  84 .PP
  85 .SH "SEE ALSO"
  86 .BR radiusd (8),
  87 .BR radiusd.conf (5)
  88 .SH AUTHORS
  89 Chris Parker, cparker@segv.org