git.sur5r.net Git - openldap/blob - doc/man/man5/slapo-auditlog.5

   1 .TH SLAPO-AUDITLOG 5 "RELEASEDATE" "OpenLDAP LDVERSION"
   2 .\" Copyright 2005-2007 The OpenLDAP Foundation All Rights Reserved.
   3 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
   4 .\" $OpenLDAP$
   5 .SH NAME
   6 slapo-auditlog \- Audit Logging overlay to slapd
   7 .SH SYNOPSIS
   8 ETCDIR/slapd.conf
   9 .TP
  10 ETCDIR/slapd.d
  11 .SH DESCRIPTION
  12 The Audit Logging overlay can be used to record all changes on a given
  13 backend database to a specified log file. Changes are logged as standard
  14 LDIF, with an additional comment header giving the timestamp of the change
  15 and the identity of the user making the change.
  16 .LP
  17 For Add and Modify operations the identity comes from the modifiersName
  18 associated with the operation. This is usually the same as the requestor's
  19 identity, but may be set by other overlays to reflect other values.
  20 .SH CONFIGURATION
  21 This
  22 .B slapd.conf
  23 option applies to the Audit Logging overlay.
  24 It should appear after the
  25 .B overlay
  26 directive.
  27 .TP
  28 .B auditlog <filename>
  29 Specify the fully qualified path for the log file.
  30 .TP
  31 .B olcAuditlogFile <filename>
  32 For use with
  33 .B cn=config
  34 .SH EXAMPLE
  35 The following LDIF could be used to add this overlay to
  36 .B cn=config
  37 (adjust to suit)
  38 .LP
  39 .RS
  40 .nf
  41 dn: cn=module{0},cn=config
  42 changetype: modify
  43 add: olcModuleLoad
  44 olcModuleLoad: {2}auditlog.la
  45
  46 dn: olcOverlay=auditlog,olcDatabase={1}hdb,cn=config
  47 changetype: add
  48 objectClass: olcOverlayConfig
  49 objectClass: olcAuditLogConfig
  50 olcOverlay: auditlog
  51 olcAuditlogFile: /tmp/auditlog.ldif
  52 .fi
  53 .RE
  54 .LP
  55 .LP
  56 .SH FILES
  57 .TP
  58 ETCDIR/slapd.conf
  59 default slapd configuration file
  60 .TP
  61 ETCDIR/slapd.d
  62 default slapd configuration directory
  63 .SH SEE ALSO
  64 .BR slapd.conf (5),
  65 .BR slapd-config(5).