raddb/modules/detail

   1 # -*- text -*-
   2 #
   3 #  $Id$
   4
   5 # Write a detailed log of all accounting records received.
   6 #
   7 detail {
   8         #  Note that we do NOT use NAS-IP-Address here, as
   9         #  that attribute MAY BE from the originating NAS, and
  10         #  NOT from the proxy which actually sent us the
  11         #  request.  The Client-IP-Address attribute is ALWAYS
  12         #  the address of the client which sent us the
  13         #  request.
  14         #
  15         #  The following line creates a new detail file for
  16         #  every radius client (by IP address or hostname).
  17         #  In addition, a new detail file is created every
  18         #  day, so that the detail file doesn't have to go
  19         #  through a 'log rotation'
  20         #
  21         #  If your detail files are large, you may also want
  22         #  to add a ':%H' (see doc/variables.txt) to the end
  23         #  of it, to create a new detail file every hour, e.g.:
  24         #
  25         #   ..../detail-%Y%m%d:%H
  26         #
  27         #  This will create a new detail file for every hour.
  28         #
  29         #  If you are reading detail files via the "listen" section
  30         #  (e.g. as in raddb/sites-available/robust-proxy-accounting),
  31         #  you MUST use a unique directory for each combination of a
  32         #  detail file writer, and reader.  That is, there can only
  33         #  be ONE "listen" section reading detail files from a
  34         #  particular directory.
  35         #
  36         detailfile = ${radacctdir}/%{Client-IP-Address}/detail-%Y%m%d
  37
  38         #
  39         #  The Unix-style permissions on the 'detail' file.
  40         #
  41         #  The detail file often contains secret or private
  42         #  information about users.  So by keeping the file
  43         #  permissions restrictive, we can prevent unwanted
  44         #  people from seeing that information.
  45         detailperm = 0600
  46
  47         #
  48         #  Every entry in the detail file has a header which
  49         #  is a timestamp.  By default, we use the ctime
  50         #  format (see "man ctime" for details).
  51         #
  52         #  The header can be customized by editing this
  53         #  string.  See "doc/variables.txt" for a description
  54         #  of what can be put here.
  55         #
  56         header = "%t"
  57
  58         #
  59         # Certain attributes such as User-Password may be
  60         # "sensitive", so they should not be printed in the
  61         # detail file.  This section lists the attributes
  62         # that should be suppressed.
  63         #
  64         # The attributes should be listed one to a line.
  65         #
  66         #suppress {
  67                 # User-Password
  68         #}
  69
  70 }