git.sur5r.net Git - openldap/blob - doc/man/man5/slapd.overlays.5

   1 .TH SLAPD.OVERLAYS 5 "RELEASEDATE" "OpenLDAP LDVERSION"
   2 .\" Copyright 2006-2007 The OpenLDAP Foundation All Rights Reserved.
   3 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
   4 .\" $OpenLDAP$
   5 .SH NAME
   6 slapd.overlays \- overlays for slapd, the stand-alone LDAP daemon
   7 .SH DESCRIPTION
   8 The
   9 .BR slapd (8)
  10 daemon can use a variety of different overlays to alter or extend
  11 the normal behavior of a database backend.
  12 Overlays may be compiled statically into slapd, or when module support
  13 is enabled, they may be dynamically loaded. Most of the overlays
  14 are only allowed to be configured on individual databases, but some
  15 may also be configured globally.
  16
  17 Configuration options for each overlay are documented separately in the
  18 corresponding
  19 .BR slapo-<overlay> (5)
  20 manual pages.
  21 .TP
  22 .B accesslog
  23 Access Logging.
  24 This overlay can record accesses to a given backend database on another
  25 database.
  26 .TP
  27 .B auditlog
  28 Audit Logging.
  29 This overlay records changes on a given backend database to an LDIF log
  30 file.
  31 By default it is not built.
  32 .TP
  33 .B chain
  34 Chaining.
  35 This overlay allows automatic referral chasing when a referral would
  36 have been returned, either when configured by the server or when
  37 requested by the client.
  38 .TP
  39 .B dyngroup
  40 Dynamic Group.
  41 This is a demo overlay which extends the Compare operation to detect
  42 members of a dynamic group.
  43 It has no effect on any other operations.
  44 .TP
  45 .B dynlist
  46 Dynamic List.
  47 This overlay allows expansion of dynamic groups and more.
  48 .TP
  49 .B pcache
  50 Proxycache.
  51 This overlay allows caching of LDAP search requests in a local database.
  52 It is most often used with the
  53 .BR slapd-ldap (5)
  54 or
  55 .BR slapd-meta (5)
  56 backends.
  57 .TP
  58 .B ppolicy
  59 Password Policy.
  60 This overlay provides a variety of password control mechanisms,
  61 e.g. password aging, password reuse and duplication control, mandatory
  62 password resets, etc.
  63 .TP
  64 .B refint
  65 Referential Integrity.
  66 This overlay can be used with a backend database such as
  67 .BR slapd-bdb (5)
  68 to maintain the cohesiveness of a schema which utilizes reference
  69 attributes.
  70 .TP
  71 .B retcode
  72 Return Code.
  73 This overlay is useful to test the behavior of clients when
  74 server-generated erroneous and/or unusual responses occur.
  75 .TP
  76 .B rwm
  77 Rewrite/remap.
  78 This overlay is experimental.
  79 It performs basic DN/data rewrite and
  80 objectClass/attributeType mapping.
  81 .TP
  82 .B syncprov
  83 Syncrepl Provider.
  84 This overlay implements the provider-side support for
  85 .B syncrepl
  86 replication, including persistent search functionality.
  87 .TP
  88 .B translucent
  89 Translucent Proxy.
  90 This overlay can be used with a backend database such as
  91 .BR slapd-bdb (5)
  92 to create a "translucent proxy".
  93 Content of entries retrieved from a remote LDAP server can be partially
  94 overridden by the database.
  95 .TP
  96 .B unique
  97 Attribute Uniqueness.
  98 This overlay can be used with a backend database such as
  99 .BR slapd-bdb (5)
 100 to enforce the uniqueness of some or all attributes within a subtree.
 101 .SH FILES
 102 .TP
 103 ETCDIR/slapd.conf
 104 default slapd configuration file
 105 .TP
 106 ETCDIR/slapd.d
 107 default slapd configuration directory
 108 .SH SEE ALSO
 109 .BR ldap (3),
 110 .BR slapo\-accesslog (5),
 111 .BR slapo\-auditlog (5),
 112 .BR slapo\-chain (5),
 113 .BR slapo\-dynlist (5),
 114 .BR slapo\-pcache (5),
 115 .BR slapo\-ppolicy (5),
 116 .BR slapo\-refint (5),
 117 .BR slapo\-retcode (5),
 118 .BR slapo\-rwm (5),
 119 .BR slapo\-syncprov (5),
 120 .BR slapo\-translucent (5),
 121 .BR slapo\-unique (5).
 122 .BR slapd\-config (5),
 123 .BR slapd.conf (5),
 124 .BR slapd.backends (5),
 125 .BR slapd (8).
 126 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
 127 .SH ACKNOWLEDGEMENTS
 128 .B OpenLDAP
 129 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
 130 .B OpenLDAP
 131 is derived from University of Michigan LDAP 3.3 Release.