1 .TH SLAPD.CONF 5 "RELEASEDATE" "OpenLDAP LDVERSION"
2 .\" Copyright 1998-2013 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_hash64 { on | off }
499 Use a 64 bit hash for indexing. The default is to use 32 bit hashes.
500 These hashes are used for equality and substring indexing. The 64 bit
501 version may be needed to avoid index collisions when the number of
502 indexed values exceeds ~64 million. (Note that substring indexing
503 generates multiple index values per actual attribute value.)
504 Indices generated with 32 bit hashes are incompatible with the 64 bit
505 version, and vice versa. Any existing databases must be fully reloaded
506 when changing this setting. This directive is only supported on 64 bit CPUs.
508 .B index_intlen <integer>
509 Specify the key length for ordered integer indices. The most significant
510 bytes of the binary integer will be used for index keys. The default
511 value is 4, which provides exact indexing for 31 bit values.
512 A floating point representation is used to index too large values.
514 .B index_substr_if_minlen <integer>
515 Specify the minimum length for subinitial and subfinal indices. An
516 attribute value must have at least this many characters in order to be
517 processed by the indexing functions. The default is 2.
519 .B index_substr_if_maxlen <integer>
520 Specify the maximum length for subinitial and subfinal indices. Only
521 this many characters of an attribute value will be processed by the
522 indexing functions; any excess characters are ignored. The default is 4.
524 .B index_substr_any_len <integer>
525 Specify the length used for subany indices. An attribute value must have
526 at least this many characters in order to be processed. Attribute values
527 longer than this length will be processed in segments of this length. The
528 default is 4. The subany index will also be used in subinitial and
529 subfinal index lookups when the filter string is longer than the
530 .I index_substr_if_maxlen
533 .B index_substr_any_step <integer>
534 Specify the steps used in subany index lookups. This value sets the offset
535 for the segments of a filter string that are processed for a subany index
536 lookup. The default is 2. For example, with the default values, a search
537 using this filter "cn=*abcdefgh*" would generate index lookups for
538 "abcd", "cdef", and "efgh".
541 Note: Indexing support depends on the particular backend in use. Also,
542 changing these settings will generally require deleting any indices that
543 depend on these parameters and recreating them with
548 .B ldapsyntax "(\ <oid>\
549 [DESC\ <description>]\
550 [X\-SUBST <substitute-syntax>]\ )"
552 Specify an LDAP syntax using the LDAPv3 syntax defined in RFC 4512.
553 The slapd parser extends the RFC 4512 definition by allowing string
554 forms as well as numeric OIDs to be used for the syntax OID.
558 The slapd parser also honors the
560 extension (an OpenLDAP-specific extension), which allows to use the
562 statement to define a non-implemented syntax along with another syntax,
564 .IR substitute-syntax ,
565 as its temporary replacement.
569 This allows to define attribute types that make use of non-implemented syntaxes
570 using the correct syntax OID.
573 is used, this configuration statement would result in an error,
574 since no handlers would be associated to the resulting syntax structure.
578 .B listener-threads <integer>
579 Specify the number of threads to use for the connection manager.
580 The default is 1 and this is typically adequate for up to 16 CPU cores.
581 The value should be set to a power of 2.
584 Specifies the Security Strength Factor (SSF) to be given local LDAP sessions,
585 such as those to the ldapi:// listener. For a description of SSF values,
589 option description. The default is 71.
591 .B logfile <filename>
592 Specify a file for recording debug log messages. By default these messages
593 only go to stderr and are not recorded anywhere else. Specifying a logfile
594 copies messages to both stderr and the logfile.
596 .B loglevel <integer> [...]
597 Specify the level at which debugging statements and operation
598 statistics should be syslogged (currently logged to the
600 LOG_LOCAL4 facility).
601 They must be considered subsystems rather than increasingly verbose
603 Some messages with higher priority are logged regardless
604 of the configured loglevel as soon as any logging is configured.
605 Log levels are additive, and available levels are:
616 debug packet handling
620 heavy trace debugging (function args)
624 connection management
628 print out packets sent and received
632 search filter processing
636 configuration file processing
640 access control list processing
644 connections, LDAP operations, results (recommended)
648 stats log entries sent
652 print communication with shell backends
664 \"data indexing (unused)
672 only messages that get logged whatever log level is set
675 The desired log level can be input as a single integer that combines
676 the (ORed) desired levels, both in decimal or in hexadecimal notation,
677 as a list of integers (that are ORed internally),
678 or as a list of the names that are shown between brackets, such that
691 can be used as a shortcut to enable logging at all levels (equivalent to \-1).
694 or the equivalent integer representation, causes those messages
695 that are logged regardless of the configured loglevel to be logged.
696 In fact, if loglevel is set to 0, no logging occurs,
699 level is required to have high priority messages logged.
701 The loglevel defaults to \fBstats\fP.
702 This level should usually also be included when using other loglevels, to
703 help analyze the logs.
706 .B moduleload <filename>
707 Specify the name of a dynamically loadable module to load. The filename
708 may be an absolute path name or a simple filename. Non-absolute names
709 are searched for in the directories specified by the
711 option. This option and the
713 option are only usable if slapd was compiled with \-\-enable\-modules.
715 .B modulepath <pathspec>
716 Specify a list of directories to search for loadable modules. Typically
717 the path is colon-separated but this depends on the operating system.
718 The default is MODULEDIR, which is where the standard OpenLDAP install
719 will place its modules.
722 .B objectclass "(\ <oid>\
724 [DESC\ <description>]\
727 [{ ABSTRACT | STRUCTURAL | AUXILIARY }]\
728 [MUST\ <oids>] [MAY\ <oids>] )"
730 Specify an objectclass using the LDAPv3 syntax defined in RFC 4512.
731 The slapd parser extends the RFC 4512 definition by allowing string
732 forms as well as numeric OIDs to be used for the object class OID.
736 description.) Object classes are "STRUCTURAL" by default.
739 .B objectidentifier <name> "{ <oid> | <name>[:<suffix>] }"
740 Define a string name that equates to the given OID. The string can be used
741 in place of the numeric OID in objectclass and attribute definitions. The
742 name can also be used with a suffix of the form ":xx" in which case the
743 value "oid.xx" will be used.
745 .B password\-hash <hash> [<hash>...]
746 This option configures one or more hashes to be used in generation of user
747 passwords stored in the userPassword attribute during processing of
748 LDAP Password Modify Extended Operations (RFC 3062).
749 The <hash> must be one of
763 use the SHA-1 algorithm (FIPS 160-1), the latter with a seed.
768 use the MD5 algorithm (RFC 1321), the latter with a seed.
775 indicates that the new password should be
776 added to userPassword as clear text.
778 Note that this option does not alter the normal user applications
779 handling of userPassword during LDAP Add, Modify, or other LDAP operations.
781 .B password\-crypt\-salt\-format <format>
782 Specify the format of the salt passed to
784 when generating {CRYPT} passwords (see
786 during processing of LDAP Password Modify Extended Operations (RFC 3062).
788 This string needs to be in
790 format and may include one (and only one) %s conversion.
791 This conversion will be substituted with a string of random
792 characters from [A\-Za\-z0\-9./]. For example, "%.2s"
793 provides a two character salt and "$1$%.8s" tells some
794 versions of crypt(3) to use an MD5 algorithm and provides
795 8 random characters of salt. The default is "%s", which
796 provides 31 characters of salt.
798 .B pidfile <filename>
799 The (absolute) name of a file that will hold the
801 server's process ID (see
805 Specify the referral to pass back when
807 cannot find a local database to handle a request.
808 If specified multiple times, each url is provided.
810 .B require <conditions>
811 Specify a set of conditions (separated by white space) to
812 require (default none).
813 The directive may be specified globally and/or per-database;
814 databases inherit global conditions, so per-database specifications
817 requires bind operation prior to directory operations.
819 requires session to be using LDAP version 3.
821 requires authentication prior to directory operations.
823 requires SASL authentication prior to directory operations.
825 requires strong authentication prior to directory operations.
826 The strong keyword allows protected "simple" authentication
827 as well as SASL authentication.
829 may be used to require no conditions (useful to clear out globally
830 set conditions within a particular database); it must occur first
831 in the list of conditions.
833 .B reverse\-lookup on | off
834 Enable/disable client name unverified reverse lookup (default is
836 if compiled with \-\-enable\-rlookups).
839 Specify the name of an LDIF(5) file containing user defined attributes
840 for the root DSE. These attributes are returned in addition to the
841 attributes normally produced by slapd.
843 The root DSE is an entry with information about the server and its
844 capabilities, in operational attributes.
845 It has the empty DN, and can be read with e.g.:
847 ldapsearch \-x \-b "" \-s base "+"
849 See RFC 4512 section 5.1 for details.
851 .B sasl\-auxprops <plugin> [...]
852 Specify which auxprop plugins to use for authentication lookups. The
853 default is empty, which just uses slapd's internal support. Usually
854 no other auxprop plugins are needed.
857 Used to specify the fully qualified domain name used for SASL processing.
859 .B sasl\-realm <realm>
860 Specify SASL realm. Default is empty.
862 .B sasl\-secprops <properties>
863 Used to specify Cyrus SASL security properties.
866 flag (without any other properties) causes the flag properties
867 default, "noanonymous,noplain", to be cleared.
870 flag disables mechanisms susceptible to simple passive attacks.
873 flag disables mechanisms susceptible to active attacks.
876 flag disables mechanisms susceptible to passive dictionary attacks.
879 flag disables mechanisms which support anonymous login.
882 flag require forward secrecy between sessions.
885 require mechanisms which pass client credentials (and allow
886 mechanisms which can pass credentials to do so).
889 property specifies the minimum acceptable
890 .I security strength factor
891 as an integer approximate to effective key length used for
892 encryption. 0 (zero) implies no protection, 1 implies integrity
893 protection only, 56 allows DES or other weak ciphers, 112
894 allows triple DES and other strong ciphers, 128 allows RC4,
895 Blowfish and other modern strong ciphers. The default is 0.
898 property specifies the maximum acceptable
899 .I security strength factor
900 as an integer (see minssf description). The default is INT_MAX.
903 property specifies the maximum security layer receive buffer
904 size allowed. 0 disables security layers. The default is 65536.
907 Specify the distinguished name for the subschema subentry that
908 controls the entries on this server. The default is "cn=Subschema".
910 .B security <factors>
911 Specify a set of security strength factors (separated by white space)
913 .BR sasl\-secprops 's
915 option for a description of security strength factors).
916 The directive may be specified globally and/or per-database.
918 specifies the overall security strength factor.
920 specifies the transport security strength factor.
922 specifies the TLS security strength factor.
924 specifies the SASL security strength factor.
926 specifies the overall security strength factor to require for
928 .B update_transport=<n>
929 specifies the transport security strength factor to require for
932 specifies the TLS security strength factor to require for
935 specifies the SASL security strength factor to require for
938 specifies the security strength factor required for
940 username/password authentication.
943 factor is measure of security provided by the underlying transport,
944 e.g. ldapi:// (and eventually IPSEC). It is not normally used.
946 .B serverID <integer> [<URL>]
947 Specify an integer ID from 0 to 4095 for this server (limited
948 to 3 hexadecimal digits). The ID may also be specified as a
949 hexadecimal ID by prefixing the value with "0x".
951 required when using multimaster replication and each master must have a
952 unique ID. Note that this requirement also applies to separate masters
953 contributing to a glued set of databases.
954 If the URL is provided, this directive may be specified
955 multiple times, providing a complete list of participating servers
956 and their IDs. The fully qualified hostname of each server should be
957 used in the supplied URLs. The IDs are used in the "replica id" field
958 of all CSNs generated by the specified server. The default value is zero.
965 .B sizelimit {<integer>|unlimited}
967 .B sizelimit size[.{soft|hard|unchecked}]=<integer> [...]
968 Specify the maximum number of entries to return from a search operation.
969 The default size limit is 500.
972 to specify no limits.
973 The second format allows a fine grain setting of the size limits.
974 Extra args can be added on the same line.
977 for an explanation of the different flags.
979 .B sockbuf_max_incoming <integer>
980 Specify the maximum incoming LDAP PDU size for anonymous sessions.
981 The default is 262143.
983 .B sockbuf_max_incoming_auth <integer>
984 Specify the maximum incoming LDAP PDU size for authenticated sessions.
985 The default is 4194303.
987 .B sortvals <attr> [...]
988 Specify a list of multi-valued attributes whose values will always
989 be maintained in sorted order. Using this option will allow Modify,
990 Compare, and filter evaluations on these attributes to be performed
991 more efficiently. The resulting sort order depends on the
992 attributes' syntax and matching rules and may not correspond to
993 lexical order or any other recognizable order.
995 .B tcp-buffer [listener=<URL>] [{read|write}=]<size>
996 Specify the size of the TCP buffer.
997 A global value for both read and write TCP buffers related to any listener
998 is defined, unless the listener is explicitly specified,
999 or either the read or write qualifiers are used.
1003 Note that some OS-es implement automatic TCP buffer tuning.
1005 .B threads <integer>
1006 Specify the maximum size of the primary thread pool.
1007 The default is 16; the minimum value is 2.
1009 .B timelimit {<integer>|unlimited}
1011 .B timelimit time[.{soft|hard}]=<integer> [...]
1012 Specify the maximum number of seconds (in real time)
1014 will spend answering a search request. The default time limit is 3600.
1017 to specify no limits.
1018 The second format allows a fine grain setting of the time limits.
1019 Extra args can be added on the same line.
1022 for an explanation of the different flags.
1024 .B tool\-threads <integer>
1025 Specify the maximum number of threads to use in tool mode.
1026 This should not be greater than the number of CPUs in the system.
1028 .\"ucdata-path is obsolete / ignored...
1030 .\".B ucdata-path <path>
1031 .\"Specify the path to the directory containing the Unicode character
1032 .\"tables. The default path is DATADIR/ucdata.
1034 .B writetimeout <integer>
1035 Specify the number of seconds to wait before forcibly closing
1036 a connection with an outstanding write. This allows recovery from
1037 various network hang conditions. A writetimeout of 0 disables this
1038 feature. The default is 0.
1042 is built with support for Transport Layer Security, there are more options
1045 .B TLSCipherSuite <cipher-suite-spec>
1046 Permits configuring what ciphers will be accepted and the preference order.
1047 <cipher-suite-spec> should be a cipher specification for the TLS library
1048 in use (OpenSSL, GnuTLS, or Mozilla NSS).
1054 TLSCipherSuite HIGH:MEDIUM:+SSLv2
1057 TLSCiphersuite SECURE256:!AES-128-CBC
1060 To check what ciphers a given spec selects in OpenSSL, use:
1063 openssl ciphers \-v <cipher-suite-spec>
1066 With GnuTLS the available specs can be found in the manual page of
1068 (see the description of the
1072 In older versions of GnuTLS, where gnutls\-cli does not support the option
1073 \-\-priority, you can obtain the \(em more limited \(em list of ciphers by calling:
1079 When using Mozilla NSS, the OpenSSL cipher suite specifications are used and
1080 translated into the format used internally by Mozilla NSS. There isn't an easy
1081 way to list the cipher suites from the command line. The authoritative list
1082 is in the source code for Mozilla NSS in the file sslinfo.c in the structure
1084 static const SSLCipherSuiteInfo suiteInfo[]
1088 .B TLSCACertificateFile <filename>
1089 Specifies the file that contains certificates for all of the Certificate
1092 will recognize. The certificate for
1093 the CA that signed the server certificate must be included among
1094 these certificates. If the signing CA was not a top-level (root) CA,
1095 certificates for the entire sequence of CA's from the signing CA to
1096 the top-level CA should be present. Multiple certificates are simply
1097 appended to the file; the order is not significant.
1099 .B TLSCACertificatePath <path>
1100 Specifies the path of a directory that contains Certificate Authority
1101 certificates in separate individual files. Usually only one of this
1102 or the TLSCACertificateFile is used. This directive is not supported
1105 When using Mozilla NSS, <path> may contain a Mozilla NSS cert/key
1106 database. If <path> contains a Mozilla NSS cert/key database and
1107 CA cert files, OpenLDAP will use the cert/key database and will
1108 ignore the CA cert files.
1110 .B TLSCertificateFile <filename>
1111 Specifies the file that contains the
1115 When using Mozilla NSS, if using a cert/key database (specified with
1116 TLSCACertificatePath), TLSCertificateFile specifies
1117 the name of the certificate to use:
1119 TLSCertificateFile Server-Cert
1121 If using a token other than the internal built in token, specify the
1122 token name first, followed by a colon:
1124 TLSCertificateFile my hardware device:Server-Cert
1126 Use certutil -L to list the certificates by name:
1128 certutil -d /path/to/certdbdir -L
1131 .B TLSCertificateKeyFile <filename>
1132 Specifies the file that contains the
1134 server private key that matches the certificate stored in the
1135 .B TLSCertificateFile
1136 file. Currently, the private key must not be protected with a password, so
1137 it is of critical importance that it is protected carefully.
1139 When using Mozilla NSS, TLSCertificateKeyFile specifies the name of
1140 a file that contains the password for the key for the certificate specified with
1141 TLSCertificateFile. The modutil command can be used to turn off password
1142 protection for the cert/key database. For example, if TLSCACertificatePath
1143 specifes /etc/openldap/certdb as the location of the cert/key database, use
1144 modutil to change the password to the empty string:
1146 modutil -dbdir /etc/openldap/certdb -changepw 'NSS Certificate DB'
1148 You must have the old password, if any. Ignore the WARNING about the running
1149 browser. Press 'Enter' for the new password.
1151 .B TLSDHParamFile <filename>
1152 This directive specifies the file that contains parameters for Diffie-Hellman
1153 ephemeral key exchange. This is required in order to use a DSA certificate on
1154 the server. If multiple sets of parameters are present in the file, all of
1155 them will be processed. Note that setting this option may also enable
1156 Anonymous Diffie-Hellman key exchanges in certain non-default cipher suites.
1157 You should append "!ADH" to your cipher suites if you have changed them
1158 from the default, otherwise no certificate exchanges or verification will
1159 be done. When using GnuTLS these parameters are always generated randomly so
1160 this directive is ignored. This directive is ignored when using Mozilla NSS.
1162 .B TLSProtocolMin <major>[.<minor>]
1163 Specifies minimum SSL/TLS protocol version that will be negotiated.
1164 If the server doesn't support at least that version,
1165 the SSL handshake will fail.
1166 To require TLS 1.x or higher, set this option to 3.(x+1),
1173 would require TLS 1.1.
1174 Specifying a minimum that is higher than that supported by the
1175 OpenLDAP implementation will result in it requiring the
1176 highest level that it does support.
1177 This directive is ignored with GnuTLS.
1179 .B TLSRandFile <filename>
1180 Specifies the file to obtain random bits from when /dev/[u]random
1181 is not available. Generally set to the name of the EGD/PRNGD socket.
1182 The environment variable RANDFILE can also be used to specify the filename.
1183 This directive is ignored with GnuTLS and Mozilla NSS.
1185 .B TLSVerifyClient <level>
1186 Specifies what checks to perform on client certificates in an
1187 incoming TLS session, if any.
1190 can be specified as one of the following keywords:
1194 This is the default.
1196 will not ask the client for a certificate.
1199 The client certificate is requested. If no certificate is provided,
1200 the session proceeds normally. If a bad certificate is provided,
1201 it will be ignored and the session proceeds normally.
1204 The client certificate is requested. If no certificate is provided,
1205 the session proceeds normally. If a bad certificate is provided,
1206 the session is immediately terminated.
1208 .B demand | hard | true
1209 These keywords are all equivalent, for compatibility reasons.
1210 The client certificate is requested. If no certificate is provided,
1211 or a bad certificate is provided, the session is immediately terminated.
1213 Note that a valid client certificate is required in order to use the
1214 SASL EXTERNAL authentication mechanism with a TLS session. As such,
1217 setting must be chosen to enable SASL EXTERNAL authentication.
1220 .B TLSCRLCheck <level>
1221 Specifies if the Certificate Revocation List (CRL) of the CA should be
1222 used to verify if the client certificates have not been revoked. This
1224 .B TLSCACertificatePath
1225 parameter to be set. This directive is ignored with GnuTLS and Mozilla NSS.
1227 can be specified as one of the following keywords:
1231 No CRL checks are performed
1234 Check the CRL of the peer certificate
1237 Check the CRL for a whole certificate chain
1240 .B TLSCRLFile <filename>
1241 Specifies a file containing a Certificate Revocation List to be used
1242 for verifying that certificates have not been revoked. This directive is
1243 only valid when using GnuTLS and Mozilla NSS.
1244 .SH GENERAL BACKEND OPTIONS
1245 Options in this section only apply to the configuration file section
1246 for the specified backend. They are supported by every
1249 .B backend <databasetype>
1250 Mark the beginning of a backend definition. <databasetype>
1267 depending on which backend will serve the database.
1269 .SH GENERAL DATABASE OPTIONS
1270 Options in this section only apply to the configuration file section
1271 for the database in which they are defined. They are supported by every
1272 type of backend. Note that the
1276 option are mandatory for each database.
1278 .B database <databasetype>
1279 Mark the beginning of a new database instance definition. <databasetype>
1296 depending on which backend will serve the database.
1298 LDAP operations, even subtree searches, normally access only one
1300 That can be changed by gluing databases together with the
1303 Access controls and some overlays can also involve multiple databases.
1305 .B add_content_acl on | off
1306 Controls whether Add operations will perform ACL checks on
1307 the content of the entry being added. This check is off
1309 .BR slapd.access (5)
1310 manual page for more details on ACL requirements for
1313 .B extra_attrs <attrlist>
1314 Lists what attributes need to be added to search requests.
1315 Local storage backends return the entire entry to the frontend.
1316 The frontend takes care of only returning the requested attributes
1317 that are allowed by ACLs.
1318 However, features like access checking and so may need specific
1319 attributes that are not automatically returned by remote storage
1320 backends, like proxy backends and so on.
1322 is a list of attributes that are needed for internal purposes
1323 and thus always need to be collected, even when not explicitly
1324 requested by clients.
1327 Controls whether the database will be used to answer
1328 queries. A database that is hidden will never be
1329 selected to answer any queries, and any suffix configured
1330 on the database will be ignored in checks for conflicts
1331 with other databases. By default, hidden is off.
1336 will automatically maintain the
1337 modifiersName, modifyTimestamp, creatorsName, and
1338 createTimestamp attributes for entries. It also controls
1339 the entryCSN and entryUUID attributes, which are needed
1340 by the syncrepl provider. By default, lastmod is on.
1342 .B limits <selector> <limit> [<limit> [...]]
1343 Specify time and size limits based on the operation's initiator or
1351 anonymous | users | [<dnspec>=]<pattern> | group[/oc[/at]]=<pattern>
1357 <dnspec> ::= dn[.<type>][.<style>]
1359 <type> ::= self | this
1361 <style> ::= exact | base | onelevel | subtree | children | regex | anonymous
1366 is the default and means the bound user, while
1368 means the base DN of the operation.
1371 matches all unauthenticated clients.
1374 matches all authenticated clients;
1377 dn pattern is assumed unless otherwise specified by qualifying
1378 the (optional) key string
1384 (which are synonyms), to require an exact match; with
1386 to require exactly one level of depth match; with
1388 to allow any level of depth match, including the exact match; with
1390 to allow any level of depth match, not including the exact match;
1392 explicitly requires the (default) match based on POSIX (''extended'')
1393 regular expression pattern.
1396 matches unbound operations; the
1399 The same behavior is obtained by using the
1406 with the optional objectClass
1412 sets the limits for any DN listed in the values of the
1418 group objectClass (default
1420 whose DN exactly matches
1423 The currently supported limits are
1428 The syntax for time limits is
1429 .BR time[.{soft|hard}]=<integer> ,
1432 is the number of seconds slapd will spend answering a search request.
1433 If no time limit is explicitly requested by the client, the
1435 limit is used; if the requested time limit exceeds the
1438 .\".I "Administrative limit exceeded"
1439 .\"error is returned.
1440 limit, the value of the limit is used instead.
1443 limit is set to the keyword
1445 the soft limit is used in either case; if it is set to the keyword
1447 no hard limit is enforced.
1448 Explicit requests for time limits smaller or equal to the
1451 If no limit specifier is set, the value is assigned to the
1457 to preserve the original behavior.
1459 The syntax for size limits is
1460 .BR size[.{soft|hard|unchecked}]=<integer> ,
1463 is the maximum number of entries slapd will return answering a search
1465 If no size limit is explicitly requested by the client, the
1467 limit is used; if the requested size limit exceeds the
1470 .\".I "Administrative limit exceeded"
1471 .\"error is returned.
1472 limit, the value of the limit is used instead.
1475 limit is set to the keyword
1477 the soft limit is used in either case; if it is set to the keyword
1479 no hard limit is enforced.
1480 Explicit requests for size limits smaller or equal to the
1485 specifier sets a limit on the number of candidates a search request is allowed
1487 The rationale behind it is that searches for non-properly indexed
1488 attributes may result in large sets of candidates, which must be
1491 to determine whether they match the search filter or not.
1494 limit provides a means to drop such operations before they are even
1496 If the selected candidates exceed the
1498 limit, the search will abort with
1499 .IR "Unwilling to perform" .
1500 If it is set to the keyword
1502 no limit is applied (the default).
1505 the search is not even performed; this can be used to disallow searches
1506 for a specific set of users.
1507 If no limit specifier is set, the value is assigned to the
1513 to preserve the original behavior.
1515 In case of no match, the global limits are used.
1516 The default values are the same as for
1525 control is requested, the
1527 size limit is used by default, because the request of a specific page size
1528 is considered an explicit request for a limitation on the number
1529 of entries to be returned.
1530 However, the size limit applies to the total count of entries returned within
1531 the search, and not to a single page.
1532 Additional size limits may be enforced; the syntax is
1533 .BR size.pr={<integer>|noEstimate|unlimited} ,
1536 is the max page size if no explicit limit is set; the keyword
1538 inhibits the server from returning an estimate of the total number
1539 of entries that might be returned
1540 (note: the current implementation does not return any estimate).
1543 indicates that no limit is applied to the pagedResults control page size.
1545 .B size.prtotal={<integer>|unlimited|disabled}
1546 allows to set a limit on the total number of entries that a pagedResults
1547 control allows to return.
1548 By default it is set to the
1553 is the max number of entries that the whole search with pagedResults control
1557 to allow unlimited number of entries to be returned, e.g. to allow
1558 the use of the pagedResults control as a means to circumvent size
1559 limitations on regular searches; the keyword
1561 disables the control, i.e. no paged results can be returned.
1562 Note that the total number of entries returned when the pagedResults control
1563 is requested cannot exceed the
1565 size limit of regular searches unless extended by the
1569 The \fBlimits\fP statement is typically used to let an unlimited
1570 number of entries be returned by searches performed
1571 with the identity used by the consumer for synchronization purposes
1572 by means of the RFC 4533 LDAP Content Synchronization protocol
1573 (see \fBsyncrepl\fP for details).
1576 .B maxderefdepth <depth>
1577 Specifies the maximum number of aliases to dereference when trying to
1578 resolve an entry, used to avoid infinite alias loops. The default is 15.
1580 .B mirrormode on | off
1581 This option puts a replica database into "mirror" mode. Update
1582 operations will be accepted from any user, not just the updatedn. The
1583 database must already be configured as a syncrepl consumer
1584 before this keyword may be set. This mode also requires a
1586 (see above) to be configured.
1587 By default, mirrormode is off.
1589 .B monitoring on | off
1590 This option enables database-specific monitoring in the entry related
1591 to the current database in the "cn=Databases,cn=Monitor" subtree
1592 of the monitor database, if the monitor database is enabled.
1593 Currently, only the BDB and the HDB databases provide database-specific
1595 The default depends on the backend type.
1597 .B overlay <overlay-name>
1598 Add the specified overlay to this database. An overlay is a piece of
1599 code that intercepts database operations in order to extend or change
1600 them. Overlays are pushed onto
1601 a stack over the database, and so they will execute in the reverse
1602 of the order in which they were configured and the database itself
1603 will receive control last of all. See the
1604 .BR slapd.overlays (5)
1605 manual page for an overview of the available overlays.
1606 Note that all of the database's
1607 regular settings should be configured before any overlay settings.
1609 .B readonly on | off
1610 This option puts the database into "read-only" mode. Any attempts to
1611 modify the database will return an "unwilling to perform" error. By
1612 default, readonly is off.
1614 .B restrict <oplist>
1615 Specify a whitespace separated list of operations that are restricted.
1616 If defined inside a database specification, restrictions apply only
1617 to that database, otherwise they are global.
1618 Operations can be any of
1623 .BR extended[=<OID>] ,
1627 or the special pseudo-operations
1631 which respectively summarize read and write operations.
1639 keyword allows to indicate the OID of the specific operation
1643 Specify the distinguished name that is not subject to access control
1644 or administrative limit restrictions for operations on this database.
1645 This DN may or may not be associated with an entry. An empty root
1646 DN (the default) specifies no root access is to be granted. It is
1647 recommended that the rootdn only be specified when needed (such as
1648 when initially populating a database). If the rootdn is within
1649 a namingContext (suffix) of the database, a simple bind password
1650 may also be provided using the
1652 directive. Many optional features, including syncrepl, require the
1653 rootdn to be defined for the database.
1655 .B rootpw <password>
1656 Specify a password (or hash of the password) for the rootdn. The
1657 password can only be set if the rootdn is within the namingContext
1658 (suffix) of the database.
1659 This option accepts all RFC 2307 userPassword formats known to
1662 description) as well as cleartext.
1664 may be used to generate a hash of a password. Cleartext
1665 and \fB{CRYPT}\fP passwords are not recommended. If empty
1666 (the default), authentication of the root DN is by other means
1667 (e.g. SASL). Use of SASL is encouraged.
1669 .B suffix <dn suffix>
1670 Specify the DN suffix of queries that will be passed to this
1671 backend database. Multiple suffix lines can be given and at least one is
1672 required for each database definition.
1674 If the suffix of one database is "inside" that of another, the database
1675 with the inner suffix must come first in the configuration file.
1676 You may also want to glue such databases together with the
1680 .B subordinate [advertise]
1681 Specify that the current backend database is a subordinate of another
1682 backend database. A subordinate database may have only one suffix. This
1683 option may be used to glue multiple databases into a single namingContext.
1684 If the suffix of the current database is within the namingContext of a
1685 superior database, searches against the superior database will be
1686 propagated to the subordinate as well. All of the databases
1687 associated with a single namingContext should have identical rootdns.
1688 Behavior of other LDAP operations is unaffected by this setting. In
1689 particular, it is not possible to use moddn to move an entry from
1690 one subordinate to another subordinate within the namingContext.
1692 If the optional \fBadvertise\fP flag is supplied, the naming context of
1693 this database is advertised in the root DSE. The default is to hide this
1694 database context, so that only the superior context is visible.
1701 are used on the superior database, any glued subordinates that support
1702 these tools are opened as well.
1704 Databases that are glued together should usually be configured with the
1705 same indices (assuming they support indexing), even for attributes that
1706 only exist in some of these databases. In general, all of the glued
1707 databases should be configured as similarly as possible, since the intent
1708 is to provide the appearance of a single directory.
1710 Note that the \fIsubordinate\fP functionality is implemented internally
1711 by the \fIglue\fP overlay and as such its behavior will interact with other
1712 overlays in use. By default, the glue overlay is automatically configured as
1713 the last overlay on the superior backend. Its position on the backend
1714 can be explicitly configured by setting an \fBoverlay glue\fP directive
1715 at the desired position. This explicit configuration is necessary e.g.
1716 when using the \fIsyncprov\fP overlay, which needs to follow \fIglue\fP
1717 in order to work over all of the glued databases. E.g.
1721 suffix dc=example,dc=com
1728 .B sync_use_subentry
1729 Store the syncrepl contextCSN in a subentry instead of the context entry
1730 of the database. The subentry's RDN will be "cn=ldapsync". By default
1731 the contextCSN is stored in the context entry.
1734 .B syncrepl rid=<replica ID>
1735 .B provider=ldap[s]://<hostname>[:port]
1736 .B searchbase=<base DN>
1737 .B [type=refreshOnly|refreshAndPersist]
1738 .B [interval=dd:hh:mm:ss]
1739 .B [retry=[<retry interval> <# of retries>]+]
1740 .B [filter=<filter str>]
1741 .B [scope=sub|one|base|subord]
1742 .B [attrs=<attr list>]
1744 .B [sizelimit=<limit>]
1745 .B [timelimit=<limit>]
1746 .B [schemachecking=on|off]
1747 .B [network\-timeout=<seconds>]
1748 .B [timeout=<seconds>]
1749 .B [bindmethod=simple|sasl]
1751 .B [saslmech=<mech>]
1752 .B [authcid=<identity>]
1753 .B [authzid=<identity>]
1754 .B [credentials=<passwd>]
1756 .B [secprops=<properties>]
1757 .B [keepalive=<idle>:<probes>:<interval>]
1758 .B [starttls=yes|critical]
1759 .B [tls_cert=<file>]
1761 .B [tls_cacert=<file>]
1762 .B [tls_cacertdir=<path>]
1763 .B [tls_reqcert=never|allow|try|demand]
1764 .B [tls_ciphersuite=<ciphers>]
1765 .B [tls_crlcheck=none|peer|all]
1766 .B [tls_protocol_min=<major>[.<minor>]]
1767 .B [suffixmassage=<real DN>]
1768 .B [logbase=<base DN>]
1769 .B [logfilter=<filter str>]
1770 .B [syncdata=default|accesslog|changelog]
1772 Specify the current database as a replica which is kept up-to-date with the
1773 master content by establishing the current
1775 as a replication consumer site running a
1778 The replica content is kept synchronized to the master content using
1779 the LDAP Content Synchronization protocol. Refer to the
1780 "OpenLDAP Administrator's Guide" for detailed information on
1781 setting up a replicated
1783 directory service using the
1788 identifies the current
1790 directive within the replication consumer site.
1791 It is a non-negative integer not greater than 999 (limited
1792 to three decimal digits).
1795 specifies the replication provider site containing the master content
1796 as an LDAP URI. If <port> is not given, the standard LDAP port number
1797 (389 or 636) is used.
1801 replica is defined using a search
1802 specification as its result set. The consumer
1804 will send search requests to the provider
1806 according to the search specification. The search specification includes
1807 .BR searchbase ", " scope ", " filter ", " attrs ", " attrsonly ", " sizelimit ", "
1810 parameters as in the normal search specification.
1811 The \fBscope\fP defaults to \fBsub\fP, the \fBfilter\fP defaults to
1812 \fB(objectclass=*)\fP, while there is no default \fBsearchbase\fP. The
1813 \fBattrs\fP list defaults to \fB"*,+"\fP to return all user and operational
1814 attributes, and \fBattrsonly\fP is unset by default.
1815 The \fBsizelimit\fP and \fBtimelimit\fP only
1816 accept "unlimited" and positive integers, and both default to "unlimited".
1817 The \fBsizelimit\fP and \fBtimelimit\fP parameters define
1818 a consumer requested limitation on the number of entries that can be returned
1819 by the LDAP Content Synchronization operation; as such, it is intended
1820 to implement partial replication based on the size of the replicated database
1821 and on the time required by the synchronization.
1822 Note, however, that any provider-side limits for the replication identity
1823 will be enforced by the provider regardless of the limits requested
1824 by the LDAP Content Synchronization operation, much like for any other
1827 The LDAP Content Synchronization protocol has two operation types.
1830 operation, the next synchronization search operation
1831 is periodically rescheduled at an interval time (specified by
1833 parameter; 1 day by default)
1834 after each synchronization operation finishes.
1836 .B refreshAndPersist
1837 operation, a synchronization search remains persistent in the provider slapd.
1838 Further updates to the master replica will generate
1839 .B searchResultEntry
1840 to the consumer slapd as the search responses to the persistent
1841 synchronization search.
1843 If an error occurs during replication, the consumer will attempt to
1844 reconnect according to the
1846 parameter which is a list of the <retry interval> and <# of retries> pairs.
1847 For example, retry="60 10 300 3" lets the consumer retry every 60 seconds
1848 for the first 10 times and then retry every 300 seconds for the next 3
1849 times before stop retrying. The `+' in <# of retries> means indefinite
1850 number of retries until success.
1853 was specified, by default syncrepl retries every hour forever.
1855 The schema checking can be enforced at the LDAP Sync
1856 consumer site by turning on the
1858 parameter. The default is \fBoff\fP.
1859 Schema checking \fBon\fP means that replicated entries must have
1860 a structural objectClass, must obey to objectClass requirements
1861 in terms of required/allowed attributes, and that naming attributes
1862 and distinguished values must be present.
1863 As a consequence, schema checking should be \fBoff\fP when partial
1864 replication is used.
1868 parameter sets how long the consumer will wait to establish a
1869 network connection to the provider. Once a connection is
1872 parameter determines how long the consumer will wait for the initial
1873 Bind request to complete. The defaults for these parameters come
1881 requires the options
1885 and should only be used when adequate security services
1886 (e.g. TLS or IPSEC) are in place.
1887 .B REMEMBER: simple bind credentials must be in cleartext!
1894 Depending on the mechanism, an authentication identity and/or
1895 credentials can be specified using
1901 parameter may be used to specify an authorization identity.
1902 Specific security properties (as with the
1904 keyword above) for a SASL bind can be set with the
1906 option. A non default SASL realm can be set with the
1909 The identity used for synchronization by the consumer should be allowed
1910 to receive an unlimited number of entries in response to a search request.
1911 The provider, other than allow authentication of the syncrepl identity,
1912 should grant that identity appropriate access privileges to the data
1913 that is being replicated (\fBaccess\fP directive), and appropriate time
1915 This can be accomplished by either allowing unlimited \fBsizelimit\fP
1916 and \fBtimelimit\fP, or by setting an appropriate \fBlimits\fP statement
1917 in the consumer's configuration (see \fBsizelimit\fP and \fBlimits\fP
1922 parameter sets the values of \fIidle\fP, \fIprobes\fP, and \fIinterval\fP
1923 used to check whether a socket is alive;
1925 is the number of seconds a connection needs to remain idle before TCP
1926 starts sending keepalive probes;
1928 is the maximum number of keepalive probes TCP should send before dropping
1931 is interval in seconds between individual keepalive probes.
1932 Only some systems support the customization of these values;
1935 parameter is ignored otherwise, and system-wide settings are used.
1939 parameter specifies use of the StartTLS extended operation
1940 to establish a TLS session before Binding to the provider. If the
1942 argument is supplied, the session will be aborted if the StartTLS request
1943 fails. Otherwise the syncrepl session continues without TLS. The
1944 tls_reqcert setting defaults to "demand" and the other TLS settings
1945 default to the same as the main slapd TLS settings.
1949 parameter allows the consumer to pull entries from a remote directory
1950 whose DN suffix differs from the local directory. The portion of the
1951 remote entries' DNs that matches the \fIsearchbase\fP will be replaced
1952 with the suffixmassage DN.
1954 Rather than replicating whole entries, the consumer can query logs of
1955 data modifications. This mode of operation is referred to as \fIdelta
1956 syncrepl\fP. In addition to the above parameters, the
1960 parameters must be set appropriately for the log that will be used. The
1962 parameter must be set to either "accesslog" if the log conforms to the
1963 .BR slapo\-accesslog (5)
1964 log format, or "changelog" if the log conforms
1965 to the obsolete \fIchangelog\fP format. If the
1967 parameter is omitted or set to "default" then the log parameters are
1972 This option is only applicable in a slave
1974 It specifies the DN permitted to update (subject to access controls)
1975 the replica. It is only needed in certain push-mode
1976 replication scenarios. Generally, this DN
1983 Specify the referral to pass back when
1985 is asked to modify a replicated local database.
1986 If specified multiple times, each url is provided.
1988 .SH DATABASE-SPECIFIC OPTIONS
1989 Each database may allow specific configuration options; they are
1990 documented separately in the backends' manual pages. See the
1991 .BR slapd.backends (5)
1992 manual page for an overview of available backends.
1995 Here is a short example of a configuration file:
1999 include SYSCONFDIR/schema/core.schema
2000 pidfile LOCALSTATEDIR/run/slapd.pid
2002 # Subtypes of "name" (e.g. "cn" and "ou") with the
2003 # option ";x\-hidden" can be searched for/compared,
2004 # but are not shown. See \fBslapd.access\fP(5).
2005 attributeoptions x\-hidden lang\-
2006 access to attrs=name;x\-hidden by * =cs
2008 # Protect passwords. See \fBslapd.access\fP(5).
2009 access to attrs=userPassword by * auth
2010 # Read access to other attributes and entries.
2011 access to * by * read
2014 suffix "dc=our\-domain,dc=com"
2015 # The database directory MUST exist prior to
2016 # running slapd AND should only be accessible
2017 # by the slapd/tools. Mode 0700 recommended.
2018 directory LOCALSTATEDIR/openldap\-data
2019 # Indices to maintain
2020 index objectClass eq
2021 index cn,sn,mail pres,eq,approx,sub
2023 # We serve small clients that do not handle referrals,
2024 # so handle remote lookups on their behalf.
2027 uri ldap://ldap.some\-server.com/
2032 "OpenLDAP Administrator's Guide" contains a longer annotated
2033 example of a configuration file.
2034 The original ETCDIR/slapd.conf is another example.
2038 default slapd configuration file
2041 .BR gnutls\-cli (1),
2042 .BR slapd\-config (5),
2043 .BR slapd.access (5),
2044 .BR slapd.backends (5),
2045 .BR slapd.overlays (5),
2046 .BR slapd.plugin (5),
2057 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
2058 .SH ACKNOWLEDGEMENTS
projects / openldap / blob