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

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