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

   1 .TH SLAPD.OVERLAYS 5 "RELEASEDATE" "OpenLDAP LDVERSION"
   2 .\" Copyright 2006-2011 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 constraint
  40 Constraint.
  41 This overlay enforces a regular expression constraint on all values
  42 of specified attributes. It is used to enforce a more rigorous
  43 syntax when the underlying attribute syntax is too general.
  44 .TP
  45 .B dds
  46 Dynamic Directory Services.
  47 This overlay supports dynamic objects, which have a limited life after
  48 which they expire and are automatically deleted.
  49 .TP
  50 .B dyngroup
  51 Dynamic Group.
  52 This is a demo overlay which extends the Compare operation to detect
  53 members of a dynamic group.
  54 It has no effect on any other operations.
  55 .TP
  56 .B dynlist
  57 Dynamic List.
  58 This overlay allows expansion of dynamic groups and more.
  59 .TP
  60 .B pcache
  61 Proxycache.
  62 This overlay allows caching of LDAP search requests in a local database.
  63 It is most often used with the
  64 .BR slapd\-ldap (5)
  65 or
  66 .BR slapd\-meta (5)
  67 backends.
  68 .TP
  69 .B ppolicy
  70 Password Policy.
  71 This overlay provides a variety of password control mechanisms,
  72 e.g. password aging, password reuse and duplication control, mandatory
  73 password resets, etc.
  74 .TP
  75 .B refint
  76 Referential Integrity.
  77 This overlay can be used with a backend database such as
  78 .BR slapd\-bdb (5)
  79 to maintain the cohesiveness of a schema which utilizes reference
  80 attributes.
  81 .TP
  82 .B retcode
  83 Return Code.
  84 This overlay is useful to test the behavior of clients when
  85 server-generated erroneous and/or unusual responses occur.
  86 .TP
  87 .B rwm
  88 Rewrite/remap.
  89 This overlay is experimental.
  90 It performs basic DN/data rewrite and
  91 objectClass/attributeType mapping.
  92 .TP
  93 .B syncprov
  94 Syncrepl Provider.
  95 This overlay implements the provider-side support for
  96 .B syncrepl
  97 replication, including persistent search functionality.
  98 .TP
  99 .B translucent
 100 Translucent Proxy.
 101 This overlay can be used with a backend database such as
 102 .BR slapd\-bdb (5)
 103 to create a "translucent proxy".
 104 Content of entries retrieved from a remote LDAP server can be partially
 105 overridden by the database.
 106 .TP
 107 .B unique
 108 Attribute Uniqueness.
 109 This overlay can be used with a backend database such as
 110 .BR slapd\-bdb (5)
 111 to enforce the uniqueness of some or all attributes within a subtree.
 112 .TP
 113 .B valsort
 114 Value Sorting.
 115 This overlay can be used to enforce a specific order for the values
 116 of an attribute when it is returned in a search.
 117 .SH FILES
 118 .TP
 119 ETCDIR/slapd.conf
 120 default slapd configuration file
 121 .TP
 122 ETCDIR/slapd.d
 123 default slapd configuration directory
 124 .SH SEE ALSO
 125 .BR ldap (3),
 126 .BR slapo\-accesslog (5),
 127 .BR slapo\-auditlog (5),
 128 .BR slapo\-chain (5),
 129 .BR slapo\-constraint (5),
 130 .BR slapo\-dds (5),
 131 .BR slapo\-dyngroup (5),
 132 .BR slapo\-dynlist (5),
 133 .BR slapo\-pcache (5),
 134 .BR slapo\-ppolicy (5),
 135 .BR slapo\-refint (5),
 136 .BR slapo\-retcode (5),
 137 .BR slapo\-rwm (5),
 138 .BR slapo\-syncprov (5),
 139 .BR slapo\-translucent (5),
 140 .BR slapo\-unique (5).
 141 .BR slapo\-valsort (5).
 142 .BR slapd\-config (5),
 143 .BR slapd.conf (5),
 144 .BR slapd.backends (5),
 145 .BR slapd (8).
 146 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
 147 .SH ACKNOWLEDGEMENTS
 148 .so ../Project