1 .TH SLAPD.CONF 5 "RELEASEDATE" "OpenLDAP LDVERSION"
2 .\" Copyright 1998-2011 The OpenLDAP Foundation All Rights Reserved.
3 .\" Copying restrictions apply. See COPYRIGHT/LICENSE.
6 slapd.conf \- configuration file for slapd, the stand-alone LDAP daemon
12 contains configuration information for the
14 daemon. This configuration file is also used by the SLAPD tools
26 file consists of a series of global configuration options that apply to
28 as a whole (including all backends), followed by zero or more database
29 backend definitions that contain information specific to a backend
31 The configuration options are case-insensitive;
32 their value, on a case by case basis, may be case-sensitive.
39 # comment - these options apply to every database
40 <global configuration options>
41 # first database definition & configuration options
42 database <backend 1 type>
43 <configuration options specific to backend 1>
44 # subsequent database definitions & configuration options
48 As many backend-specific sections as desired may be included. Global
49 options can be overridden in a backend (for options that appear more
50 than once, the last appearance in the
54 If a line begins with white space, it is considered a continuation
55 of the previous line. No physical line should be over 2000 bytes
58 Blank lines and comment lines beginning with
59 a `#' character are ignored. Note: continuation lines are unwrapped
60 before comment processing is applied.
62 Arguments on configuration lines are separated by white space. If an
63 argument contains white space, the argument should be enclosed in
64 double quotes. If an argument contains a double quote (`"') or a
65 backslash character (`\\'), the character should be preceded by a
68 The specific configuration options available are discussed below in the
69 Global Configuration Options, General Backend Options, and General Database
70 Options. Backend-specific options are discussed in the
71 .B slapd\-<backend>(5)
72 manual pages. Refer to the "OpenLDAP Administrator's Guide" for more
73 details on the slapd configuration file.
74 .SH GLOBAL CONFIGURATION OPTIONS
75 Options described in this section apply to all backends, unless specifically
76 overridden in a backend definition. Arguments that should be replaced by
77 actual text are shown in brackets <>.
79 .B access to <what> "[ by <who> <access> <control> ]+"
80 Grant access (specified by <access>) to a set of entries and/or
81 attributes (specified by <what>) by one or more requestors (specified
83 If no access controls are present, the default policy
84 allows anyone and everyone to read anything but restricts
85 updates to rootdn. (e.g., "access to * by * read").
86 The rootdn can always read and write EVERYTHING!
89 and the "OpenLDAP's Administrator's Guide" for details.
92 Specify a set of features (separated by white space) to
95 allows acceptance of LDAPv2 bind requests. Note that
97 does not truly implement LDAPv2 (RFC 1777), now Historic (RFC 3494).
99 allows anonymous bind when credentials are not empty (e.g.
102 allows unauthenticated (anonymous) bind when DN is not empty.
104 allows unauthenticated (anonymous) update operations to be processed
105 (subject to access controls and other administrative limits).
107 allows unauthenticated (anonymous) proxy authorization control to be processed
108 (subject to access controls, authorization and other administrative limits).
110 .B argsfile <filename>
111 The (absolute) name of a file that will hold the
113 server's command line (program name and options).
115 .B attributeoptions [option-name]...
116 Define tagging attribute options or option tag/range prefixes.
117 Options must not end with `\-', prefixes must end with `\-'.
118 The `lang\-' prefix is predefined.
121 directive, `lang\-' will no longer be defined and you must specify it
122 explicitly if you want it defined.
124 An attribute description with a tagging option is a subtype of that
125 attribute description without the option.
126 Except for that, options defined this way have no special semantics.
127 Prefixes defined this way work like the `lang\-' options:
128 They define a prefix for tagging options starting with the prefix.
129 That is, if you define the prefix `x\-foo\-', you can use the option
131 Furthermore, in a search or compare, a prefix or range name (with
132 a trailing `\-') matches all options starting with that name, as well
133 as the option with the range name sans the trailing `\-'.
134 That is, `x\-foo\-bar\-' matches `x\-foo\-bar' and `x\-foo\-bar\-baz'.
136 RFC 4520 reserves options beginning with `x\-' for private experiments.
137 Other options should be registered with IANA, see RFC 4520 section 3.5.
138 OpenLDAP also has the `binary' option built in, but this is a transfer
139 option, not a tagging option.
142 .B attributetype "(\ <oid>\
144 [DESC\ <description>]\
153 [NO\-USER\-MODIFICATION]\
154 [USAGE\ <attributeUsage>]\ )"
156 Specify an attribute type using the LDAPv3 syntax defined in RFC 4512.
157 The slapd parser extends the RFC 4512 definition by allowing string
158 forms as well as numeric OIDs to be used for the attribute OID and
159 attribute syntax OID.
165 .B authid\-rewrite<cmd> <args>
166 Used by the authentication framework to convert simple user names
167 to an LDAP DN used for authorization purposes.
168 Its purpose is analogous to that of
171 The prefix \fIauthid\-\fP is followed by a set of rules analogous
172 to those described in
174 for data rewriting (replace the \fIrwm\-\fP prefix with \fIauthid\-\fP).
175 .B authid\-rewrite<cmd>
178 rules should not be intermixed.
180 .B authz\-policy <policy>
181 Used to specify which rules to use for Proxy Authorization. Proxy
182 authorization allows a client to authenticate to the server using one
183 user's credentials, but specify a different identity to use for authorization
184 and access control purposes. It essentially allows user A to login as user
185 B, using user A's password.
188 flag disables proxy authorization. This is the default setting.
191 flag will use rules in the
193 attribute of the authorization DN.
196 flag will use rules in the
198 attribute of the authentication DN.
201 flag, an alias for the deprecated value of
203 will allow any of the above, whatever succeeds first (checked in
209 flag requires both authorizations to succeed.
212 The rules are mechanisms to specify which identities are allowed
213 to perform proxy authorization.
216 attribute in an entry specifies which other users
217 are allowed to proxy login to this entry. The
220 an entry specifies which other users this user can authorize as. Use of
223 abused if users are allowed to write arbitrary values to this attribute.
226 attribute must be protected with ACLs such that
227 only privileged users can modify it.
234 or a set of identities; it can take five forms:
237 .B ldap:///<base>??[<scope>]?<filter>
240 .B dn[.<dnstyle>]:<pattern>
243 .B u[.<mech>[/<realm>]]:<pattern>
246 .B group[/objectClass[/attributeType]]:<pattern>
253 .B <dnstyle>:={exact|onelevel|children|subtree|regex}
256 The first form is a valid LDAP
264 portions must be absent, so that the search occurs locally on either
270 with the optional style modifiers
276 for exact, onelevel, children and subtree matches, which cause
278 to be normalized according to the DN normalization rules, or the special
280 style, which causes the
282 to be treated as a POSIX (''extended'') regular expression, as
289 means any non-anonymous DN.
290 The third form is a SASL
292 with the optional fields
296 that allow to specify a SASL
298 and eventually a SASL
300 for those mechanisms that support one.
301 The need to allow the specification of a mechanism is still debated,
302 and users are strongly discouraged to rely on this possibility.
303 The fourth form is a group specification, consisting of the keyword
305 optionally followed by the specification of the group
311 is searched with base scope, and in case of match, the values of the
314 are searched for the asserted DN.
315 For backwards compatibility, if no identity type is provided, i.e. only
319 is assumed; as a consequence,
321 is subjected to DN normalization.
322 Since the interpretation of
326 can impact security, users are strongly encouraged
327 to explicitly set the type of identity specification that is being used.
328 A subset of these rules can be used as third arg in the
330 statement (see below); significantly, the
332 provided it results in exactly one entry,
338 .B authz\-regexp <match> <replace>
339 Used by the authentication framework to convert simple user names,
340 such as provided by SASL subsystem, or extracted from certificates
341 in case of cert-based SASL EXTERNAL, or provided within the RFC 4370
342 "proxied authorization" control, to an LDAP DN used for
343 authorization purposes. Note that the resulting DN need not refer
344 to an existing entry to be considered valid. When an authorization
345 request is received from the SASL subsystem, the SASL
350 are taken, when available, and combined into a name of the form
354 .B UID=<username>[[,CN=<realm>],CN=<mechanism>],CN=auth
357 This name is then compared against the
359 POSIX (''extended'') regular expression, and if the match is successful,
360 the name is replaced with the
362 string. If there are wildcard strings in the
364 regular expression that are enclosed in parenthesis, e.g.
370 then the portion of the name that matched the wildcard will be stored
371 in the numbered placeholder variable $1. If there are other wildcard strings
372 in parenthesis, the matching strings will be in $2, $3, etc. up to $9. The
373 placeholders can then be used in the
378 .B UID=$1,OU=Accounts,DC=example,DC=com
381 The replaced name can be either a DN, i.e. a string prefixed by "dn:",
383 If the latter, the server will use the URI to search its own database(s)
384 and, if the search returns exactly one entry, the name is
385 replaced by the DN of that entry. The LDAP URI must have no
386 hostport, attrs, or extensions components, but the filter is mandatory,
390 .B ldap:///OU=Accounts,DC=example,DC=com??one?(UID=$1)
393 The protocol portion of the URI must be strictly
395 Note that this search is subject to access controls. Specifically,
396 the authentication identity must have "auth" access in the subject.
400 options can be given in the configuration file to allow for multiple matching
401 and replacement patterns. The matching patterns are checked in the order they
402 appear in the file, stopping at the first successful match.
405 .\"Because the plus sign + is a character recognized by the regular expression engine,
406 .\"and it will appear in names that include a REALM, be careful to escape the
407 .\"plus sign with a backslash \\+ to remove the character's special meaning.
410 .B concurrency <integer>
411 Specify a desired level of concurrency. Provided to the underlying
412 thread system as a hint. The default is not to provide any hint.
414 .B conn_max_pending <integer>
415 Specify the maximum number of pending requests for an anonymous session.
416 If requests are submitted faster than the server can process them, they
417 will be queued up to this limit. If the limit is exceeded, the session
418 is closed. The default is 100.
420 .B conn_max_pending_auth <integer>
421 Specify the maximum number of pending requests for an authenticated session.
424 .B defaultsearchbase <dn>
425 Specify a default search base to use when client submits a
426 non-base search request with an empty base DN.
427 Base scoped search requests with an empty base DN are not affected.
429 .B disallow <features>
430 Specify a set of features (separated by white space) to
431 disallow (default none).
433 disables acceptance of anonymous bind requests. Note that this setting
434 does not prohibit anonymous directory access (See "require authc").
436 disables simple (bind) authentication.
438 disables forcing session to anonymous status (see also
440 upon StartTLS operation receipt.
442 disallows the StartTLS operation if authenticated (see also
444 .B proxy_authz_non_critical
445 disables acceptance of the proxied authorization control (RFC4370)
446 when criticality is FALSE.
447 .B dontusecopy_non_critical
448 disables acceptance of the dontUseCopy control (a work in progress)
449 when criticality is FALSE.
452 .B ditcontentrule "(\ <oid>\
454 [DESC\ <description>]\
461 Specify an DIT Content Rule using the LDAPv3 syntax defined in RFC 4512.
462 The slapd parser extends the RFC 4512 definition by allowing string
463 forms as well as numeric OIDs to be used for the attribute OID and
464 attribute syntax OID.
470 .B gentlehup { on | off }
471 A SIGHUP signal will only cause a 'gentle' shutdown-attempt:
473 will stop listening for new connections, but will not close the
474 connections to the current clients. Future write operations return
475 unwilling-to-perform, though. Slapd terminates when all clients
476 have closed their connections (if they ever do), or - as before -
477 if it receives a SIGTERM signal. This can be useful if you wish to
478 terminate the server and start a new
481 .B with another database,
482 without disrupting the currently active clients.
483 The default is off. You may wish to use
485 along with this option.
487 .B idletimeout <integer>
488 Specify the number of seconds to wait before forcibly closing
489 an idle client connection. A idletimeout of 0 disables this
490 feature. The default is 0. You may also want to set the
494 .B include <filename>
495 Read additional configuration information from the given file before
496 continuing with the next line of the current file.
498 .B index_intlen <integer>
499 Specify the key length for ordered integer indices. The most significant
500 bytes of the binary integer will be used for index keys. The default
501 value is 4, which provides exact indexing for 31 bit values.
502 A floating point representation is used to index too large values.
504 .B index_substr_if_minlen <integer>
505 Specify the minimum length for subinitial and subfinal indices. An
506 attribute value must have at least this many characters in order to be
507 processed by the indexing functions. The default is 2.
509 .B index_substr_if_maxlen <integer>
510 Specify the maximum length for subinitial and subfinal indices. Only
511 this many characters of an attribute value will be processed by the
512 indexing functions; any excess characters are ignored. The default is 4.
514 .B index_substr_any_len <integer>
515 Specify the length used for subany indices. An attribute value must have
516 at least this many characters in order to be processed. Attribute values
517 longer than this length will be processed in segments of this length. The
518 default is 4. The subany index will also be used in subinitial and
519 subfinal index lookups when the filter string is longer than the
520 .I index_substr_if_maxlen
523 .B index_substr_any_step <integer>
524 Specify the steps used in subany index lookups. This value sets the offset
525 for the segments of a filter string that are processed for a subany index
526 lookup. The default is 2. For example, with the default values, a search
527 using this filter "cn=*abcdefgh*" would generate index lookups for
528 "abcd", "cdef", and "efgh".
531 Note: Indexing support depends on the particular backend in use. Also,
532 changing these settings will generally require deleting any indices that
533 depend on these parameters and recreating them with
538 .B ldapsyntax "(\ <oid>\
539 [DESC\ <description>]\
540 [X\-SUBST <substitute-syntax>]\ )"
542 Specify an LDAP syntax using the LDAPv3 syntax defined in RFC 4512.
543 The slapd parser extends the RFC 4512 definition by allowing string
544 forms as well as numeric OIDs to be used for the syntax OID.
548 The slapd parser also honors the
550 extension (an OpenLDAP-specific extension), which allows to use the
552 statement to define a non-implemented syntax along with another syntax,
554 .IR substitute-syntax ,
555 as its temporary replacement.
559 This allows to define attribute types that make use of non-implemented syntaxes
560 using the correct syntax OID.
563 is used, this configuration statement would result in an error,
564 since no handlers would be associated to the resulting syntax structure.
568 .B listener-threads <integer>
569 Specify the number of threads to use for the connection manager.
570 The default is 1 and this is typically adequate for up to 16 CPU cores.
571 The value should be set to a power of 2.
574 Specifies the Security Strength Factor (SSF) to be given local LDAP sessions,
575 such as those to the ldapi:// listener. For a description of SSF values,
579 option description. The default is 71.
581 .B logfile <filename>
582 Specify a file for recording debug log messages. By default these messages
583 only go to stderr and are not recorded anywhere else. Specifying a logfile
584 copies messages to both stderr and the logfile.
586 .B loglevel <integer> [...]
587 Specify the level at which debugging statements and operation
588 statistics should be syslogged (currently logged to the
590 LOG_LOCAL4 facility).
591 They must be considered subsystems rather than increasingly verbose
593 Some messages with higher priority are logged regardless
594 of the configured loglevel as soon as any logging is configured.
595 Log levels are additive, and available levels are:
606 debug packet handling
610 heavy trace debugging (function args)
614 connection management
618 print out packets sent and received
622 search filter processing
626 configuration file processing
630 access control list processing
634 connections, LDAP operations, results (recommended)
638 stats log entries sent
642 print communication with shell backends
654 \"data indexing (unused)
662 only messages that get logged whatever log level is set
665 The desired log level can be input as a single integer that combines
666 the (ORed) desired levels, both in decimal or in hexadecimal notation,
667 as a list of integers (that are ORed internally),
668 or as a list of the names that are shown between brackets, such that
681 can be used as a shortcut to enable logging at all levels (equivalent to \-1).
684 or the equivalent integer representation, causes those messages
685 that are logged regardless of the configured loglevel to be logged.
686 In fact, if loglevel is set to 0, no logging occurs,
689 level is required to have high priority messages logged.
691 The loglevel defaults to \fBstats\fP.
692 This level should usually also be included when using other loglevels, to
693 help analyze the logs.
696 .B moduleload <filename>
697 Specify the name of a dynamically loadable module to load. The filename
698 may be an absolute path name or a simple filename. Non-absolute names
699 are searched for in the directories specified by the
701 option. This option and the
703 option are only usable if slapd was compiled with \-\-enable\-modules.
705 .B modulepath <pathspec>
706 Specify a list of directories to search for loadable modules. Typically
707 the path is colon-separated but this depends on the operating system.
708 The default is MODULEDIR, which is where the standard OpenLDAP install
709 will place its modules.
712 .B objectclass "(\ <oid>\
714 [DESC\ <description>]\
717 [{ ABSTRACT | STRUCTURAL | AUXILIARY }]\
718 [MUST\ <oids>] [MAY\ <oids>] )"
720 Specify an objectclass using the LDAPv3 syntax defined in RFC 4512.
721 The slapd parser extends the RFC 4512 definition by allowing string
722 forms as well as numeric OIDs to be used for the object class OID.
726 description.) Object classes are "STRUCTURAL" by default.
729 .B objectidentifier <name> "{ <oid> | <name>[:<suffix>] }"
730 Define a string name that equates to the given OID. The string can be used
731 in place of the numeric OID in objectclass and attribute definitions. The
732 name can also be used with a suffix of the form ":xx" in which case the
733 value "oid.xx" will be used.
735 .B password\-hash <hash> [<hash>...]
736 This option configures one or more hashes to be used in generation of user
737 passwords stored in the userPassword attribute during processing of
738 LDAP Password Modify Extended Operations (RFC 3062).
739 The <hash> must be one of
753 use the SHA-1 algorithm (FIPS 160-1), the latter with a seed.
758 use the MD5 algorithm (RFC 1321), the latter with a seed.
765 indicates that the new password should be
766 added to userPassword as clear text.
768 Note that this option does not alter the normal user applications
769 handling of userPassword during LDAP Add, Modify, or other LDAP operations.
771 .B password\-crypt\-salt\-format <format>
772 Specify the format of the salt passed to
774 when generating {CRYPT} passwords (see
776 during processing of LDAP Password Modify Extended Operations (RFC 3062).
778 This string needs to be in
780 format and may include one (and only one) %s conversion.
781 This conversion will be substituted with a string of random
782 characters from [A\-Za\-z0\-9./]. For example, "%.2s"
783 provides a two character salt and "$1$%.8s" tells some
784 versions of crypt(3) to use an MD5 algorithm and provides
785 8 random characters of salt. The default is "%s", which
786 provides 31 characters of salt.
788 .B pidfile <filename>
789 The (absolute) name of a file that will hold the
791 server's process ID (see
795 Specify the referral to pass back when
797 cannot find a local database to handle a request.
798 If specified multiple times, each url is provided.
800 .B require <conditions>
801 Specify a set of conditions (separated by white space) to
802 require (default none).
803 The directive may be specified globally and/or per-database;
804 databases inherit global conditions, so per-database specifications
807 requires bind operation prior to directory operations.
809 requires session to be using LDAP version 3.
811 requires authentication prior to directory operations.
813 requires SASL authentication prior to directory operations.
815 requires strong authentication prior to directory operations.
816 The strong keyword allows protected "simple" authentication
817 as well as SASL authentication.
819 may be used to require no conditions (useful to clear out globally
820 set conditions within a particular database); it must occur first
821 in the list of conditions.
823 .B reverse\-lookup on | off
824 Enable/disable client name unverified reverse lookup (default is
826 if compiled with \-\-enable\-rlookups).
829 Specify the name of an LDIF(5) file containing user defined attributes
830 for the root DSE. These attributes are returned in addition to the
831 attributes normally produced by slapd.
833 The root DSE is an entry with information about the server and its
834 capabilities, in operational attributes.
835 It has the empty DN, and can be read with e.g.:
837 ldapsearch \-x \-b "" \-s base "+"
839 See RFC 4512 section 5.1 for details.
841 .B sasl\-auxprops <plugin> [...]
842 Specify which auxprop plugins to use for authentication lookups. The
843 default is empty, which just uses slapd's internal support. Usually
844 no other auxprop plugins are needed.
847 Used to specify the fully qualified domain name used for SASL processing.
849 .B sasl\-realm <realm>
850 Specify SASL realm. Default is empty.
852 .B sasl\-secprops <properties>
853 Used to specify Cyrus SASL security properties.
856 flag (without any other properties) causes the flag properties
857 default, "noanonymous,noplain", to be cleared.
860 flag disables mechanisms susceptible to simple passive attacks.
863 flag disables mechanisms susceptible to active attacks.
866 flag disables mechanisms susceptible to passive dictionary attacks.
869 flag disables mechanisms which support anonymous login.
872 flag require forward secrecy between sessions.
875 require mechanisms which pass client credentials (and allow
876 mechanisms which can pass credentials to do so).
879 property specifies the minimum acceptable
880 .I security strength factor
881 as an integer approximate to effective key length used for
882 encryption. 0 (zero) implies no protection, 1 implies integrity
883 protection only, 56 allows DES or other weak ciphers, 112
884 allows triple DES and other strong ciphers, 128 allows RC4,
885 Blowfish and other modern strong ciphers. The default is 0.
888 property specifies the maximum acceptable
889 .I security strength factor
890 as an integer (see minssf description). The default is INT_MAX.
893 property specifies the maximum security layer receive buffer
894 size allowed. 0 disables security layers. The default is 65536.
897 Specify the distinguished name for the subschema subentry that
898 controls the entries on this server. The default is "cn=Subschema".
900 .B security <factors>
901 Specify a set of security strength factors (separated by white space)
903 .BR sasl\-secprops 's
905 option for a description of security strength factors).
906 The directive may be specified globally and/or per-database.
908 specifies the overall security strength factor.
910 specifies the transport security strength factor.
912 specifies the TLS security strength factor.
914 specifies the SASL security strength factor.
916 specifies the overall security strength factor to require for
918 .B update_transport=<n>
919 specifies the transport security strength factor to require for
922 specifies the TLS security strength factor to require for
925 specifies the SASL security strength factor to require for
928 specifies the security strength factor required for
930 username/password authentication.
933 factor is measure of security provided by the underlying transport,
934 e.g. ldapi:// (and eventually IPSEC). It is not normally used.
936 .B serverID <integer> [<URL>]
937 Specify an integer ID from 0 to 4095 for this server (limited
938 to 3 hexadecimal digits). The ID may also be specified as a
939 hexadecimal ID by prefixing the value with "0x".
941 required when using multimaster replication and each master must have a
942 unique ID. Note that this requirement also applies to separate masters
943 contributing to a glued set of databases.
944 If the URL is provided, this directive may be specified
945 multiple times, providing a complete list of participating servers
946 and their IDs. The fully qualified hostname of each server should be
947 used in the supplied URLs. The IDs are used in the "replica id" field
948 of all CSNs generated by the specified server. The default value is zero.
955 .B sizelimit {<integer>|unlimited}
957 .B sizelimit size[.{soft|hard|unchecked}]=<integer> [...]
958 Specify the maximum number of entries to return from a search operation.
959 The default size limit is 500.
962 to specify no limits.
963 The second format allows a fine grain setting of the size limits.
964 Extra args can be added on the same line.
967 for an explanation of the different flags.
969 .B sockbuf_max_incoming <integer>
970 Specify the maximum incoming LDAP PDU size for anonymous sessions.
971 The default is 262143.
973 .B sockbuf_max_incoming_auth <integer>
974 Specify the maximum incoming LDAP PDU size for authenticated sessions.
975 The default is 4194303.
977 .B sortvals <attr> [...]
978 Specify a list of multi-valued attributes whose values will always
979 be maintained in sorted order. Using this option will allow Modify,
980 Compare, and filter evaluations on these attributes to be performed
981 more efficiently. The resulting sort order depends on the
982 attributes' syntax and matching rules and may not correspond to
983 lexical order or any other recognizable order.
985 .B tcp-buffer [listener=<URL>] [{read|write}=]<size>
986 Specify the size of the TCP buffer.
987 A global value for both read and write TCP buffers related to any listener
988 is defined, unless the listener is explicitly specified,
989 or either the read or write qualifiers are used.
993 Note that some OS-es implement automatic TCP buffer tuning.
996 Specify the maximum size of the primary thread pool.
997 The default is 16; the minimum value is 2.
999 .B timelimit {<integer>|unlimited}
1001 .B timelimit time[.{soft|hard}]=<integer> [...]
1002 Specify the maximum number of seconds (in real time)
1004 will spend answering a search request. The default time limit is 3600.
1007 to specify no limits.
1008 The second format allows a fine grain setting of the time limits.
1009 Extra args can be added on the same line.
1012 for an explanation of the different flags.
1014 .B tool\-threads <integer>
1015 Specify the maximum number of threads to use in tool mode.
1016 This should not be greater than the number of CPUs in the system.
1018 .\"ucdata-path is obsolete / ignored...
1020 .\".B ucdata-path <path>
1021 .\"Specify the path to the directory containing the Unicode character
1022 .\"tables. The default path is DATADIR/ucdata.
1024 .B writetimeout <integer>
1025 Specify the number of seconds to wait before forcibly closing
1026 a connection with an outstanding write. This allows recovery from
1027 various network hang conditions. A writetimeout of 0 disables this
1028 feature. The default is 0.
1032 is built with support for Transport Layer Security, there are more options
1035 .B TLSCipherSuite <cipher-suite-spec>
1036 Permits configuring what ciphers will be accepted and the preference order.
1037 <cipher-suite-spec> should be a cipher specification for the TLS library
1038 in use (OpenSSL, GnuTLS, or Mozilla NSS).
1044 TLSCipherSuite HIGH:MEDIUM:+SSLv2
1047 TLSCiphersuite SECURE256:!AES-128-CBC
1050 To check what ciphers a given spec selects in OpenSSL, use:
1053 openssl ciphers \-v <cipher-suite-spec>
1056 With GnuTLS the available specs can be found in the manual page of
1058 (see the description of the
1062 In older versions of GnuTLS, where gnutls\-cli does not support the option
1063 \-\-priority, you can obtain the \(em more limited \(em list of ciphers by calling:
1069 When using Mozilla NSS, the OpenSSL cipher suite specifications are used and
1070 translated into the format used internally by Mozilla NSS. There isn't an easy
1071 way to list the cipher suites from the command line. The authoritative list
1072 is in the source code for Mozilla NSS in the file sslinfo.c in the structure
1074 static const SSLCipherSuiteInfo suiteInfo[]
1078 .B TLSCACertificateFile <filename>
1079 Specifies the file that contains certificates for all of the Certificate
1082 will recognize. The certificate for
1083 the CA that signed the server certificate must be included among
1084 these certificates. If the signing CA was not a top-level (root) CA,
1085 certificates for the entire sequence of CA's from the signing CA to
1086 the top-level CA should be present. Multiple certificates are simply
1087 appended to the file; the order is not significant.
1089 .B TLSCACertificatePath <path>
1090 Specifies the path of a directory that contains Certificate Authority
1091 certificates in separate individual files. Usually only one of this
1092 or the TLSCACertificateFile is used. This directive is not supported
1095 When using Mozilla NSS, <path> may contain a Mozilla NSS cert/key
1096 database. If <path> contains a Mozilla NSS cert/key database and
1097 CA cert files, OpenLDAP will use the cert/key database and will
1098 ignore the CA cert files.
1100 .B TLSCertificateFile <filename>
1101 Specifies the file that contains the
1105 When using Mozilla NSS, if using a cert/key database (specified with
1106 TLSCACertificatePath), TLSCertificateFile specifies
1107 the name of the certificate to use:
1109 TLSCertificateFile Server-Cert
1111 If using a token other than the internal built in token, specify the
1112 token name first, followed by a colon:
1114 TLSCertificateFile my hardware device:Server-Cert
1116 Use certutil -L to list the certificates by name:
1118 certutil -d /path/to/certdbdir -L
1121 .B TLSCertificateKeyFile <filename>
1122 Specifies the file that contains the
1124 server private key that matches the certificate stored in the
1125 .B TLSCertificateFile
1126 file. Currently, the private key must not be protected with a password, so
1127 it is of critical importance that it is protected carefully.
1129 When using Mozilla NSS, TLSCertificateKeyFile specifies the name of
1130 a file that contains the password for the key for the certificate specified with
1131 TLSCertificateFile. The modutil command can be used to turn off password
1132 protection for the cert/key database. For example, if TLSCACertificatePath
1133 specifes /etc/openldap/certdb as the location of the cert/key database, use
1134 modutil to change the password to the empty string:
1136 modutil -dbdir /etc/openldap/certdb -changepw 'NSS Certificate DB'
1138 You must have the old password, if any. Ignore the WARNING about the running
1139 browser. Press 'Enter' for the new password.
1141 .B TLSDHParamFile <filename>
1142 This directive specifies the file that contains parameters for Diffie-Hellman
1143 ephemeral key exchange. This is required in order to use a DSA certificate on
1144 the server. If multiple sets of parameters are present in the file, all of
1145 them will be processed. Note that setting this option may also enable
1146 Anonymous Diffie-Hellman key exchanges in certain non-default cipher suites.
1147 You should append "!ADH" to your cipher suites if you have changed them
1148 from the default, otherwise no certificate exchanges or verification will
1149 be done. When using GnuTLS these parameters are always generated randomly so
1150 this directive is ignored. This directive is ignored when using Mozilla NSS.
1152 .B TLSRandFile <filename>
1153 Specifies the file to obtain random bits from when /dev/[u]random
1154 is not available. Generally set to the name of the EGD/PRNGD socket.
1155 The environment variable RANDFILE can also be used to specify the filename.
1156 This directive is ignored with GnuTLS and Mozilla NSS.
1158 .B TLSVerifyClient <level>
1159 Specifies what checks to perform on client certificates in an
1160 incoming TLS session, if any.
1163 can be specified as one of the following keywords:
1167 This is the default.
1169 will not ask the client for a certificate.
1172 The client certificate is requested. If no certificate is provided,
1173 the session proceeds normally. If a bad certificate is provided,
1174 it will be ignored and the session proceeds normally.
1177 The client certificate is requested. If no certificate is provided,
1178 the session proceeds normally. If a bad certificate is provided,
1179 the session is immediately terminated.
1181 .B demand | hard | true
1182 These keywords are all equivalent, for compatibility reasons.
1183 The client certificate is requested. If no certificate is provided,
1184 or a bad certificate is provided, the session is immediately terminated.
1186 Note that a valid client certificate is required in order to use the
1187 SASL EXTERNAL authentication mechanism with a TLS session. As such,
1190 setting must be chosen to enable SASL EXTERNAL authentication.
1193 .B TLSCRLCheck <level>
1194 Specifies if the Certificate Revocation List (CRL) of the CA should be
1195 used to verify if the client certificates have not been revoked. This
1197 .B TLSCACertificatePath
1198 parameter to be set. This directive is ignored with GnuTLS and Mozilla NSS.
1200 can be specified as one of the following keywords:
1204 No CRL checks are performed
1207 Check the CRL of the peer certificate
1210 Check the CRL for a whole certificate chain
1213 .B TLSCRLFile <filename>
1214 Specifies a file containing a Certificate Revocation List to be used
1215 for verifying that certificates have not been revoked. This directive is
1216 only valid when using GnuTLS and Mozilla NSS.
1217 .SH GENERAL BACKEND OPTIONS
1218 Options in this section only apply to the configuration file section
1219 for the specified backend. They are supported by every
1222 .B backend <databasetype>
1223 Mark the beginning of a backend definition. <databasetype>
1240 depending on which backend will serve the database.
1242 .SH GENERAL DATABASE OPTIONS
1243 Options in this section only apply to the configuration file section
1244 for the database in which they are defined. They are supported by every
1245 type of backend. Note that the
1249 option are mandatory for each database.
1251 .B database <databasetype>
1252 Mark the beginning of a new database instance definition. <databasetype>
1269 depending on which backend will serve the database.
1271 LDAP operations, even subtree searches, normally access only one
1273 That can be changed by gluing databases together with the
1276 Access controls and some overlays can also involve multiple databases.
1278 .B add_content_acl on | off
1279 Controls whether Add operations will perform ACL checks on
1280 the content of the entry being added. This check is off
1282 .BR slapd.access (5)
1283 manual page for more details on ACL requirements for
1286 .B extra_attrs <attrlist>
1287 Lists what attributes need to be added to search requests.
1288 Local storage backends return the entire entry to the frontend.
1289 The frontend takes care of only returning the requested attributes
1290 that are allowed by ACLs.
1291 However, features like access checking and so may need specific
1292 attributes that are not automatically returned by remote storage
1293 backends, like proxy backends and so on.
1295 is a list of attributes that are needed for internal purposes
1296 and thus always need to be collected, even when not explicitly
1297 requested by clients.
1300 Controls whether the database will be used to answer
1301 queries. A database that is hidden will never be
1302 selected to answer any queries, and any suffix configured
1303 on the database will be ignored in checks for conflicts
1304 with other databases. By default, hidden is off.
1309 will automatically maintain the
1310 modifiersName, modifyTimestamp, creatorsName, and
1311 createTimestamp attributes for entries. It also controls
1312 the entryCSN and entryUUID attributes, which are needed
1313 by the syncrepl provider. By default, lastmod is on.
1315 .B limits <selector> <limit> [<limit> [...]]
1316 Specify time and size limits based on the operation's initiator or
1324 anonymous | users | [<dnspec>=]<pattern> | group[/oc[/at]]=<pattern>
1330 <dnspec> ::= dn[.<type>][.<style>]
1332 <type> ::= self | this
1334 <style> ::= exact | base | onelevel | subtree | children | regex | anonymous
1339 is the default and means the bound user, while
1341 means the base DN of the operation.
1344 matches all unauthenticated clients.
1347 matches all authenticated clients;
1350 dn pattern is assumed unless otherwise specified by qualifying
1351 the (optional) key string
1357 (which are synonyms), to require an exact match; with
1359 to require exactly one level of depth match; with
1361 to allow any level of depth match, including the exact match; with
1363 to allow any level of depth match, not including the exact match;
1365 explicitly requires the (default) match based on POSIX (''extended'')
1366 regular expression pattern.
1369 matches unbound operations; the
1372 The same behavior is obtained by using the
1379 with the optional objectClass
1385 sets the limits for any DN listed in the values of the
1391 group objectClass (default
1393 whose DN exactly matches
1396 The currently supported limits are
1401 The syntax for time limits is
1402 .BR time[.{soft|hard}]=<integer> ,
1405 is the number of seconds slapd will spend answering a search request.
1406 If no time limit is explicitly requested by the client, the
1408 limit is used; if the requested time limit exceeds the
1411 .\".I "Administrative limit exceeded"
1412 .\"error is returned.
1413 limit, the value of the limit is used instead.
1416 limit is set to the keyword
1418 the soft limit is used in either case; if it is set to the keyword
1420 no hard limit is enforced.
1421 Explicit requests for time limits smaller or equal to the
1424 If no limit specifier is set, the value is assigned to the
1430 to preserve the original behavior.
1432 The syntax for size limits is
1433 .BR size[.{soft|hard|unchecked}]=<integer> ,
1436 is the maximum number of entries slapd will return answering a search
1438 If no size limit is explicitly requested by the client, the
1440 limit is used; if the requested size limit exceeds the
1443 .\".I "Administrative limit exceeded"
1444 .\"error is returned.
1445 limit, the value of the limit is used instead.
1448 limit is set to the keyword
1450 the soft limit is used in either case; if it is set to the keyword
1452 no hard limit is enforced.
1453 Explicit requests for size limits smaller or equal to the
1458 specifier sets a limit on the number of candidates a search request is allowed
1460 The rationale behind it is that searches for non-properly indexed
1461 attributes may result in large sets of candidates, which must be
1464 to determine whether they match the search filter or not.
1467 limit provides a means to drop such operations before they are even
1469 If the selected candidates exceed the
1471 limit, the search will abort with
1472 .IR "Unwilling to perform" .
1473 If it is set to the keyword
1475 no limit is applied (the default).
1478 the search is not even performed; this can be used to disallow searches
1479 for a specific set of users.
1480 If no limit specifier is set, the value is assigned to the
1486 to preserve the original behavior.
1488 In case of no match, the global limits are used.
1489 The default values are the same as for
1498 control is requested, the
1500 size limit is used by default, because the request of a specific page size
1501 is considered an explicit request for a limitation on the number
1502 of entries to be returned.
1503 However, the size limit applies to the total count of entries returned within
1504 the search, and not to a single page.
1505 Additional size limits may be enforced; the syntax is
1506 .BR size.pr={<integer>|noEstimate|unlimited} ,
1509 is the max page size if no explicit limit is set; the keyword
1511 inhibits the server from returning an estimate of the total number
1512 of entries that might be returned
1513 (note: the current implementation does not return any estimate).
1516 indicates that no limit is applied to the pagedResults control page size.
1518 .B size.prtotal={<integer>|unlimited|disabled}
1519 allows to set a limit on the total number of entries that a pagedResults
1520 control allows to return.
1521 By default it is set to the
1526 is the max number of entries that the whole search with pagedResults control
1530 to allow unlimited number of entries to be returned, e.g. to allow
1531 the use of the pagedResults control as a means to circumvent size
1532 limitations on regular searches; the keyword
1534 disables the control, i.e. no paged results can be returned.
1535 Note that the total number of entries returned when the pagedResults control
1536 is requested cannot exceed the
1538 size limit of regular searches unless extended by the
1542 The \fBlimits\fP statement is typically used to let an unlimited
1543 number of entries be returned by searches performed
1544 with the identity used by the consumer for synchronization purposes
1545 by means of the RFC 4533 LDAP Content Synchronization protocol
1546 (see \fBsyncrepl\fP for details).
1549 .B maxderefdepth <depth>
1550 Specifies the maximum number of aliases to dereference when trying to
1551 resolve an entry, used to avoid infinite alias loops. The default is 15.
1553 .B mirrormode on | off
1554 This option puts a replica database into "mirror" mode. Update
1555 operations will be accepted from any user, not just the updatedn. The
1556 database must already be configured as a syncrepl consumer
1557 before this keyword may be set. This mode also requires a
1559 (see above) to be configured.
1560 By default, mirrormode is off.
1562 .B monitoring on | off
1563 This option enables database-specific monitoring in the entry related
1564 to the current database in the "cn=Databases,cn=Monitor" subtree
1565 of the monitor database, if the monitor database is enabled.
1566 Currently, only the BDB and the HDB databases provide database-specific
1568 The default depends on the backend type.
1570 .B overlay <overlay-name>
1571 Add the specified overlay to this database. An overlay is a piece of
1572 code that intercepts database operations in order to extend or change
1573 them. Overlays are pushed onto
1574 a stack over the database, and so they will execute in the reverse
1575 of the order in which they were configured and the database itself
1576 will receive control last of all. See the
1577 .BR slapd.overlays (5)
1578 manual page for an overview of the available overlays.
1579 Note that all of the database's
1580 regular settings should be configured before any overlay settings.
1582 .B readonly on | off
1583 This option puts the database into "read-only" mode. Any attempts to
1584 modify the database will return an "unwilling to perform" error. By
1585 default, readonly is off.
1587 .B restrict <oplist>
1588 Specify a whitespace separated list of operations that are restricted.
1589 If defined inside a database specification, restrictions apply only
1590 to that database, otherwise they are global.
1591 Operations can be any of
1596 .BR extended[=<OID>] ,
1600 or the special pseudo-operations
1604 which respectively summarize read and write operations.
1612 keyword allows to indicate the OID of the specific operation
1616 Specify the distinguished name that is not subject to access control
1617 or administrative limit restrictions for operations on this database.
1618 This DN may or may not be associated with an entry. An empty root
1619 DN (the default) specifies no root access is to be granted. It is
1620 recommended that the rootdn only be specified when needed (such as
1621 when initially populating a database). If the rootdn is within
1622 a namingContext (suffix) of the database, a simple bind password
1623 may also be provided using the
1625 directive. Many optional features, including syncrepl, require the
1626 rootdn to be defined for the database.
1628 .B rootpw <password>
1629 Specify a password (or hash of the password) for the rootdn. The
1630 password can only be set if the rootdn is within the namingContext
1631 (suffix) of the database.
1632 This option accepts all RFC 2307 userPassword formats known to
1635 description) as well as cleartext.
1637 may be used to generate a hash of a password. Cleartext
1638 and \fB{CRYPT}\fP passwords are not recommended. If empty
1639 (the default), authentication of the root DN is by other means
1640 (e.g. SASL). Use of SASL is encouraged.
1642 .B suffix <dn suffix>
1643 Specify the DN suffix of queries that will be passed to this
1644 backend database. Multiple suffix lines can be given and at least one is
1645 required for each database definition.
1647 If the suffix of one database is "inside" that of another, the database
1648 with the inner suffix must come first in the configuration file.
1649 You may also want to glue such databases together with the
1653 .B subordinate [advertise]
1654 Specify that the current backend database is a subordinate of another
1655 backend database. A subordinate database may have only one suffix. This
1656 option may be used to glue multiple databases into a single namingContext.
1657 If the suffix of the current database is within the namingContext of a
1658 superior database, searches against the superior database will be
1659 propagated to the subordinate as well. All of the databases
1660 associated with a single namingContext should have identical rootdns.
1661 Behavior of other LDAP operations is unaffected by this setting. In
1662 particular, it is not possible to use moddn to move an entry from
1663 one subordinate to another subordinate within the namingContext.
1665 If the optional \fBadvertise\fP flag is supplied, the naming context of
1666 this database is advertised in the root DSE. The default is to hide this
1667 database context, so that only the superior context is visible.
1674 are used on the superior database, any glued subordinates that support
1675 these tools are opened as well.
1677 Databases that are glued together should usually be configured with the
1678 same indices (assuming they support indexing), even for attributes that
1679 only exist in some of these databases. In general, all of the glued
1680 databases should be configured as similarly as possible, since the intent
1681 is to provide the appearance of a single directory.
1683 Note that the \fIsubordinate\fP functionality is implemented internally
1684 by the \fIglue\fP overlay and as such its behavior will interact with other
1685 overlays in use. By default, the glue overlay is automatically configured as
1686 the last overlay on the superior backend. Its position on the backend
1687 can be explicitly configured by setting an \fBoverlay glue\fP directive
1688 at the desired position. This explicit configuration is necessary e.g.
1689 when using the \fIsyncprov\fP overlay, which needs to follow \fIglue\fP
1690 in order to work over all of the glued databases. E.g.
1694 suffix dc=example,dc=com
1701 .B sync_use_subentry
1702 Store the syncrepl contextCSN in a subentry instead of the context entry
1703 of the database. The subentry's RDN will be "cn=ldapsync". By default
1704 the contextCSN is stored in the context entry.
1707 .B syncrepl rid=<replica ID>
1708 .B provider=ldap[s]://<hostname>[:port]
1709 .B searchbase=<base DN>
1710 .B [type=refreshOnly|refreshAndPersist]
1711 .B [interval=dd:hh:mm:ss]
1712 .B [retry=[<retry interval> <# of retries>]+]
1713 .B [filter=<filter str>]
1714 .B [scope=sub|one|base|subord]
1715 .B [attrs=<attr list>]
1717 .B [sizelimit=<limit>]
1718 .B [timelimit=<limit>]
1719 .B [schemachecking=on|off]
1720 .B [network\-timeout=<seconds>]
1721 .B [timeout=<seconds>]
1722 .B [bindmethod=simple|sasl]
1724 .B [saslmech=<mech>]
1725 .B [authcid=<identity>]
1726 .B [authzid=<identity>]
1727 .B [credentials=<passwd>]
1729 .B [secprops=<properties>]
1730 .B [keepalive=<idle>:<probes>:<interval>]
1731 .B [starttls=yes|critical]
1732 .B [tls_cert=<file>]
1734 .B [tls_cacert=<file>]
1735 .B [tls_cacertdir=<path>]
1736 .B [tls_reqcert=never|allow|try|demand]
1737 .B [tls_ciphersuite=<ciphers>]
1738 .B [tls_crlcheck=none|peer|all]
1739 .B [suffixmassage=<real DN>]
1740 .B [logbase=<base DN>]
1741 .B [logfilter=<filter str>]
1742 .B [syncdata=default|accesslog|changelog]
1744 Specify the current database as a replica which is kept up-to-date with the
1745 master content by establishing the current
1747 as a replication consumer site running a
1750 The replica content is kept synchronized to the master content using
1751 the LDAP Content Synchronization protocol. Refer to the
1752 "OpenLDAP Administrator's Guide" for detailed information on
1753 setting up a replicated
1755 directory service using the
1760 identifies the current
1762 directive within the replication consumer site.
1763 It is a non-negative integer not greater than 999 (limited
1764 to three decimal digits).
1767 specifies the replication provider site containing the master content
1768 as an LDAP URI. If <port> is not given, the standard LDAP port number
1769 (389 or 636) is used.
1773 replica is defined using a search
1774 specification as its result set. The consumer
1776 will send search requests to the provider
1778 according to the search specification. The search specification includes
1779 .BR searchbase ", " scope ", " filter ", " attrs ", " attrsonly ", " sizelimit ", "
1782 parameters as in the normal search specification.
1783 The \fBscope\fP defaults to \fBsub\fP, the \fBfilter\fP defaults to
1784 \fB(objectclass=*)\fP, while there is no default \fBsearchbase\fP. The
1785 \fBattrs\fP list defaults to \fB"*,+"\fP to return all user and operational
1786 attributes, and \fBattrsonly\fP is unset by default.
1787 The \fBsizelimit\fP and \fBtimelimit\fP only
1788 accept "unlimited" and positive integers, and both default to "unlimited".
1789 The \fBsizelimit\fP and \fBtimelimit\fP parameters define
1790 a consumer requested limitation on the number of entries that can be returned
1791 by the LDAP Content Synchronization operation; as such, it is intended
1792 to implement partial replication based on the size of the replicated database
1793 and on the time required by the synchronization.
1794 Note, however, that any provider-side limits for the replication identity
1795 will be enforced by the provider regardless of the limits requested
1796 by the LDAP Content Synchronization operation, much like for any other
1799 The LDAP Content Synchronization protocol has two operation types.
1802 operation, the next synchronization search operation
1803 is periodically rescheduled at an interval time (specified by
1805 parameter; 1 day by default)
1806 after each synchronization operation finishes.
1808 .B refreshAndPersist
1809 operation, a synchronization search remains persistent in the provider slapd.
1810 Further updates to the master replica will generate
1811 .B searchResultEntry
1812 to the consumer slapd as the search responses to the persistent
1813 synchronization search.
1815 If an error occurs during replication, the consumer will attempt to
1816 reconnect according to the
1818 parameter which is a list of the <retry interval> and <# of retries> pairs.
1819 For example, retry="60 10 300 3" lets the consumer retry every 60 seconds
1820 for the first 10 times and then retry every 300 seconds for the next 3
1821 times before stop retrying. The `+' in <# of retries> means indefinite
1822 number of retries until success.
1825 was specified, by default syncrepl retries every hour forever.
1827 The schema checking can be enforced at the LDAP Sync
1828 consumer site by turning on the
1830 parameter. The default is \fBoff\fP.
1831 Schema checking \fBon\fP means that replicated entries must have
1832 a structural objectClass, must obey to objectClass requirements
1833 in terms of required/allowed attributes, and that naming attributes
1834 and distinguished values must be present.
1835 As a consequence, schema checking should be \fBoff\fP when partial
1836 replication is used.
1840 parameter sets how long the consumer will wait to establish a
1841 network connection to the provider. Once a connection is
1844 parameter determines how long the consumer will wait for the initial
1845 Bind request to complete. The defaults for these parameters come
1853 requires the options
1857 and should only be used when adequate security services
1858 (e.g. TLS or IPSEC) are in place.
1859 .B REMEMBER: simple bind credentials must be in cleartext!
1866 Depending on the mechanism, an authentication identity and/or
1867 credentials can be specified using
1873 parameter may be used to specify an authorization identity.
1874 Specific security properties (as with the
1876 keyword above) for a SASL bind can be set with the
1878 option. A non default SASL realm can be set with the
1881 The identity used for synchronization by the consumer should be allowed
1882 to receive an unlimited number of entries in response to a search request.
1883 The provider, other than allow authentication of the syncrepl identity,
1884 should grant that identity appropriate access privileges to the data
1885 that is being replicated (\fBaccess\fP directive), and appropriate time
1887 This can be accomplished by either allowing unlimited \fBsizelimit\fP
1888 and \fBtimelimit\fP, or by setting an appropriate \fBlimits\fP statement
1889 in the consumer's configuration (see \fBsizelimit\fP and \fBlimits\fP
1894 parameter sets the values of \fIidle\fP, \fIprobes\fP, and \fIinterval\fP
1895 used to check whether a socket is alive;
1897 is the number of seconds a connection needs to remain idle before TCP
1898 starts sending keepalive probes;
1900 is the maximum number of keepalive probes TCP should send before dropping
1903 is interval in seconds between individual keepalive probes.
1904 Only some systems support the customization of these values;
1907 parameter is ignored otherwise, and system-wide settings are used.
1911 parameter specifies use of the StartTLS extended operation
1912 to establish a TLS session before Binding to the provider. If the
1914 argument is supplied, the session will be aborted if the StartTLS request
1915 fails. Otherwise the syncrepl session continues without TLS. The
1916 tls_reqcert setting defaults to "demand" and the other TLS settings
1917 default to the same as the main slapd TLS settings.
1921 parameter allows the consumer to pull entries from a remote directory
1922 whose DN suffix differs from the local directory. The portion of the
1923 remote entries' DNs that matches the \fIsearchbase\fP will be replaced
1924 with the suffixmassage DN.
1926 Rather than replicating whole entries, the consumer can query logs of
1927 data modifications. This mode of operation is referred to as \fIdelta
1928 syncrepl\fP. In addition to the above parameters, the
1932 parameters must be set appropriately for the log that will be used. The
1934 parameter must be set to either "accesslog" if the log conforms to the
1935 .BR slapo\-accesslog (5)
1936 log format, or "changelog" if the log conforms
1937 to the obsolete \fIchangelog\fP format. If the
1939 parameter is omitted or set to "default" then the log parameters are
1944 This option is only applicable in a slave
1946 It specifies the DN permitted to update (subject to access controls)
1947 the replica. It is only needed in certain push-mode
1948 replication scenarios. Generally, this DN
1955 Specify the referral to pass back when
1957 is asked to modify a replicated local database.
1958 If specified multiple times, each url is provided.
1960 .SH DATABASE-SPECIFIC OPTIONS
1961 Each database may allow specific configuration options; they are
1962 documented separately in the backends' manual pages. See the
1963 .BR slapd.backends (5)
1964 manual page for an overview of available backends.
1967 Here is a short example of a configuration file:
1971 include SYSCONFDIR/schema/core.schema
1972 pidfile LOCALSTATEDIR/run/slapd.pid
1974 # Subtypes of "name" (e.g. "cn" and "ou") with the
1975 # option ";x\-hidden" can be searched for/compared,
1976 # but are not shown. See \fBslapd.access\fP(5).
1977 attributeoptions x\-hidden lang\-
1978 access to attrs=name;x\-hidden by * =cs
1980 # Protect passwords. See \fBslapd.access\fP(5).
1981 access to attrs=userPassword by * auth
1982 # Read access to other attributes and entries.
1983 access to * by * read
1986 suffix "dc=our\-domain,dc=com"
1987 # The database directory MUST exist prior to
1988 # running slapd AND should only be accessible
1989 # by the slapd/tools. Mode 0700 recommended.
1990 directory LOCALSTATEDIR/openldap\-data
1991 # Indices to maintain
1992 index objectClass eq
1993 index cn,sn,mail pres,eq,approx,sub
1995 # We serve small clients that do not handle referrals,
1996 # so handle remote lookups on their behalf.
1999 uri ldap://ldap.some\-server.com/
2004 "OpenLDAP Administrator's Guide" contains a longer annotated
2005 example of a configuration file.
2006 The original ETCDIR/slapd.conf is another example.
2010 default slapd configuration file
2013 .BR gnutls\-cli (1),
2014 .BR slapd\-config (5),
2015 .BR slapd.access (5),
2016 .BR slapd.backends (5),
2017 .BR slapd.overlays (5),
2018 .BR slapd.plugin (5),
2019 .BR slapd.replog (5),
2030 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
2031 .SH ACKNOWLEDGEMENTS