1 .TH SLAPD-CONFIG 5 "RELEASEDATE" "OpenLDAP LDVERSION"
2 .\" Copyright 1998-2009 The OpenLDAP Foundation All Rights Reserved.
3 .\" Copying restrictions apply. See COPYRIGHT/LICENSE.
6 slapd\-config \- configuration backend to slapd
12 backend manages all of the configuration information for the
14 daemon. This configuration information is also used by the SLAPD tools
26 backend is backward compatible with the older
28 file but provides the ability to change the configuration dynamically
29 at runtime. If slapd is run with only a
31 file dynamic changes will be allowed but they will not persist across
32 a server restart. Dynamic changes are only saved when slapd is running
35 configuration directory.
38 Unlike other backends, there can only be one instance of the
40 backend, and most of its structure is predefined. The root of the
41 database is hardcoded to
43 and this root entry contains
44 global settings for slapd. Multiple child entries underneath the
45 root entry are used to carry various other settings:
49 dynamically loaded modules
55 backend-specific settings
58 database-specific settings
63 entries will only appear in configurations where slapd
64 was built with support for dynamically loaded modules. There can be
65 multiple entries, one for each configured module path. Within each
66 entry there will be values recorded for each module loaded on a
67 given path. These entries have no children.
71 entry contains all of the hardcoded schema elements.
72 The children of this entry contain all user-defined schema elements.
73 In schema that were loaded from include files, the child entry will
74 be named after the include file from which the schema was loaded.
75 Typically the first child in this subtree will be
76 .BR cn=core,cn=schema,cn=config .
79 entries are for storing settings specific to a single
80 backend type (and thus global to all database instances of that type).
81 At present there are no backends that implement settings of this
82 nature, so usually there will not be any olcBackend entries.
85 entries store settings specific to a single database
86 instance. These entries may have
88 child entries corresponding
89 to any overlays configured on the database. The olcDatabase and
90 olcOverlay entries may also have miscellaneous child entries for
91 other settings as needed. There are two special database entries
92 that are predefined - one is an entry for the config database itself,
93 and the other is for the "frontend" database. Settings in the
94 frontend database are inherited by the other databases, unless
95 they are explicitly overridden in a specific database.
97 The specific configuration options available are discussed below in the
98 Global Configuration Options, General Backend Options, and General Database
99 Options. Options are set by defining LDAP attributes with specific values.
100 In general the names of the LDAP attributes are the same as the corresponding
102 keyword, with an "olc" prefix added on.
104 The parser for many of these attributes is the same as used for parsing
105 the slapd.conf keywords. As such, slapd.conf keywords that allow multiple
106 items to be specified on one line, separated by whitespace, will allow
107 multiple items to be specified in one attribute value. However, when
108 reading the attribute via LDAP, the items will be returned as individual
111 Backend-specific options are discussed in the
112 .B slapd\-<backend>(5)
113 manual pages. Refer to the "OpenLDAP Administrator's Guide" for more
114 details on configuring slapd.
115 .SH GLOBAL CONFIGURATION OPTIONS
116 Options described in this section apply to the server as a whole.
117 Arguments that should be replaced by
118 actual text are shown in brackets <>.
120 These options may only be specified in the
122 entry. This entry must have an objectClass of
126 .B olcAllows: <features>
127 Specify a set of features to allow (default none).
129 allows acceptance of LDAPv2 bind requests. Note that
131 does not truly implement LDAPv2 (RFC 1777), now Historic (RFC 3494).
133 allows anonymous bind when credentials are not empty (e.g.
136 allows unauthenticated (anonymous) bind when DN is not empty.
138 allows unauthenticated (anonymous) update operations to be processed
139 (subject to access controls and other administrative limits).
141 allows unauthenticated (anonymous) proxy authorization control to be processed
142 (subject to access controls, authorization and other administrative limits).
144 .B olcArgsFile: <filename>
145 The (absolute) name of a file that will hold the
147 server's command line (program name and options).
149 .B olcAttributeOptions: <option-name>...
150 Define tagging attribute options or option tag/range prefixes.
151 Options must not end with `\-', prefixes must end with `\-'.
152 The `lang\-' prefix is predefined.
154 .B olcAttributeOptions
155 directive, `lang\-' will no longer be defined and you must specify it
156 explicitly if you want it defined.
158 An attribute description with a tagging option is a subtype of that
159 attribute description without the option.
160 Except for that, options defined this way have no special semantics.
161 Prefixes defined this way work like the `lang\-' options:
162 They define a prefix for tagging options starting with the prefix.
163 That is, if you define the prefix `x\-foo\-', you can use the option
165 Furthermore, in a search or compare, a prefix or range name (with
166 a trailing `\-') matches all options starting with that name, as well
167 as the option with the range name sans the trailing `\-'.
168 That is, `x\-foo\-bar\-' matches `x\-foo\-bar' and `x\-foo\-bar\-baz'.
170 RFC 4520 reserves options beginning with `x\-' for private experiments.
171 Other options should be registered with IANA, see RFC 4520 section 3.5.
172 OpenLDAP also has the `binary' option built in, but this is a transfer
173 option, not a tagging option.
175 .B olcAuthIDRewrite: <rewrite\-rule>
176 Used by the authentication framework to convert simple user names
177 to an LDAP DN used for authorization purposes.
178 Its purpose is analogous to that of
183 is a set of rules analogous to those described in
185 for data rewriting (after stripping the \fIrwm\-\fP prefix).
189 should not be intermixed.
191 .B olcAuthzPolicy: <policy>
192 Used to specify which rules to use for Proxy Authorization. Proxy
193 authorization allows a client to authenticate to the server using one
194 user's credentials, but specify a different identity to use for authorization
195 and access control purposes. It essentially allows user A to login as user
196 B, using user A's password.
199 flag disables proxy authorization. This is the default setting.
202 flag will use rules in the
204 attribute of the authorization DN.
207 flag will use rules in the
209 attribute of the authentication DN.
212 flag, an alias for the deprecated value of
214 will allow any of the above, whatever succeeds first (checked in
220 flag requires both authorizations to succeed.
223 The rules are mechanisms to specify which identities are allowed
224 to perform proxy authorization.
227 attribute in an entry specifies which other users
228 are allowed to proxy login to this entry. The
231 an entry specifies which other users this user can authorize as. Use of
234 abused if users are allowed to write arbitrary values to this attribute.
237 attribute must be protected with ACLs such that
238 only privileged users can modify it.
245 or a set of identities; it can take five forms:
248 .B ldap:///<base>??[<scope>]?<filter>
251 .B dn[.<dnstyle>]:<pattern>
254 .B u[<mech>[<realm>]]:<pattern>
257 .B group[/objectClass[/attributeType]]:<pattern>
264 .B <dnstyle>:={exact|onelevel|children|subtree|regex}
267 The first form is a valid LDAP
275 portions must be absent, so that the search occurs locally on either
281 with the optional style modifiers
287 for exact, onelevel, children and subtree matches, which cause
289 to be normalized according to the DN normalization rules, or the special
291 style, which causes the
293 to be treated as a POSIX (''extended'') regular expression, as
300 means any non-anonymous DN.
301 The third form is a SASL
303 with the optional fields
307 that allow to specify a SASL
309 and eventually a SASL
311 for those mechanisms that support one.
312 The need to allow the specification of a mechanism is still debated,
313 and users are strongly discouraged to rely on this possibility.
314 The fourth form is a group specification, consisting of the keyword
316 optionally followed by the specification of the group
322 is searched with base scope, and in case of match, the values of the
325 are searched for the asserted DN.
326 For backwards compatibility, if no identity type is provided, i.e. only
330 is assumed; as a consequence,
332 is subjected to DN normalization.
333 Since the interpretation of
337 can impact security, users are strongly encouraged
338 to explicitly set the type of identity specification that is being used.
339 A subset of these rules can be used as third arg in the
341 statement (see below); significantly, the
348 .B olcAuthzRegexp: <match> <replace>
349 Used by the authentication framework to convert simple user names,
350 such as provided by SASL subsystem, to an LDAP DN used for
351 authorization purposes. Note that the resultant DN need not refer
352 to an existing entry to be considered valid. When an authorization
353 request is received from the SASL subsystem, the SASL
358 are taken, when available, and combined into a name of the form
362 .B UID=<username>[[,CN=<realm>],CN=<mechanism>],CN=auth
365 This name is then compared against the
367 POSIX (''extended'') regular expression, and if the match is successful,
368 the name is replaced with the
370 string. If there are wildcard strings in the
372 regular expression that are enclosed in parenthesis, e.g.
378 then the portion of the name that matched the wildcard will be stored
379 in the numbered placeholder variable $1. If there are other wildcard strings
380 in parenthesis, the matching strings will be in $2, $3, etc. up to $9. The
381 placeholders can then be used in the
386 .B UID=$1,OU=Accounts,DC=example,DC=com
389 The replaced name can be either a DN, i.e. a string prefixed by "dn:",
391 If the latter, the server will use the URI to search its own database(s)
392 and, if the search returns exactly one entry, the name is
393 replaced by the DN of that entry. The LDAP URI must have no
394 hostport, attrs, or extensions components, but the filter is mandatory,
398 .B ldap:///OU=Accounts,DC=example,DC=com??one?(UID=$1)
401 The protocol portion of the URI must be strictly
403 Note that this search is subject to access controls. Specifically,
404 the authentication identity must have "auth" access in the subject.
408 values can be specified to allow for multiple matching
409 and replacement patterns. The matching patterns are checked in the order they
410 appear in the attribute, stopping at the first successful match.
413 .\"Because the plus sign + is a character recognized by the regular expression engine,
414 .\"and it will appear in names that include a REALM, be careful to escape the
415 .\"plus sign with a backslash \\+ to remove the character's special meaning.
418 .B olcConcurrency: <integer>
419 Specify a desired level of concurrency. Provided to the underlying
420 thread system as a hint. The default is not to provide any hint. This setting
421 is only meaningful on some platforms where there is not a one to one
422 correspondence between user threads and kernel threads.
424 .B olcConnMaxPending: <integer>
425 Specify the maximum number of pending requests for an anonymous session.
426 If requests are submitted faster than the server can process them, they
427 will be queued up to this limit. If the limit is exceeded, the session
428 is closed. The default is 100.
430 .B olcConnMaxPendingAuth: <integer>
431 Specify the maximum number of pending requests for an authenticated session.
434 .B olcDisallows: <features>
435 Specify a set of features to disallow (default none).
437 disables acceptance of anonymous bind requests. Note that this setting
438 does not prohibit anonymous directory access (See "require authc").
440 disables simple (bind) authentication.
442 disables forcing session to anonymous status (see also
444 upon StartTLS operation receipt.
446 disallows the StartTLS operation if authenticated (see also
449 .B olcGentleHUP: { TRUE | FALSE }
450 A SIGHUP signal will only cause a 'gentle' shutdown-attempt:
452 will stop listening for new connections, but will not close the
453 connections to the current clients. Future write operations return
454 unwilling-to-perform, though. Slapd terminates when all clients
455 have closed their connections (if they ever do), or - as before -
456 if it receives a SIGTERM signal. This can be useful if you wish to
457 terminate the server and start a new
460 .B with another database,
461 without disrupting the currently active clients.
462 The default is FALSE. You may wish to use
464 along with this option.
466 .B olcIdleTimeout: <integer>
467 Specify the number of seconds to wait before forcibly closing
468 an idle client connection. A setting of 0 disables this
469 feature. The default is 0. You may also want to set the
473 .B olcIndexIntLen: <integer>
474 Specify the key length for ordered integer indices. The most significant
475 bytes of the binary integer will be used for index keys. The default
476 value is 4, which provides exact indexing for 31 bit values.
477 A floating point representation is used to index too large values.
479 .B olcIndexSubstrIfMaxlen: <integer>
480 Specify the maximum length for subinitial and subfinal indices. Only
481 this many characters of an attribute value will be processed by the
482 indexing functions; any excess characters are ignored. The default is 4.
484 .B olcIndexSubstrIfMinlen: <integer>
485 Specify the minimum length for subinitial and subfinal indices. An
486 attribute value must have at least this many characters in order to be
487 processed by the indexing functions. The default is 2.
489 .B olcIndexSubstrAnyLen: <integer>
490 Specify the length used for subany indices. An attribute value must have
491 at least this many characters in order to be processed. Attribute values
492 longer than this length will be processed in segments of this length. The
493 default is 4. The subany index will also be used in subinitial and
494 subfinal index lookups when the filter string is longer than the
495 .I olcIndexSubstrIfMaxlen
498 .B olcIndexSubstrAnyStep: <integer>
499 Specify the steps used in subany index lookups. This value sets the offset
500 for the segments of a filter string that are processed for a subany index
501 lookup. The default is 2. For example, with the default values, a search
502 using this filter "cn=*abcdefgh*" would generate index lookups for
503 "abcd", "cdef", and "efgh".
506 Note: Indexing support depends on the particular backend in use. Also,
507 changing these settings will generally require deleting any indices that
508 depend on these parameters and recreating them with
512 .B olcLocalSSF: <SSF>
513 Specifies the Security Strength Factor (SSF) to be given local LDAP sessions,
514 such as those to the ldapi:// listener. For a description of SSF values,
516 .BR olcSaslSecProps 's
518 option description. The default is 71.
520 .B olcLogFile: <filename>
521 Specify a file for recording debug log messages. By default these messages
522 only go to stderr and are not recorded anywhere else. Specifying a logfile
523 copies messages to both stderr and the logfile.
525 .B olcLogLevel: <integer> [...]
526 Specify the level at which debugging statements and operation
527 statistics should be syslogged (currently logged to the
529 LOG_LOCAL4 facility).
530 They must be considered subsystems rather than increasingly verbose
532 Some messages with higher priority are logged regardless
533 of the configured loglevel as soon as any logging is configured.
534 Log levels are additive, and available levels are:
545 debug packet handling
549 heavy trace debugging (function args)
553 connection management
557 print out packets sent and received
561 search filter processing
565 configuration file processing
569 access control list processing
573 stats log connections/operations/results
577 stats log entries sent
581 print communication with shell backends
593 \"data indexing (unused)
601 only messages that get logged whatever log level is set
604 The desired log level can be input as a single integer that combines
605 the (ORed) desired levels, both in decimal or in hexadecimal notation,
606 as a list of integers (that are ORed internally),
607 or as a list of the names that are shown between brackets, such that
613 olcLogLevel: 0x80 0x1
614 olcLogLevel: acl trace
620 can be used as a shortcut to enable logging at all levels (equivalent to \-1).
623 or the equivalent integer representation, causes those messages
624 that are logged regardless of the configured olcLogLevel to be logged.
625 In fact, if no olcLogLevel (or a 0 level) is defined, no logging occurs,
628 level is required to have high priority messages logged.
631 .B olcPasswordCryptSaltFormat: <format>
632 Specify the format of the salt passed to
634 when generating {CRYPT} passwords (see
635 .BR olcPasswordHash )
636 during processing of LDAP Password Modify Extended Operations (RFC 3062).
638 This string needs to be in
640 format and may include one (and only one) %s conversion.
641 This conversion will be substituted with a string of random
642 characters from [A\-Za\-z0\-9./]. For example, "%.2s"
643 provides a two character salt and "$1$%.8s" tells some
644 versions of crypt(3) to use an MD5 algorithm and provides
645 8 random characters of salt. The default is "%s", which
646 provides 31 characters of salt.
648 .B olcPidFile: <filename>
649 The (absolute) name of a file that will hold the
651 server's process ID (see
654 .B olcPluginLogFile: <filename>
655 The ( absolute ) name of a file that will contain log
662 .B olcReferral: <url>
663 Specify the referral to pass back when
665 cannot find a local database to handle a request.
666 If multiple values are specified, each url is provided.
668 .B olcReverseLookup: TRUE | FALSE
669 Enable/disable client name unverified reverse lookup (default is
671 if compiled with \-\-enable\-rlookups).
673 .B olcRootDSE: <file>
674 Specify the name of an LDIF(5) file containing user defined attributes
675 for the root DSE. These attributes are returned in addition to the
676 attributes normally produced by slapd.
678 The root DSE is an entry with information about the server and its
679 capabilities, in operational attributes.
680 It has the empty DN, and can be read with e.g.:
682 ldapsearch \-x \-b "" \-s base "+"
684 See RFC 4512 section 5.1 for details.
686 .B olcSaslAuxprops: <plugin> [...]
687 Specify which auxprop plugins to use for authentication lookups. The
688 default is empty, which just uses slapd's internal support. Usually
689 no other auxprop plugins are needed.
691 .B olcSaslHost: <fqdn>
692 Used to specify the fully qualified domain name used for SASL processing.
694 .B olcSaslRealm: <realm>
695 Specify SASL realm. Default is empty.
697 .B olcSaslSecProps: <properties>
698 Used to specify Cyrus SASL security properties.
701 flag (without any other properties) causes the flag properties
702 default, "noanonymous,noplain", to be cleared.
705 flag disables mechanisms susceptible to simple passive attacks.
708 flag disables mechanisms susceptible to active attacks.
711 flag disables mechanisms susceptible to passive dictionary attacks.
714 flag disables mechanisms which support anonymous login.
717 flag require forward secrecy between sessions.
720 require mechanisms which pass client credentials (and allow
721 mechanisms which can pass credentials to do so).
724 property specifies the minimum acceptable
725 .I security strength factor
726 as an integer approximate to effective key length used for
727 encryption. 0 (zero) implies no protection, 1 implies integrity
728 protection only, 56 allows DES or other weak ciphers, 112
729 allows triple DES and other strong ciphers, 128 allows RC4,
730 Blowfish and other modern strong ciphers. The default is 0.
733 property specifies the maximum acceptable
734 .I security strength factor
735 as an integer (see minssf description). The default is INT_MAX.
738 property specifies the maximum security layer receive buffer
739 size allowed. 0 disables security layers. The default is 65536.
741 .B olcServerID: <integer> [<URL>]
742 Specify an integer ID from 0 to 4095 for this server (limited
743 to 3 hexadecimal digits). The ID may also be specified as a
744 hexadecimal ID by prefixing the value with "0x".
746 required when using multimaster replication and each master must have a
747 unique ID. Note that this requirement also applies to separate masters
748 contributing to a glued set of databases.
749 If the URL is provided, this directive may be specified
750 multiple times, providing a complete list of participating servers
751 and their IDs. The fully qualified hostname of each server should be
752 used in the supplied URLs. The IDs are used in the "replica id" field
753 of all CSNs generated by the specified server. The default value is zero.
757 olcServerID: 1 ldap://ldap1.example.com
758 olcServerID: 2 ldap://ldap2.example.com
761 .B olcSockbufMaxIncoming: <integer>
762 Specify the maximum incoming LDAP PDU size for anonymous sessions.
763 The default is 262143.
765 .B olcSockbufMaxIncomingAuth: <integer>
766 Specify the maximum incoming LDAP PDU size for authenticated sessions.
767 The default is 4194303.
769 .B olcTCPBuffer [listener=<URL>] [{read|write}=]<size>
770 Specify the size of the TCP buffer.
771 A global value for both read and write TCP buffers related to any listener
772 is defined, unless the listener is explicitly specified,
773 or either the read or write qualifiers are used.
777 Note that some OS-es implement automatic TCP buffer tuning.
779 .B olcThreads: <integer>
780 Specify the maximum size of the primary thread pool.
781 The default is 16; the minimum value is 2.
783 .B olcToolThreads: <integer>
784 Specify the maximum number of threads to use in tool mode.
785 This should not be greater than the number of CPUs in the system.
788 .B olcWriteTimeout: <integer>
789 Specify the number of seconds to wait before forcibly closing
790 a connection with an outstanding write. This allows recovery from
791 various network hang conditions. A setting of 0 disables this
792 feature. The default is 0.
796 is built with support for Transport Layer Security, there are more options
799 .B olcTLSCipherSuite: <cipher-suite-spec>
800 Permits configuring what ciphers will be accepted and the preference order.
801 <cipher-suite-spec> should be a cipher specification for OpenSSL. Example:
803 olcTLSCipherSuite: HIGH:MEDIUM:+SSLv2
805 To check what ciphers a given spec selects in OpenSSL, use:
808 openssl ciphers \-v <cipher-suite-spec>
811 To obtain the list of ciphers in GNUtls use:
817 .B olcTLSCACertificateFile: <filename>
818 Specifies the file that contains certificates for all of the Certificate
823 .B olcTLSCACertificatePath: <path>
824 Specifies the path of a directory that contains Certificate Authority
825 certificates in separate individual files. Usually only one of this
826 or the olcTLSCACertificateFile is defined. If both are specified, both
827 locations will be used. This directive is not supported
830 .B olcTLSCertificateFile: <filename>
831 Specifies the file that contains the
835 .B olcTLSCertificateKeyFile: <filename>
836 Specifies the file that contains the
838 server private key that matches the certificate stored in the
839 .B olcTLSCertificateFile
840 file. If the private key is protected with a password, the password must
841 be manually typed in when slapd starts. Usually the private key is not
842 protected with a password, to allow slapd to start without manual
844 it is of critical importance that the file is protected carefully.
846 .B olcTLSDHParamFile: <filename>
847 This directive specifies the file that contains parameters for Diffie-Hellman
848 ephemeral key exchange. This is required in order to use a DSA certificate on
849 the server. If multiple sets of parameters are present in the file, all of
850 them will be processed. Note that setting this option may also enable
851 Anonymous Diffie-Hellman key exchanges in certain non-default cipher suites.
852 You should append "!ADH" to your cipher suites if you have changed them
853 from the default, otherwise no certificate exchanges or verification will
854 be done. When using GNUtls these parameters are always generated randomly
855 so this directive is ignored.
857 .B olcTLSRandFile: <filename>
858 Specifies the file to obtain random bits from when /dev/[u]random
859 is not available. Generally set to the name of the EGD/PRNGD socket.
860 The environment variable RANDFILE can also be used to specify the filename.
861 This directive is ignored with GNUtls.
863 .B olcTLSVerifyClient: <level>
864 Specifies what checks to perform on client certificates in an
865 incoming TLS session, if any.
868 can be specified as one of the following keywords:
874 will not ask the client for a certificate.
877 The client certificate is requested. If no certificate is provided,
878 the session proceeds normally. If a bad certificate is provided,
879 it will be ignored and the session proceeds normally.
882 The client certificate is requested. If no certificate is provided,
883 the session proceeds normally. If a bad certificate is provided,
884 the session is immediately terminated.
886 .B demand | hard | true
887 These keywords are all equivalent, for compatibility reasons.
888 The client certificate is requested. If no certificate is provided,
889 or a bad certificate is provided, the session is immediately terminated.
891 Note that a valid client certificate is required in order to use the
892 SASL EXTERNAL authentication mechanism with a TLS session. As such,
894 .B olcTLSVerifyClient
895 setting must be chosen to enable SASL EXTERNAL authentication.
898 .B olcTLSCRLCheck: <level>
899 Specifies if the Certificate Revocation List (CRL) of the CA should be
900 used to verify if the client certificates have not been revoked. This
902 .B olcTLSCACertificatePath
903 parameter to be set. This parameter is ignored with GNUtls.
905 can be specified as one of the following keywords:
909 No CRL checks are performed
912 Check the CRL of the peer certificate
915 Check the CRL for a whole certificate chain
918 .B olcTLSCRLFile: <filename>
919 Specifies a file containing a Certificate Revocation List to be used
920 for verifying that certificates have not been revoked. This parameter
921 is only valid when using GNUtls.
922 .SH DYNAMIC MODULE OPTIONS
925 is compiled with \-\-enable\-modules then the module-related entries will
926 be available. These entries are named
927 .B cn=module{x},cn=config
929 must have the olcModuleList objectClass. One entry should be created
932 Normally the config engine generates the "{x}" index in the RDN
933 automatically, so it can be omitted when initially loading these entries.
935 .B olcModuleLoad: <filename>
936 Specify the name of a dynamically loadable module to load. The filename
937 may be an absolute path name or a simple filename. Non-absolute names
938 are searched for in the directories specified by the
942 .B olcModulePath: <pathspec>
943 Specify a list of directories to search for loadable modules. Typically
944 the path is colon-separated but this depends on the operating system.
945 The default is MODULEDIR, which is where the standard OpenLDAP install
946 will place its modules.
948 Schema definitions are created as entries in the
949 .B cn=schema,cn=config
950 subtree. These entries must have the olcSchemaConfig objectClass.
951 As noted above, the actual
952 .B cn=schema,cn=config
953 entry is predefined and any values specified for it are ignored.
957 .B olcAttributetypes: "(\ <oid>\
959 [DESC\ <description>]\
968 [NO\-USER\-MODIFICATION]\
969 [USAGE\ <attributeUsage>]\ )"
971 Specify an attribute type using the LDAPv3 syntax defined in RFC 4512.
972 The slapd parser extends the RFC 4512 definition by allowing string
973 forms as well as numeric OIDs to be used for the attribute OID and
974 attribute syntax OID.
976 .B olcObjectIdentifier
982 .B olcDitContentRules: "(\ <oid>\
984 [DESC\ <description>]\
991 Specify an DIT Content Rule using the LDAPv3 syntax defined in RFC 4512.
992 The slapd parser extends the RFC 4512 definition by allowing string
993 forms as well as numeric OIDs to be used for the attribute OID and
994 attribute syntax OID.
996 .B olcObjectIdentifier
1002 .B olcObjectClasses: "(\ <oid>\
1004 [DESC\ <description>]\
1007 [{ ABSTRACT | STRUCTURAL | AUXILIARY }]\
1008 [MUST\ <oids>] [MAY\ <oids>] )"
1010 Specify an objectclass using the LDAPv3 syntax defined in RFC 4512.
1011 The slapd parser extends the RFC 4512 definition by allowing string
1012 forms as well as numeric OIDs to be used for the object class OID.
1016 description.) Object classes are "STRUCTURAL" by default.
1019 .B olcObjectIdentifier: <name> "{ <oid> | <name>[:<suffix>] }"
1020 Define a string name that equates to the given OID. The string can be used
1021 in place of the numeric OID in objectclass and attribute definitions. The
1022 name can also be used with a suffix of the form ":xx" in which case the
1023 value "oid.xx" will be used.
1025 .SH GENERAL BACKEND OPTIONS
1026 Options in these entries only apply to the configuration of a single
1027 type of backend. All backends may support this class of options.
1028 The entry must be named
1029 .B olcBackend=<databasetype>,cn=config
1030 and must have the olcBackendConfig objectClass.
1048 At present, no backend implements any options of this type.
1050 .SH DATABASE OPTIONS
1051 Database options are set in entries named
1052 .B olcDatabase={x}<databasetype>,cn=config
1053 and must have the olcDatabaseConfig objectClass. Normally the config
1054 engine generates the "{x}" index in the RDN automatically, so it
1055 can be omitted when initially loading these entries.
1057 The special frontend database is always numbered "{\-1}" and the config
1058 database is always numbered "{0}".
1060 .SH GLOBAL DATABASE OPTIONS
1061 Options in this section may be set in the special "frontend" database
1062 and inherited in all the other databases. These options may be altered
1063 by further settings in each specific database. The frontend entry must
1065 .B olcDatabase=frontend,cn=config
1066 and must have the olcFrontendConfig objectClass.
1068 .B olcAccess: to <what> "[ by <who> <access> <control> ]+"
1069 Grant access (specified by <access>) to a set of entries and/or
1070 attributes (specified by <what>) by one or more requestors (specified
1072 If no access controls are present, the default policy
1073 allows anyone and everyone to read anything but restricts
1074 updates to rootdn. (e.g., "olcAccess: to * by * read").
1076 .BR slapd.access (5)
1077 and the "OpenLDAP Administrator's Guide" for details.
1079 Access controls set in the frontend are appended to any access
1080 controls set on the specific databases.
1081 The rootdn of a database can always read and write EVERYTHING
1084 Extra special care must be taken with the access controls on the
1085 config database. Unlike other databases, the default policy for the
1086 config database is to only allow access to the rootdn. Regular users
1087 should not have read access, and write access should be granted very
1088 carefully to privileged administrators.
1091 .B olcDefaultSearchBase: <dn>
1092 Specify a default search base to use when client submits a
1093 non-base search request with an empty base DN.
1094 Base scoped search requests with an empty base DN are not affected.
1095 This setting is only allowed in the frontend entry.
1097 .B olcPasswordHash: <hash> [<hash>...]
1098 This option configures one or more hashes to be used in generation of user
1099 passwords stored in the userPassword attribute during processing of
1100 LDAP Password Modify Extended Operations (RFC 3062).
1101 The <hash> must be one of
1115 use the SHA-1 algorithm (FIPS 160-1), the latter with a seed.
1120 use the MD5 algorithm (RFC 1321), the latter with a seed.
1127 indicates that the new password should be
1128 added to userPassword as clear text.
1130 Note that this option does not alter the normal user applications
1131 handling of userPassword during LDAP Add, Modify, or other LDAP operations.
1132 This setting is only allowed in the frontend entry.
1134 .B olcReadOnly: TRUE | FALSE
1135 This option puts the database into "read-only" mode. Any attempts to
1136 modify the database will return an "unwilling to perform" error. By
1137 default, olcReadOnly is FALSE. Note that when this option is set
1138 TRUE on the frontend, it cannot be reset without restarting the
1139 server, since further writes to the config database will be rejected.
1141 .B olcRequires: <conditions>
1142 Specify a set of conditions to require (default none).
1143 The directive may be specified globally and/or per-database;
1144 databases inherit global conditions, so per-database specifications
1147 requires bind operation prior to directory operations.
1149 requires session to be using LDAP version 3.
1151 requires authentication prior to directory operations.
1153 requires SASL authentication prior to directory operations.
1155 requires strong authentication prior to directory operations.
1156 The strong keyword allows protected "simple" authentication
1157 as well as SASL authentication.
1159 may be used to require no conditions (useful to clear out globally
1160 set conditions within a particular database); it must occur first
1161 in the list of conditions.
1163 .B olcRestrict: <oplist>
1164 Specify a list of operations that are restricted.
1165 Restrictions on a specific database override any frontend setting.
1166 Operations can be any of
1171 .BR extended[=<OID>] ,
1175 or the special pseudo-operations
1179 which respectively summarize read and write operations.
1183 .I olcReadOnly: TRUE
1187 keyword allows to indicate the OID of the specific operation
1190 .B olcSchemaDN: <dn>
1191 Specify the distinguished name for the subschema subentry that
1192 controls the entries on this server. The default is "cn=Subschema".
1194 .B olcSecurity: <factors>
1195 Specify a set of security strength factors (separated by white space)
1197 .BR olcSaslSecprops 's
1199 option for a description of security strength factors).
1200 The directive may be specified globally and/or per-database.
1202 specifies the overall security strength factor.
1204 specifies the transport security strength factor.
1206 specifies the TLS security strength factor.
1208 specifies the SASL security strength factor.
1210 specifies the overall security strength factor to require for
1212 .B update_transport=<n>
1213 specifies the transport security strength factor to require for
1216 specifies the TLS security strength factor to require for
1219 specifies the SASL security strength factor to require for
1222 specifies the security strength factor required for
1224 username/password authentication.
1227 factor is measure of security provided by the underlying transport,
1228 e.g. ldapi:// (and eventually IPSEC). It is not normally used.
1230 .B olcSizeLimit: {<integer>|unlimited}
1232 .B olcSizeLimit: size[.{soft|hard|unchecked}]=<integer> [...]
1233 Specify the maximum number of entries to return from a search operation.
1234 The default size limit is 500.
1237 to specify no limits.
1238 The second format allows a fine grain setting of the size limits.
1239 Extra args can be added in the same value or as additional values.
1242 for an explanation of the different flags.
1244 .B olcSortVals: <attr> [...]
1245 Specify a list of multi-valued attributes whose values will always
1246 be maintained in sorted order. Using this option will allow Modify,
1247 Compare, and filter evaluations on these attributes to be performed
1248 more efficiently. The resulting sort order depends on the
1249 attributes' syntax and matching rules and may not correspond to
1250 lexical order or any other recognizable order.
1251 This setting is only allowed in the frontend entry.
1253 .B olcTimeLimit: {<integer>|unlimited}
1255 .B olcTimeLimit: time[.{soft|hard}]=<integer> [...]
1256 Specify the maximum number of seconds (in real time)
1258 will spend answering a search request. The default time limit is 3600.
1261 to specify no limits.
1262 The second format allows a fine grain setting of the time limits.
1263 Extra args can be added in the same value or as additional values.
1266 for an explanation of the different flags.
1268 .SH GENERAL DATABASE OPTIONS
1269 Options in this section only apply to the specific database for
1270 which they are defined. They are supported by every
1271 type of backend. All of the Global Database Options may also be
1274 .B olcAddContentAcl: TRUE | FALSE
1275 Controls whether Add operations will perform ACL checks on
1276 the content of the entry being added. This check is off
1278 .BR slapd.access (5)
1279 manual page for more details on ACL requirements for
1282 .B olcHidden: TRUE | FALSE
1283 Controls whether the database will be used to answer
1284 queries. A database that is hidden will never be
1285 selected to answer any queries, and any suffix configured
1286 on the database will be ignored in checks for conflicts
1287 with other databases. By default, olcHidden is FALSE.
1289 .B olcLastMod: TRUE | FALSE
1292 will automatically maintain the
1293 modifiersName, modifyTimestamp, creatorsName, and
1294 createTimestamp attributes for entries. It also controls
1295 the entryCSN and entryUUID attributes, which are needed
1296 by the syncrepl provider. By default, olcLastMod is TRUE.
1298 .B olcLimits: <selector> <limit> [<limit> [...]]
1299 Specify time and size limits based on the operation's initiator or
1307 anonymous | users | [<dnspec>=]<pattern> | group[/oc[/at]]=<pattern>
1313 <dnspec> ::= dn[.<type>][.<style>]
1315 <type> ::= self | this
1317 <style> ::= exact | base | onelevel | subtree | children | regex | anonymous
1322 is the default and means the bound user, while
1324 means the base DN of the operation.
1327 matches all unauthenticated clients.
1330 matches all authenticated clients;
1333 dn pattern is assumed unless otherwise specified by qualifying
1334 the (optional) key string
1340 (which are synonyms), to require an exact match; with
1342 to require exactly one level of depth match; with
1344 to allow any level of depth match, including the exact match; with
1346 to allow any level of depth match, not including the exact match;
1348 explicitly requires the (default) match based on POSIX (''extended'')
1349 regular expression pattern.
1352 matches unbound operations; the
1355 The same behavior is obtained by using the
1362 with the optional objectClass
1368 sets the limits for any DN listed in the values of the
1374 group objectClass (default
1376 whose DN exactly matches
1379 The currently supported limits are
1384 The syntax for time limits is
1385 .BR time[.{soft|hard}]=<integer> ,
1388 is the number of seconds slapd will spend answering a search request.
1389 If no time limit is explicitly requested by the client, the
1391 limit is used; if the requested time limit exceeds the
1394 .\".I "Administrative limit exceeded"
1395 .\"error is returned.
1396 limit, the value of the limit is used instead.
1399 limit is set to the keyword
1401 the soft limit is used in either case; if it is set to the keyword
1403 no hard limit is enforced.
1404 Explicit requests for time limits smaller or equal to the
1407 If no limit specifier is set, the value is assigned to the
1413 to preserve the original behavior.
1415 The syntax for size limits is
1416 .BR size[.{soft|hard|unchecked}]=<integer> ,
1419 is the maximum number of entries slapd will return answering a search
1421 If no size limit is explicitly requested by the client, the
1423 limit is used; if the requested size limit exceeds the
1426 .\".I "Administrative limit exceeded"
1427 .\"error is returned.
1428 limit, the value of the limit is used instead.
1431 limit is set to the keyword
1433 the soft limit is used in either case; if it is set to the keyword
1435 no hard limit is enforced.
1436 Explicit requests for size limits smaller or equal to the
1441 specifier sets a limit on the number of candidates a search request is allowed
1443 The rationale behind it is that searches for non-properly indexed
1444 attributes may result in large sets of candidates, which must be
1447 to determine whether they match the search filter or not.
1450 limit provides a means to drop such operations before they are even
1452 If the selected candidates exceed the
1454 limit, the search will abort with
1455 .IR "Unwilling to perform" .
1456 If it is set to the keyword
1458 no limit is applied (the default).
1461 the search is not even performed; this can be used to disallow searches
1462 for a specific set of users.
1463 If no limit specifier is set, the value is assigned to the
1469 to preserve the original behavior.
1471 In case of no match, the global limits are used.
1472 The default values are the same as for
1481 control is requested, the
1483 size limit is used by default, because the request of a specific page size
1484 is considered an explicit request for a limitation on the number
1485 of entries to be returned.
1486 However, the size limit applies to the total count of entries returned within
1487 the search, and not to a single page.
1488 Additional size limits may be enforced; the syntax is
1489 .BR size.pr={<integer>|noEstimate|unlimited} ,
1492 is the max page size if no explicit limit is set; the keyword
1494 inhibits the server from returning an estimate of the total number
1495 of entries that might be returned
1496 (note: the current implementation does not return any estimate).
1499 indicates that no limit is applied to the pagedResults control page size.
1501 .B size.prtotal={<integer>|unlimited|disabled}
1502 allows to set a limit on the total number of entries that a pagedResults
1503 control allows to return.
1504 By default it is set to the
1509 is the max number of entries that the whole search with pagedResults control
1513 to allow unlimited number of entries to be returned, e.g. to allow
1514 the use of the pagedResults control as a means to circumvent size
1515 limitations on regular searches; the keyword
1517 disables the control, i.e. no paged results can be returned.
1518 Note that the total number of entries returned when the pagedResults control
1519 is requested cannot exceed the
1521 size limit of regular searches unless extended by the
1526 .B olcMaxDerefDepth: <depth>
1527 Specifies the maximum number of aliases to dereference when trying to
1528 resolve an entry, used to avoid infinite alias loops. The default is 15.
1530 .B olcMirrorMode: TRUE | FALSE
1531 This option puts a replica database into "mirror" mode. Update
1532 operations will be accepted from any user, not just the updatedn. The
1533 database must already be configured as syncrepl consumer
1534 before this keyword may be set. This mode also requires a
1536 (see above) to be configured.
1537 By default, this setting is FALSE.
1539 .B olcPlugin: <plugin_type> <lib_path> <init_function> [<arguments>]
1540 Configure a SLAPI plugin. See the
1541 .BR slapd.plugin (5)
1542 manpage for more details.
1545 Specify the distinguished name that is not subject to access control
1546 or administrative limit restrictions for operations on this database.
1547 This DN may or may not be associated with an entry. An empty root
1548 DN (the default) specifies no root access is to be granted. It is
1549 recommended that the rootdn only be specified when needed (such as
1550 when initially populating a database). If the rootdn is within
1551 a namingContext (suffix) of the database, a simple bind password
1552 may also be provided using the
1554 directive. Note that the rootdn is always needed when using syncrepl.
1556 .B olcRootPW: <password>
1557 Specify a password (or hash of the password) for the rootdn. The
1558 password can only be set if the rootdn is within the namingContext
1559 (suffix) of the database.
1560 This option accepts all RFC 2307 userPassword formats known to
1563 description) as well as cleartext.
1565 may be used to generate a hash of a password. Cleartext
1566 and \fB{CRYPT}\fP passwords are not recommended. If empty
1567 (the default), authentication of the root DN is by other means
1568 (e.g. SASL). Use of SASL is encouraged.
1570 .B olcSubordinate: [TRUE | FALSE | advertise]
1571 Specify that the current backend database is a subordinate of another
1572 backend database. A subordinate database may have only one suffix. This
1573 option may be used to glue multiple databases into a single namingContext.
1574 If the suffix of the current database is within the namingContext of a
1575 superior database, searches against the superior database will be
1576 propagated to the subordinate as well. All of the databases
1577 associated with a single namingContext should have identical rootdns.
1578 Behavior of other LDAP operations is unaffected by this setting. In
1579 particular, it is not possible to use moddn to move an entry from
1580 one subordinate to another subordinate within the namingContext.
1582 If the optional \fBadvertise\fP flag is supplied, the naming context of
1583 this database is advertised in the root DSE. The default is to hide this
1584 database context, so that only the superior context is visible.
1591 are used on the superior database, any glued subordinates that support
1592 these tools are opened as well.
1594 Databases that are glued together should usually be configured with the
1595 same indices (assuming they support indexing), even for attributes that
1596 only exist in some of these databases. In general, all of the glued
1597 databases should be configured as similarly as possible, since the intent
1598 is to provide the appearance of a single directory.
1600 Note that the subordinate functionality is implemented internally
1601 by the \fIglue\fP overlay and as such its behavior will interact with other
1602 overlays in use. By default, the glue overlay is automatically configured as
1603 the last overlay on the superior database. Its position on the database
1604 can be explicitly configured by setting an \fBoverlay glue\fP directive
1605 at the desired position. This explicit configuration is necessary e.g.
1606 when using the \fIsyncprov\fP overlay, which needs to follow \fIglue\fP
1607 in order to work over all of the glued databases. E.g.
1610 dn: olcDatabase={1}bdb,cn=config
1611 olcSuffix: dc=example,dc=com
1614 dn: olcOverlay={0}glue,olcDatabase={1}bdb,cn=config
1617 dn: olcOverlay={1}syncprov,olcDatabase={1}bdb,cn=config
1621 See the Overlays section below for more details.
1623 .B olcSuffix: <dn suffix>
1624 Specify the DN suffix of queries that will be passed to this
1625 backend database. Multiple suffix lines can be given and at least one is
1626 required for each database definition.
1628 If the suffix of one database is "inside" that of another, the database
1629 with the inner suffix must come first in the configuration file.
1630 You may also want to glue such databases together with the
1634 .B olcSyncUseSubentry: TRUE | FALSE
1635 Store the syncrepl contextCSN in a subentry instead of the context entry
1636 of the database. The subentry's RDN will be "cn=ldapsync". The default is
1637 FALSE, meaning the contextCSN is stored in the context entry.
1640 .B olcSyncrepl: rid=<replica ID>
1641 .B provider=ldap[s]://<hostname>[:port]
1642 .B searchbase=<base DN>
1643 .B [type=refreshOnly|refreshAndPersist]
1644 .B [interval=dd:hh:mm:ss]
1645 .B [retry=[<retry interval> <# of retries>]+]
1646 .B [filter=<filter str>]
1647 .B [scope=sub|one|base|subord]
1648 .B [attrs=<attr list>]
1649 .B [exattrs=<attr list>]
1651 .B [sizelimit=<limit>]
1652 .B [timelimit=<limit>]
1653 .B [schemachecking=on|off]
1654 .B [network\-timeout=<seconds>]
1655 .B [timeout=<seconds>]
1656 .B [bindmethod=simple|sasl]
1658 .B [saslmech=<mech>]
1659 .B [authcid=<identity>]
1660 .B [authzid=<identity>]
1661 .B [credentials=<passwd>]
1663 .B [secprops=<properties>]
1664 .B [keepalive=<idle>:<probes>:<interval>]
1665 .B [starttls=yes|critical]
1666 .B [tls_cert=<file>]
1668 .B [tls_cacert=<file>]
1669 .B [tls_cacertdir=<path>]
1670 .B [tls_reqcert=never|allow|try|demand]
1671 .B [tls_ciphersuite=<ciphers>]
1672 .B [tls_crlcheck=none|peer|all]
1673 .B [logbase=<base DN>]
1674 .B [logfilter=<filter str>]
1675 .B [syncdata=default|accesslog|changelog]
1677 Specify the current database as a replica which is kept up-to-date with the
1678 master content by establishing the current
1680 as a replication consumer site running a
1683 The replica content is kept synchronized to the master content using
1684 the LDAP Content Synchronization protocol. Refer to the
1685 "OpenLDAP Administrator's Guide" for detailed information on
1686 setting up a replicated
1688 directory service using the
1693 identifies the current
1695 directive within the replication consumer site.
1696 It is a non-negative integer having no more than three decimal digits.
1699 specifies the replication provider site containing the master content
1700 as an LDAP URI. If <port> is not given, the standard LDAP port number
1701 (389 or 636) is used.
1705 replica is defined using a search
1706 specification as its result set. The consumer
1708 will send search requests to the provider
1710 according to the search specification. The search specification includes
1711 .B searchbase, scope, filter, attrs, attrsonly, sizelimit,
1714 parameters as in the normal search specification. The
1716 option may also be used to specify attributes that should be omitted
1717 from incoming entries.
1718 The \fBscope\fP defaults to \fBsub\fP, the \fBfilter\fP defaults to
1719 \fB(objectclass=*)\fP, and there is no default \fBsearchbase\fP. The
1720 \fBattrs\fP list defaults to \fB"*,+"\fP to return all user and operational
1721 attributes, and \fBattrsonly\fP and \fBexattrs\fP are unset by default.
1722 The \fBsizelimit\fP and \fBtimelimit\fP only
1723 accept "unlimited" and positive integers, and both default to "unlimited".
1724 Note, however, that any provider-side limits for the replication identity
1725 will be enforced by the provider regardless of the limits requested
1726 by the LDAP Content Synchronization operation, much like for any other
1729 The LDAP Content Synchronization protocol has two operation types.
1732 operation, the next synchronization search operation
1733 is periodically rescheduled at an interval time (specified by
1735 parameter; 1 day by default)
1736 after each synchronization operation finishes.
1738 .B refreshAndPersist
1739 operation, a synchronization search remains persistent in the provider slapd.
1740 Further updates to the master replica will generate
1741 .B searchResultEntry
1742 to the consumer slapd as the search responses to the persistent
1743 synchronization search.
1745 If an error occurs during replication, the consumer will attempt to
1746 reconnect according to the
1748 parameter which is a list of the <retry interval> and <# of retries> pairs.
1749 For example, retry="60 10 300 3" lets the consumer retry every 60 seconds
1750 for the first 10 times and then retry every 300 seconds for the next 3
1751 times before stop retrying. The `+' in <# of retries> means indefinite
1752 number of retries until success.
1754 The schema checking can be enforced at the LDAP Sync
1755 consumer site by turning on the
1757 parameter. The default is off.
1761 parameter sets how long the consumer will wait to establish a
1762 network connection to the provider. Once a connection is
1765 parameter determines how long the consumer will wait for the initial
1766 Bind request to complete. The defaults for these parameters come
1774 requires the options
1778 and should only be used when adequate security services
1779 (e.g. TLS or IPSEC) are in place.
1786 Depending on the mechanism, an authentication identity and/or
1787 credentials can be specified using
1793 parameter may be used to specify an authorization identity.
1794 Specific security properties (as with the
1796 keyword above) for a SASL bind can be set with the
1798 option. A non default SASL realm can be set with the
1801 The provider, other than allow authentication of the syncrepl identity,
1802 should grant that identity appropriate access privileges to the data
1803 that is being replicated (\fBaccess\fP directive), and appropriate time
1804 and size limits (\fBlimits\fP directive).
1808 parameter sets the values of \fIidle\fP, \fIprobes\fP, and \fIinterval\fP
1809 used to check whether a socket is alive;
1811 is the number of seconds a connection needs to remain idle before TCP
1812 starts sending keepalive probes;
1814 is the maximum number of keepalive probes TCP should send before dropping
1817 is interval in seconds between individual keepalive probes.
1818 Only some systems support the customization of these values;
1821 parameter is ignored otherwise, and system-wide settings are used.
1825 parameter specifies use of the StartTLS extended operation
1826 to establish a TLS session before Binding to the provider. If the
1828 argument is supplied, the session will be aborted if the StartTLS request
1829 fails. Otherwise the syncrepl session continues without TLS. The
1830 tls_reqcert setting defaults to "demand" and the other TLS settings
1831 default to the same as the main slapd TLS settings.
1833 Rather than replicating whole entries, the consumer can query logs of
1834 data modifications. This mode of operation is referred to as \fIdelta
1835 syncrepl\fP. In addition to the above parameters, the
1839 parameters must be set appropriately for the log that will be used. The
1841 parameter must be set to either "accesslog" if the log conforms to the
1842 .BR slapo\-accesslog (5)
1843 log format, or "changelog" if the log conforms
1844 to the obsolete \fIchangelog\fP format. If the
1846 parameter is omitted or set to "default" then the log parameters are
1850 .B olcUpdateDN: <dn>
1851 This option is only applicable in a slave
1853 It specifies the DN permitted to update (subject to access controls)
1854 the replica. It is only needed in certain push-mode
1855 replication scenarios. Generally, this DN
1861 .B olcUpdateRef: <url>
1862 Specify the referral to pass back when
1864 is asked to modify a replicated local database.
1865 If multiple values are specified, each url is provided.
1867 .SH DATABASE-SPECIFIC OPTIONS
1868 Each database may allow specific configuration options; they are
1869 documented separately in the backends' manual pages. See the
1870 .BR slapd.backends (5)
1871 manual page for an overview of available backends.
1873 An overlay is a piece of
1874 code that intercepts database operations in order to extend or change
1875 them. Overlays are pushed onto
1876 a stack over the database, and so they will execute in the reverse
1877 of the order in which they were configured and the database itself
1878 will receive control last of all.
1880 Overlays must be configured as child entries of a specific database. The
1881 entry's RDN must be of the form
1882 .B olcOverlay={x}<overlaytype>
1883 and the entry must have the olcOverlayConfig objectClass. Normally the
1884 config engine generates the "{x}" index in the RDN automatically, so
1885 it can be omitted when initially loading these entries.
1888 .BR slapd.overlays (5)
1889 manual page for an overview of available overlays.
1892 Here is a short example of a configuration in LDIF suitable for use with
1899 objectClass: olcGlobal
1901 olcPidFile: LOCALSTATEDIR/run/slapd.pid
1902 olcAttributeOptions: x\-hidden lang\-
1904 dn: cn=schema,cn=config
1905 objectClass: olcSchemaConfig
1908 include: SYSCONFDIR/schema/core.ldif
1910 dn: olcDatabase=frontend,cn=config
1911 objectClass: olcDatabaseConfig
1912 objectClass: olcFrontendConfig
1913 olcDatabase: frontend
1914 # Subtypes of "name" (e.g. "cn" and "ou") with the
1915 # option ";x\-hidden" can be searched for/compared,
1916 # but are not shown. See \fBslapd.access\fP(5).
1917 olcAccess: to attrs=name;x\-hidden by * =cs
1918 # Protect passwords. See \fBslapd.access\fP(5).
1919 olcAccess: to attrs=userPassword by * auth
1920 # Read access to other attributes and entries.
1921 olcAccess: to * by * read
1923 # set a rootpw for the config database so we can bind.
1924 # deny access to everyone else.
1925 dn: olcDatabase=config,cn=config
1926 objectClass: olcDatabaseConfig
1928 olcRootPW: {SSHA}XKYnrjvGT3wZFQrDD5040US592LxsdLy
1929 olcAccess: to * by * none
1931 dn: olcDatabase=bdb,cn=config
1932 objectClass: olcDatabaseConfig
1933 objectClass: olcBdbConfig
1935 olcSuffix: "dc=our\-domain,dc=com"
1936 # The database directory MUST exist prior to
1937 # running slapd AND should only be accessible
1938 # by the slapd/tools. Mode 0700 recommended.
1939 olcDbDirectory: LOCALSTATEDIR/openldap\-data
1940 # Indices to maintain
1941 olcDbIndex: objectClass eq
1942 olcDbIndex: cn,sn,mail pres,eq,approx,sub
1944 # We serve small clients that do not handle referrals,
1945 # so handle remote lookups on their behalf.
1946 dn: olcDatabase=ldap,cn=config
1947 objectClass: olcDatabaseConfig
1948 objectClass: olcLdapConfig
1951 olcDbUri: ldap://ldap.some\-server.com/
1955 Assuming the above data was saved in a file named "config.ldif" and the
1956 ETCDIR/slapd.d directory has been created, this command will initialize
1960 slapadd \-F ETCDIR/slapd.d \-n 0 \-l config.ldif
1965 "OpenLDAP Administrator's Guide" contains a longer annotated
1966 example of a slapd configuration.
1968 Alternatively, an existing slapd.conf file can be converted to the new
1969 format using slapd or any of the slap tools:
1972 slaptest \-f ETCDIR/slapd.conf \-F ETCDIR/slapd.d
1979 default slapd configuration file
1982 default slapd configuration directory
1986 .BR slapd.access (5),
1987 .BR slapd.backends (5),
1989 .BR slapd.overlays (5),
1990 .BR slapd.plugin (5),
1991 .BR slapd.replog (5),
2002 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
2003 .SH ACKNOWLEDGEMENTS