1 .TH SLAPD-CONFIG 5 "RELEASEDATE" "OpenLDAP LDVERSION"
2 .\" Copyright 1998-2007 The OpenLDAP Foundation All Rights Reserved.
3 .\" Copying restrictions apply. See COPYRIGHT/LICENSE.
6 slapd-config \- configuration backend
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 options
148 if started without the debugging command line option.
150 .B olcAttributeOptions: <option-name>...
151 Define tagging attribute options or option tag/range prefixes.
152 Options must not end with `-', prefixes must end with `-'.
153 The `lang-' prefix is predefined.
155 .B olcAttributeOptions
156 directive, `lang-' will no longer be defined and you must specify it
157 explicitly if you want it defined.
159 An attribute description with a tagging option is a subtype of that
160 attribute description without the option.
161 Except for that, options defined this way have no special semantics.
162 Prefixes defined this way work like the `lang-' options:
163 They define a prefix for tagging options starting with the prefix.
164 That is, if you define the prefix `x-foo-', you can use the option
166 Furthermore, in a search or compare, a prefix or range name (with
167 a trailing `-') matches all options starting with that name, as well
168 as the option with the range name sans the trailing `-'.
169 That is, `x-foo-bar-' matches `x-foo-bar' and `x-foo-bar-baz'.
171 RFC 4520 reserves options beginning with `x-' for private experiments.
172 Other options should be registered with IANA, see RFC 4520 section 3.5.
173 OpenLDAP also has the `binary' option built in, but this is a transfer
174 option, not a tagging option.
176 .B olcAuthzPolicy: <policy>
177 Used to specify which rules to use for Proxy Authorization. Proxy
178 authorization allows a client to authenticate to the server using one
179 user's credentials, but specify a different identity to use for authorization
180 and access control purposes. It essentially allows user A to login as user
181 B, using user A's password.
184 flag disables proxy authorization. This is the default setting.
187 flag will use rules in the
189 attribute of the authorization DN.
192 flag will use rules in the
194 attribute of the authentication DN.
197 flag, an alias for the deprecated value of
199 will allow any of the above, whatever succeeds first (checked in
205 flag requires both authorizations to succeed.
208 The rules are mechanisms to specify which identities are allowed
209 to perform proxy authorization.
212 attribute in an entry specifies which other users
213 are allowed to proxy login to this entry. The
216 an entry specifies which other users this user can authorize as. Use of
219 abused if users are allowed to write arbitrary values to this attribute.
222 attribute must be protected with ACLs such that
223 only privileged users can modify it.
230 or a set of identities; it can take five forms:
233 .B ldap:///<base>??[<scope>]?<filter>
236 .B dn[.<dnstyle>]:<pattern>
239 .B u[<mech>[<realm>]]:<pattern>
242 .B group[/objectClass[/attributeType]]:<pattern>
249 .B <dnstyle>:={exact|onelevel|children|subtree|regex}
252 The first form is a valid LDAP
260 portions must be absent, so that the search occurs locally on either
266 with the optional style modifiers
272 for exact, onelevel, children and subtree matches, which cause
274 to be normalized according to the DN normalization rules, or the special
276 style, which causes the
278 to be treated as a POSIX (''extended'') regular expression, as
285 means any non-anonymous DN.
286 The third form is a SASL
288 with the optional fields
292 that allow to specify a SASL
294 and eventually a SASL
296 for those mechanisms that support one.
297 The need to allow the specification of a mechanism is still debated,
298 and users are strongly discouraged to rely on this possibility.
299 The fourth form is a group specification, consisting of the keyword
301 optionally followed by the specification of the group
307 is searched with base scope, and in case of match, the values of the
310 are searched for the asserted DN.
311 For backwards compatibility, if no identity type is provided, i.e. only
315 is assumed; as a consequence,
317 is subjected to DN normalization.
318 Since the interpretation of
322 can impact security, users are strongly encouraged
323 to explicitly set the type of identity specification that is being used.
324 A subset of these rules can be used as third arg in the
326 statement (see below); significantly, the
333 .B olcAuthzRegexp: <match> <replace>
334 Used by the authentication framework to convert simple user names,
335 such as provided by SASL subsystem, to an LDAP DN used for
336 authorization purposes. Note that the resultant DN need not refer
337 to an existing entry to be considered valid. When an authorization
338 request is received from the SASL subsystem, the SASL
343 are taken, when available, and combined into a name of the form
347 .B UID=<username>[[,CN=<realm>],CN=<mechanism>],CN=auth
350 This name is then compared against the
352 POSIX (''extended'') regular expression, and if the match is successful,
353 the name is replaced with the
355 string. If there are wildcard strings in the
357 regular expression that are enclosed in parenthesis, e.g.
363 then the portion of the name that matched the wildcard will be stored
364 in the numbered placeholder variable $1. If there are other wildcard strings
365 in parenthesis, the matching strings will be in $2, $3, etc. up to $9. The
366 placeholders can then be used in the
371 .B UID=$1,OU=Accounts,DC=example,DC=com
374 The replaced name can be either a DN, i.e. a string prefixed by "dn:",
376 If the latter, the server will use the URI to search its own database(s)
377 and, if the search returns exactly one entry, the name is
378 replaced by the DN of that entry. The LDAP URI must have no
379 hostport, attrs, or extensions components, but the filter is mandatory,
383 .B ldap:///OU=Accounts,DC=example,DC=com??one?(UID=$1)
386 The protocol portion of the URI must be strictly
388 Note that this search is subject to access controls. Specifically,
389 the authentication identity must have "auth" access in the subject.
393 values can be specified to allow for multiple matching
394 and replacement patterns. The matching patterns are checked in the order they
395 appear in the attribute, stopping at the first successful match.
398 .\"Because the plus sign + is a character recognized by the regular expression engine,
399 .\"and it will appear in names that include a REALM, be careful to escape the
400 .\"plus sign with a backslash \\+ to remove the character's special meaning.
403 .B olcConcurrency: <integer>
404 Specify a desired level of concurrency. Provided to the underlying
405 thread system as a hint. The default is not to provide any hint. This setting
406 is only meaningful on some platforms where there is not a one to one
407 correspondence between user threads and kernel threads.
409 .B olcConnMaxPending: <integer>
410 Specify the maximum number of pending requests for an anonymous session.
411 If requests are submitted faster than the server can process them, they
412 will be queued up to this limit. If the limit is exceeded, the session
413 is closed. The default is 100.
415 .B olcConnMaxPendingAuth: <integer>
416 Specify the maximum number of pending requests for an authenticated session.
419 .B olcDisallows: <features>
420 Specify a set of features to disallow (default none).
422 disables acceptance of anonymous bind requests. Note that this setting
423 does not prohibit anonymous directory access (See "require authc").
425 disables simple (bind) authentication.
427 disables forcing session to anonymous status (see also
429 upon StartTLS operation receipt.
431 disallows the StartTLS operation if authenticated (see also
434 .B olcGentleHUP: { TRUE | FALSE }
435 A SIGHUP signal will only cause a 'gentle' shutdown-attempt:
437 will stop listening for new connections, but will not close the
438 connections to the current clients. Future write operations return
439 unwilling-to-perform, though. Slapd terminates when all clients
440 have closed their connections (if they ever do), or \- as before \-
441 if it receives a SIGTERM signal. This can be useful if you wish to
442 terminate the server and start a new
445 .B with another database,
446 without disrupting the currently active clients.
447 The default is FALSE. You may wish to use
449 along with this option.
451 .B olcIdleTimeout: <integer>
452 Specify the number of seconds to wait before forcibly closing
453 an idle client connection. A setting of 0 disables this
454 feature. The default is 0.
456 .B olcIndexSubstrIfMaxlen: <integer>
457 Specify the maximum length for subinitial and subfinal indices. Only
458 this many characters of an attribute value will be processed by the
459 indexing functions; any excess characters are ignored. The default is 4.
461 .B olcIndexSubstrIfMinlen: <integer>
462 Specify the minimum length for subinitial and subfinal indices. An
463 attribute value must have at least this many characters in order to be
464 processed by the indexing functions. The default is 2.
466 .B olcIndexSubstrAnyLen: <integer>
467 Specify the length used for subany indices. An attribute value must have
468 at least this many characters in order to be processed. Attribute values
469 longer than this length will be processed in segments of this length. The
470 default is 4. The subany index will also be used in subinitial and
471 subfinal index lookups when the filter string is longer than the
472 .I olcIndexSubstrIfMaxlen
475 .B olcIndexSubstrAnyStep: <integer>
476 Specify the steps used in subany index lookups. This value sets the offset
477 for the segments of a filter string that are processed for a subany index
478 lookup. The default is 2. For example, with the default values, a search
479 using this filter "cn=*abcdefgh*" would generate index lookups for
480 "abcd", "cdef", and "efgh".
483 .B olcLocalSSF: <SSF>
484 Specifies the Security Strength Factor (SSF) to be given local LDAP sessions,
485 such as those to the ldapi:// listener. For a description of SSF values,
487 .BR olcSaslSecProps 's
489 option description. The default is 71.
491 .B olcLogFile: <filename>
492 Specify a file for recording debug log messages. By default these messages
493 only go to stderr and are not recorded anywhere else. Specifying a logfile
494 copies messages to both stderr and the logfile.
496 .B olcLogLevel: <integer> [...]
497 Specify the level at which debugging statements and operation
498 statistics should be syslogged (currently logged to the
500 LOG_LOCAL4 facility).
501 They must be considered subsystems rather than increasingly verbose
503 Some messages with higher priority are logged regardless
504 of the configured loglevel as soon as any logging is configured.
505 Log levels are additive, and available levels are:
516 debug packet handling
520 heavy trace debugging (function args)
524 connection management
528 print out packets sent and received
532 search filter processing
536 configuration file processing
540 access control list processing
544 stats log connections/operations/results
548 stats log entries sent
552 print communication with shell backends
564 \"data indexing (unused)
572 only messages that get logged whatever log level is set
575 The desired log level can be input as a single integer that combines
576 the (ORed) desired levels, both in decimal or in hexadecimal notation,
577 as a list of integers (that are ORed internally),
578 or as a list of the names that are shown between brackets, such that
584 olcLogLevel: 0x80 0x1
585 olcLogLevel: acl trace
591 can be used as a shortcut to enable logging at all levels (equivalent to -1).
594 or the equivalent integer representation, causes those messages
595 that are logged regardless of the configured olcLogLevel to be logged.
596 In fact, if no olcLogLevel (or a 0 level) is defined, no logging occurs,
599 level is required to have high priority messages logged.
602 .B olcPasswordCryptSaltFormat: <format>
603 Specify the format of the salt passed to
605 when generating {CRYPT} passwords (see
606 .BR olcPasswordHash )
607 during processing of LDAP Password Modify Extended Operations (RFC 3062).
609 This string needs to be in
611 format and may include one (and only one) %s conversion.
612 This conversion will be substituted with a string of random
613 characters from [A\-Za\-z0\-9./]. For example, "%.2s"
614 provides a two character salt and "$1$%.8s" tells some
615 versions of crypt(3) to use an MD5 algorithm and provides
616 8 random characters of salt. The default is "%s", which
617 provides 31 characters of salt.
619 .B olcPasswordHash: <hash> [<hash>...]
620 This option configures one or more hashes to be used in generation of user
621 passwords stored in the userPassword attribute during processing of
622 LDAP Password Modify Extended Operations (RFC 3062).
623 The <hash> must be one of
637 use the SHA-1 algorithm (FIPS 160-1), the latter with a seed.
642 use the MD5 algorithm (RFC 1321), the latter with a seed.
649 indicates that the new password should be
650 added to userPassword as clear text.
652 Note that this option does not alter the normal user applications
653 handling of userPassword during LDAP Add, Modify, or other LDAP operations.
655 .B olcPidFile: <filename>
656 The ( absolute ) name of a file that will hold the
658 server's process ID ( see
660 ) if started without the debugging command line option.
662 .B olcPluginLogFile: <filename>
663 The ( absolute ) name of a file that will contain log
670 .B olcReferral: <url>
671 Specify the referral to pass back when
673 cannot find a local database to handle a request.
674 If multiple values are specified, each url is provided.
675 .\" slurpd-related keywords are all deprecated
677 .\".B replica-argsfile
678 .\"The ( absolute ) name of a file that will hold the
680 .\"server's command line options
681 .\"if started without the debugging command line option.
682 .\"If it appears after a
684 .\"directive, the args file is specific to the
686 .\"instance that handles that replication log.
688 .\".B replica-pidfile
689 .\"The ( absolute ) name of a file that will hold the
691 .\"server's process ID ( see
693 .\") if started without the debugging command line option.
694 .\"If it appears after a
696 .\"directive, the pid file is specific to the
698 .\"instance that handles that replication log.
700 .\".B replicationinterval
701 .\"The number of seconds
703 .\"waits before checking the replogfile for changes.
704 .\"If it appears after a
706 .\"directive, the replication interval is specific to the
708 .\"instance that handles that replication log.
710 .B olcReverseLookup: TRUE | FALSE
711 Enable/disable client name unverified reverse lookup (default is
713 if compiled with --enable-rlookups).
715 .B olcRootDSE: <file>
716 Specify the name of an LDIF(5) file containing user defined attributes
717 for the root DSE. These attributes are returned in addition to the
718 attributes normally produced by slapd.
720 .B olcSaslHost: <fqdn>
721 Used to specify the fully qualified domain name used for SASL processing.
723 .B olcSaslRealm: <realm>
724 Specify SASL realm. Default is empty.
726 .B olcSaslSecProps: <properties>
727 Used to specify Cyrus SASL security properties.
730 flag (without any other properties) causes the flag properties
731 default, "noanonymous,noplain", to be cleared.
734 flag disables mechanisms susceptible to simple passive attacks.
737 flag disables mechanisms susceptible to active attacks.
740 flag disables mechanisms susceptible to passive dictionary attacks.
743 flag disables mechanisms which support anonymous login.
746 flag require forward secrecy between sessions.
749 require mechanisms which pass client credentials (and allow
750 mechanisms which can pass credentials to do so).
753 property specifies the minimum acceptable
754 .I security strength factor
755 as an integer approximate to effective key length used for
756 encryption. 0 (zero) implies no protection, 1 implies integrity
757 protection only, 56 allows DES or other weak ciphers, 112
758 allows triple DES and other strong ciphers, 128 allows RC4,
759 Blowfish and other modern strong ciphers. The default is 0.
762 property specifies the maximum acceptable
763 .I security strength factor
764 as an integer (see minssf description). The default is INT_MAX.
767 property specifies the maximum security layer receive buffer
768 size allowed. 0 disables security layers. The default is 65536.
770 .B olcServerID: <integer> [<URL>]
771 Specify an integer ID from 0 to 4095 for this server. These IDs are
772 required when using multimaster replication and each master must have a
773 unique ID. If the URL is provided, this directive may be specified
774 multiple times, providing a complete list of participating servers
775 and their IDs. The fully qualified hostname of each server should be
776 used in the supplied URLs. The IDs are used in the "replica id" field
777 of all CSNs generated by the specified server. The default value is zero.
781 olcServerID: 1 ldap://ldap1.example.com
782 olcServerID: 2 ldap://ldap2.example.com
785 .B olcSockbufMaxIncoming: <integer>
786 Specify the maximum incoming LDAP PDU size for anonymous sessions.
787 The default is 262143.
789 .B olcSockbufMaxIncomingAuth: <integer>
790 Specify the maximum incoming LDAP PDU size for authenticated sessions.
791 The default is 4194303.
793 .B olcThreads: <integer>
794 Specify the maximum size of the primary thread pool.
795 The default is 16; the minimum value is 2.
797 .B olcToolThreads: <integer>
798 Specify the maximum number of threads to use in tool mode.
799 This should not be greater than the number of CPUs in the system.
801 .\"ucdata-path is obsolete / ignored...
803 .\".B ucdata-path <path>
804 .\"Specify the path to the directory containing the Unicode character
805 .\"tables. The default path is DATADIR/ucdata.
809 is built with support for Transport Layer Security, there are more options
812 .B olcTLSCipherSuite: <cipher-suite-spec>
813 Permits configuring what ciphers will be accepted and the preference order.
814 <cipher-suite-spec> should be a cipher specification for OpenSSL. Example:
816 olcTLSCipherSuite: HIGH:MEDIUM:+SSLv2
818 To check what ciphers a given spec selects, use:
820 openssl ciphers -v <cipher-suite-spec>
822 .B olcTLSCACertificateFile: <filename>
823 Specifies the file that contains certificates for all of the Certificate
828 .B olcTLSCACertificatePath: <path>
829 Specifies the path of a directory that contains Certificate Authority
830 certificates in separate individual files. Usually only one of this
831 or the olcTLSCACertificateFile is defined. If both are specified, both
832 locations will be used.
834 .B olcTLSCertificateFile: <filename>
835 Specifies the file that contains the
839 .B olcTLSCertificateKeyFile: <filename>
840 Specifies the file that contains the
842 server private key that matches the certificate stored in the
843 .B olcTLSCertificateFile
844 file. If the private key is protected with a password, the password must
845 be manually typed in when slapd starts. Usually the private key is not
846 protected with a password, to allow slapd to start without manual
848 it is of critical importance that the file is protected carefully.
850 .B olcTLSDHParamFile: <filename>
851 This directive specifies the file that contains parameters for Diffie-Hellman
852 ephemeral key exchange. This is required in order to use a DSA certificate on
853 the server. If multiple sets of parameters are present in the file, all of
854 them will be processed. Note that setting this option may also enable
855 Anonymous Diffie-Hellman key exchanges in certain non-default cipher suites.
856 You should append "!ADH" to your cipher suites if you have changed them
857 from the default, otherwise no certificate exchanges or verification will
860 .B olcTLSRandFile: <filename>
861 Specifies the file to obtain random bits from when /dev/[u]random
862 is not available. Generally set to the name of the EGD/PRNGD socket.
863 The environment variable RANDFILE can also be used to specify the filename.
865 .B olcTLSVerifyClient: <level>
866 Specifies what checks to perform on client certificates in an
867 incoming TLS session, if any.
870 can be specified as one of the following keywords:
876 will not ask the client for a certificate.
879 The client certificate is requested. If no certificate is provided,
880 the session proceeds normally. If a bad certificate is provided,
881 it will be ignored and the session proceeds normally.
884 The client certificate is requested. If no certificate is provided,
885 the session proceeds normally. If a bad certificate is provided,
886 the session is immediately terminated.
888 .B demand | hard | true
889 These keywords are all equivalent, for compatibility reasons.
890 The client certificate is requested. If no certificate is provided,
891 or a bad certificate is provided, the session is immediately terminated.
893 Note that a valid client certificate is required in order to use the
894 SASL EXTERNAL authentication mechanism with a TLS session. As such,
896 .B olcTLSVerifyClient
897 setting must be chosen to enable SASL EXTERNAL authentication.
900 .B olcTLSCRLCheck: <level>
901 Specifies if the Certificate Revocation List (CRL) of the CA should be
902 used to verify if the client certificates have not been revoked. This
904 .B olcTLSCACertificatePath
907 can be specified as one of the following keywords:
911 No CRL checks are performed
914 Check the CRL of the peer certificate
917 Check the CRL for a whole certificate chain
919 .SH DYNAMIC MODULE OPTIONS
922 is compiled with --enable-modules then the module-related entries will
923 be available. These entries are named
924 .B cn=module{x},cn=config
926 must have the olcModuleList objectClass. One entry should be created
929 Normally the config engine generates the "{x}" index in the RDN
930 automatically, so it can be omitted when initially loading these entries.
932 .B olcModuleLoad: <filename>
933 Specify the name of a dynamically loadable module to load. The filename
934 may be an absolute path name or a simple filename. Non-absolute names
935 are searched for in the directories specified by the
939 .B olcModulePath: <pathspec>
940 Specify a list of directories to search for loadable modules. Typically
941 the path is colon-separated but this depends on the operating system.
943 Schema definitions are created as entries in the
944 .B cn=schema,cn=config
945 subtree. These entries must have the olcSchemaConfig objectClass.
946 As noted above, the actual
947 .B cn=schema,cn=config
948 entry is predefined and any values specified for it are ignored.
952 .B olcAttributetypes: "(\ <oid>\
954 [DESC\ <description>]\
963 [NO\-USER\-MODIFICATION]\
964 [USAGE\ <attributeUsage>]\ )"
966 Specify an attribute type using the LDAPv3 syntax defined in RFC 4512.
967 The slapd parser extends the RFC 4512 definition by allowing string
968 forms as well as numeric OIDs to be used for the attribute OID and
969 attribute syntax OID.
971 .B olcObjectIdentifier
977 .B olcDitContentRules: "(\ <oid>\
979 [DESC\ <description>]\
986 Specify an DIT Content Rule using the LDAPv3 syntax defined in RFC 4512.
987 The slapd parser extends the RFC 4512 definition by allowing string
988 forms as well as numeric OIDs to be used for the attribute OID and
989 attribute syntax OID.
991 .B olcObjectIdentifier
997 .B olcObjectClasses: "(\ <oid>\
999 [DESC\ <description>]\
1002 [{ ABSTRACT | STRUCTURAL | AUXILIARY }]\
1003 [MUST\ <oids>] [MAY\ <oids>] )"
1005 Specify an objectclass using the LDAPv3 syntax defined in RFC 4512.
1006 The slapd parser extends the RFC 4512 definition by allowing string
1007 forms as well as numeric OIDs to be used for the object class OID.
1011 description.) Object classes are "STRUCTURAL" by default.
1014 .B olcObjectIdentifier: <name> "{ <oid> | <name>[:<suffix>] }"
1015 Define a string name that equates to the given OID. The string can be used
1016 in place of the numeric OID in objectclass and attribute definitions. The
1017 name can also be used with a suffix of the form ":xx" in which case the
1018 value "oid.xx" will be used.
1020 .SH GENERAL BACKEND OPTIONS
1021 Options in these entries only apply to the configuration of a single
1022 type of backend. All backends may support this class of options.
1023 The entry must be named
1024 .B olcBackend=<databasetype>,cn=config
1025 and must have the olcBackendConfig objectClass.
1043 At present, no backend implements any options of this type.
1045 .SH DATABASE OPTIONS
1046 Database options are set in entries named
1047 .B olcDatabase={x}<databasetype>,cn=config
1048 and must have the olcDatabaseConfig objectClass. Normally the config
1049 engine generates the "{x}" index in the RDN automatically, so it
1050 can be omitted when initially loading these entries.
1052 The special frontend database is always numbered "{-1}" and the config
1053 database is always numbered "{0}".
1055 .SH GLOBAL DATABASE OPTIONS
1056 Options in this section may be set in the special "frontend" database
1057 and inherited in all the other databases. These options may be altered
1058 by further settings in each specific database. The frontend entry must
1060 .B olcDatabase=frontend,cn=config
1061 and must have the olcFrontendConfig objectClass.
1063 .B olcAccess: to <what> "[ by <who> <access> <control> ]+"
1064 Grant access (specified by <access>) to a set of entries and/or
1065 attributes (specified by <what>) by one or more requestors (specified
1067 If no access controls are present, the default policy
1068 allows anyone and everyone to read anything but restricts
1069 updates to rootdn. (e.g., "olcAccess: to * by * read").
1071 .BR slapd.access (5)
1072 and the "OpenLDAP Administrator's Guide" for details.
1074 Access controls set in the frontend are appended to any access
1075 controls set on the specific databases.
1076 The rootdn of a database can always read and write EVERYTHING
1079 Extra special care must be taken with the access controls on the
1080 config database. Unlike other databases, the default policy for the
1081 config database is to only allow access to the rootdn. Regular users
1082 should not have read access, and write access should be granted very
1083 carefully to privileged administrators.
1086 .B olcDefaultSearchBase: <dn>
1087 Specify a default search base to use when client submits a
1088 non-base search request with an empty base DN.
1089 Base scoped search requests with an empty base DN are not affected.
1090 This setting is only allowed in the frontend entry.
1092 .B olcReadOnly: TRUE | FALSE
1093 This option puts the database into "read-only" mode. Any attempts to
1094 modify the database will return an "unwilling to perform" error. By
1095 default, olcReadOnly is FALSE. Note that when this option is set
1096 TRUE on the frontend, it cannot be reset without restarting the
1097 server, since further writes to the config database will be rejected.
1099 .B olcRequires: <conditions>
1100 Specify a set of conditions to require (default none).
1101 The directive may be specified globally and/or per-database;
1102 databases inherit global conditions, so per-database specifications
1105 requires bind operation prior to directory operations.
1107 requires session to be using LDAP version 3.
1109 requires authentication prior to directory operations.
1111 requires SASL authentication prior to directory operations.
1113 requires strong authentication prior to directory operations.
1114 The strong keyword allows protected "simple" authentication
1115 as well as SASL authentication.
1117 may be used to require no conditions (useful to clear out globally
1118 set conditions within a particular database); it must occur first
1119 in the list of conditions.
1121 .B olcRestrict: <oplist>
1122 Specify a list of operations that are restricted.
1123 Restrictions on a specific database override any frontend setting.
1124 Operations can be any of
1129 .BR extended[=<OID>] ,
1133 or the special pseudo-operations
1137 which respectively summarize read and write operations.
1141 .I olcReadOnly: TRUE
1145 keyword allows to indicate the OID of the specific operation
1148 .B olcSchemaDN: <dn>
1149 Specify the distinguished name for the subschema subentry that
1150 controls the entries on this server. The default is "cn=Subschema".
1152 .B olcSecurity: <factors>
1153 Specify a set of security strength factors (separated by white space)
1155 .BR olcSaslSecprops 's
1157 option for a description of security strength factors).
1158 The directive may be specified globally and/or per-database.
1160 specifies the overall security strength factor.
1162 specifies the transport security strength factor.
1164 specifies the TLS security strength factor.
1166 specifies the SASL security strength factor.
1168 specifies the overall security strength factor to require for
1170 .B update_transport=<n>
1171 specifies the transport security strength factor to require for
1174 specifies the TLS security strength factor to require for
1177 specifies the SASL security strength factor to require for
1180 specifies the security strength factor required for
1182 username/password authentication.
1185 factor is measure of security provided by the underlying transport,
1186 e.g. ldapi:// (and eventually IPSEC). It is not normally used.
1188 .B olcSizeLimit: {<integer>|unlimited}
1190 .B olcSizeLimit: size[.{soft|hard|unchecked}]=<integer> [...]
1191 Specify the maximum number of entries to return from a search operation.
1192 The default size limit is 500.
1195 to specify no limits.
1196 The second format allows a fine grain setting of the size limits.
1197 Extra args can be added in the same value or as additional values.
1200 for an explanation of the different flags.
1202 .B olcTimeLimit: {<integer>|unlimited}
1204 .B olcTimeLimit: time[.{soft|hard}]=<integer> [...]
1205 Specify the maximum number of seconds (in real time)
1207 will spend answering a search request. The default time limit is 3600.
1210 to specify no limits.
1211 The second format allows a fine grain setting of the time limits.
1212 Extra args can be added in the same value or as additional values.
1215 for an explanation of the different flags.
1217 .SH GENERAL DATABASE OPTIONS
1218 Options in this section only apply to the specific database for
1219 which they are defined. They are supported by every
1220 type of backend. All of the Global Database Options may also be
1223 .B olcHidden: TRUE | FALSE
1224 Controls whether the database will be used to answer
1225 queries. A database that is hidden will never be
1226 selected to answer any queries, and any suffix configured
1227 on the database will be ignored in checks for conflicts
1228 with other databases. By default, olcHidden is FALSE.
1230 .B olcLastMod: TRUE | FALSE
1233 will automatically maintain the
1234 modifiersName, modifyTimestamp, creatorsName, and
1235 createTimestamp attributes for entries. It also controls
1236 the entryCSN and entryUUID attributes, which are needed
1237 by the syncrepl provider. By default, olcLastMod is TRUE.
1239 .B olcLimits: <who> <limit> [<limit> [...]]
1240 Specify time and size limits based on who initiated an operation.
1247 anonymous | users | [dn[.<style>]=]<pattern> | group[/oc[/at]]=<pattern>
1253 <style> ::= exact | base | onelevel | subtree | children | regex | anonymous
1258 matches all unauthenticated clients.
1261 matches all authenticated clients;
1264 dn pattern is assumed unless otherwise specified by qualifying
1265 the (optional) key string
1271 (which are synonyms), to require an exact match; with
1273 to require exactly one level of depth match; with
1275 to allow any level of depth match, including the exact match; with
1277 to allow any level of depth match, not including the exact match;
1279 explicitly requires the (default) match based on POSIX (''extended'')
1280 regular expression pattern.
1283 matches unbound operations; the
1286 The same behavior is obtained by using the
1293 with the optional objectClass
1299 sets the limits for any DN listed in the values of the
1305 group objectClass (default
1307 whose DN exactly matches
1310 The currently supported limits are
1315 The syntax for time limits is
1316 .BR time[.{soft|hard}]=<integer> ,
1319 is the number of seconds slapd will spend answering a search request.
1320 If no time limit is explicitly requested by the client, the
1322 limit is used; if the requested time limit exceeds the
1325 .\".I "Administrative limit exceeded"
1326 .\"error is returned.
1327 limit, the value of the limit is used instead.
1330 limit is set to the keyword
1332 the soft limit is used in either case; if it is set to the keyword
1334 no hard limit is enforced.
1335 Explicit requests for time limits smaller or equal to the
1338 If no limit specifier is set, the value is assigned to the
1344 to preserve the original behavior.
1346 The syntax for size limits is
1347 .BR size[.{soft|hard|unchecked}]=<integer> ,
1350 is the maximum number of entries slapd will return answering a search
1352 If no size limit is explicitly requested by the client, the
1354 limit is used; if the requested size limit exceeds the
1357 .\".I "Administrative limit exceeded"
1358 .\"error is returned.
1359 limit, the value of the limit is used instead.
1362 limit is set to the keyword
1364 the soft limit is used in either case; if it is set to the keyword
1366 no hard limit is enforced.
1367 Explicit requests for size limits smaller or equal to the
1372 specifier sets a limit on the number of candidates a search request is allowed
1374 The rationale behind it is that searches for non-properly indexed
1375 attributes may result in large sets of candidates, which must be
1378 to determine whether they match the search filter or not.
1381 limit provides a means to drop such operations before they are even
1383 If the selected candidates exceed the
1385 limit, the search will abort with
1386 .IR "Unwilling to perform" .
1387 If it is set to the keyword
1389 no limit is applied (the default).
1392 the search is not even performed; this can be used to disallow searches
1393 for a specific set of users.
1394 If no limit specifier is set, the value is assigned to the
1400 to preserve the original behavior.
1402 In case of no match, the global limits are used.
1403 The default values are the same as
1412 control is requested, the
1414 size limit is used by default, because the request of a specific page size
1415 is considered an explicit request for a limitation on the number
1416 of entries to be returned.
1417 However, the size limit applies to the total count of entries returned within
1418 the search, and not to a single page.
1419 Additional size limits may be enforced; the syntax is
1420 .BR size.pr={<integer>|noEstimate|unlimited} ,
1423 is the max page size if no explicit limit is set; the keyword
1425 inhibits the server from returning an estimate of the total number
1426 of entries that might be returned
1427 (note: the current implementation does not return any estimate).
1430 indicates that no limit is applied to the pagedResults control page size.
1432 .B size.prtotal={<integer>|unlimited|disabled}
1433 allows to set a limit on the total number of entries that a pagedResults
1434 control allows to return.
1435 By default it is set to the
1440 is the max number of entries that the whole search with pagedResults control
1444 to allow unlimited number of entries to be returned, e.g. to allow
1445 the use of the pagedResults control as a means to circumvent size
1446 limitations on regular searches; the keyword
1448 disables the control, i.e. no paged results can be returned.
1449 Note that the total number of entries returned when the pagedResults control
1450 is requested cannot exceed the
1452 size limit of regular searches unless extended by the
1457 .B olcMaxDerefDepth: <depth>
1458 Specifies the maximum number of aliases to dereference when trying to
1459 resolve an entry, used to avoid infinite alias loops. The default is 1.
1461 .B olcMirrorMode: TRUE | FALSE
1462 This option puts a replica database into "mirror" mode. Update
1463 operations will be accepted from any user, not just the updatedn. The
1464 database must already be configured as syncrepl consumer
1465 before this keyword may be set. This mode must be used with extreme
1466 care, as it does not offer any consistency guarantees. This feature
1467 is intended to be used with an external frontend that guarantees that
1468 writes are only directed to a single master, switching to an alternate
1469 server only if the original master goes down.
1470 By default, this setting is FALSE.
1472 .B olcPlugin: <plugin_type> <lib_path> <init_function> [<arguments>]
1473 Configure a SLAPI plugin. See the
1474 .BR slapd.plugin (5)
1475 manpage for more details.
1478 .\".B replica uri=ldap[s]://<hostname>[:port]|host=<hostname>[:port]
1479 .\".B [starttls=yes|critical]
1480 .\".B [suffix=<suffix> [...]]
1481 .\".B bindmethod=simple|sasl [binddn=<simple DN>] [credentials=<simple password>]
1482 .\".B [saslmech=<SASL mech>] [secprops=<properties>] [realm=<realm>]
1483 .\".B [authcId=<authentication ID>] [authzId=<authorization ID>]
1484 .\".B [attrs[!]=<attr list>]
1486 .\"Specify a replication site for this database. Refer to the "OpenLDAP
1487 .\"Administrator's Guide" for detailed information on setting up a replicated
1489 .\"directory service. Zero or more
1491 .\"instances can be used to select the subtrees that will be replicated
1492 .\"(defaults to all the database).
1494 .\"is deprecated in favor of the
1498 .\"allows the replica LDAP server to be specified as an LDAP URI.
1503 .\"requires the options
1507 .\"and should only be used when adequate security services
1508 .\"(e.g TLS or IPSEC) are in place. A
1512 .\"requires the option
1514 .\"Specific security properties (as with the
1516 .\"keyword above) for a SASL bind can be set with the
1518 .\"option. A non-default SASL realm can be set with the
1523 .\"will use Kerberos, a kerberos instance should be given in
1527 .\"can be given after the
1529 .\"keyword to allow the selective replication of the listed attributes only;
1532 .\"mark is used, the list is considered exclusive, i.e. the listed attributes
1533 .\"are not replicated.
1534 .\"If an objectClass is listed, all the related attributes
1535 .\"are (are not) replicated.
1538 .\".B replogfile <filename>
1539 .\"Specify the name of the replication log file to log changes to.
1540 .\"The replication log is typically written by
1545 .\".BR slapd.replog (5)
1546 .\"for more information. The specified file should be located
1547 .\"in a directory with limited read/write/execute access as the replication
1548 .\"logs may contain sensitive information.
1551 Specify the distinguished name that is not subject to access control
1552 or administrative limit restrictions for operations on this database.
1553 This DN may or may not be associated with an entry. An empty root
1554 DN (the default) specifies no root access is to be granted. It is
1555 recommended that the rootdn only be specified when needed (such as
1556 when initially populating a database). If the rootdn is within
1557 a namingContext (suffix) of the database, a simple bind password
1558 may also be provided using the
1560 directive. Note that the rootdn is always needed when using syncrepl.
1562 .B olcRootPW: <password>
1563 Specify a password (or hash of the password) for the rootdn. The
1564 password can only be set if the rootdn is within the namingContext
1565 (suffix) of the database.
1566 This option accepts all RFC 2307 userPassword formats known to
1569 description) as well as cleartext.
1571 may be used to generate a hash of a password. Cleartext
1572 and \fB{CRYPT}\fP passwords are not recommended. If empty
1573 (the default), authentication of the root DN is by other means
1574 (e.g. SASL). Use of SASL is encouraged.
1576 .B olcSubordinate: [TRUE | FALSE | advertise]
1577 Specify that the current backend database is a subordinate of another
1578 backend database. A subordinate database may have only one suffix. This
1579 option may be used to glue multiple databases into a single namingContext.
1580 If the suffix of the current database is within the namingContext of a
1581 superior database, searches against the superior database will be
1582 propagated to the subordinate as well. All of the databases
1583 associated with a single namingContext should have identical rootdns.
1584 Behavior of other LDAP operations is unaffected by this setting. In
1585 particular, it is not possible to use moddn to move an entry from
1586 one subordinate to another subordinate within the namingContext.
1588 If the optional \fBadvertise\fP flag is supplied, the naming context of
1589 this database is advertised in the root DSE. The default is to hide this
1590 database context, so that only the superior context is visible.
1597 are used on the superior database, any glued subordinates that support
1598 these tools are opened as well.
1600 Databases that are glued together should usually be configured with the
1601 same indices (assuming they support indexing), even for attributes that
1602 only exist in some of these databases. In general, all of the glued
1603 databases should be configured as similarly as possible, since the intent
1604 is to provide the appearance of a single directory.
1606 Note that the subordinate functionality is implemented internally
1607 by the \fIglue\fP overlay and as such its behavior will interact with other
1608 overlays in use. By default, the glue overlay is automatically configured as
1609 the last overlay on the superior database. Its position on the database
1610 can be explicitly configured by setting an \fBoverlay glue\fP directive
1611 at the desired position. This explicit configuration is necessary e.g.
1612 when using the \fIsyncprov\fP overlay, which needs to follow \fIglue\fP
1613 in order to work over all of the glued databases. E.g.
1616 dn: olcDatabase={1}bdb,cn=config
1617 olcSuffix: dc=example,dc=com
1620 dn: olcOverlay={0}glue,olcDatabase={1}bdb,cn=config
1623 dn: olcOverlay={1}syncprov,olcDatabase={1}bdb,cn=config
1627 See the Overlays section below for more details.
1629 .B olcSuffix: <dn suffix>
1630 Specify the DN suffix of queries that will be passed to this
1631 backend database. Multiple suffix lines can be given and at least one is
1632 required for each database definition.
1633 If the suffix of one database is "inside" that of another, the database
1634 with the inner suffix must come first in the configuration file.
1637 .B olcSyncrepl: rid=<replica ID>
1638 .B provider=ldap[s]://<hostname>[:port]
1639 .B searchbase=<base DN>
1640 .B [type=refreshOnly|refreshAndPersist]
1641 .B [interval=dd:hh:mm:ss]
1642 .B [retry=[<retry interval> <# of retries>]+]
1643 .B [filter=<filter str>]
1644 .B [scope=sub|one|base|subord]
1645 .B [attrs=<attr list>]
1646 .B [exattrs=<attr list>]
1648 .B [sizelimit=<limit>]
1649 .B [timelimit=<limit>]
1650 .B [schemachecking=on|off]
1651 .B [bindmethod=simple|sasl]
1653 .B [saslmech=<mech>]
1654 .B [authcid=<identity>]
1655 .B [authzid=<identity>]
1656 .B [credentials=<passwd>]
1658 .B [secprops=<properties>]
1659 .B [starttls=yes|critical]
1660 .B [tls_cert=<file>]
1662 .B [tls_cacert=<file>]
1663 .B [tls_cacertdir=<path>]
1664 .B [tls_reqcert=never|allow|try|demand]
1665 .B [tls_ciphersuite=<ciphers>]
1666 .B [tls_crlcheck=none|peer|all]
1667 .B [logbase=<base DN>]
1668 .B [logfilter=<filter str>]
1669 .B [syncdata=default|accesslog|changelog]
1671 Specify the current database as a replica which is kept up-to-date with the
1672 master content by establishing the current
1674 as a replication consumer site running a
1677 The replica content is kept synchronized to the master content using
1678 the LDAP Content Synchronization protocol. Refer to the
1679 "OpenLDAP Administrator's Guide" for detailed information on
1680 setting up a replicated
1682 directory service using the
1687 identifies the current
1689 directive within the replication consumer site.
1690 It is a non-negative integer having no more than three digits.
1693 specifies the replication provider site containing the master content
1694 as an LDAP URI. If <port> is not given, the standard LDAP port number
1695 (389 or 636) is used.
1699 replica is defined using a search
1700 specification as its result set. The consumer
1702 will send search requests to the provider
1704 according to the search specification. The search specification includes
1705 .B searchbase, scope, filter, attrs, attrsonly, sizelimit,
1708 parameters as in the normal search specification. The
1710 option may also be used to specify attributes that should be omitted
1711 from incoming entries.
1712 The \fBscope\fP defaults to \fBsub\fP, the \fBfilter\fP defaults to
1713 \fB(objectclass=*)\fP, and there is no default \fBsearchbase\fP. The
1714 \fBattrs\fP list defaults to \fB"*,+"\fP to return all user and operational
1715 attributes, and \fBattrsonly\fP and \fBexattrs\fP are unset by default.
1716 The \fBsizelimit\fP and \fBtimelimit\fP only
1717 accept "unlimited" and positive integers, and both default to "unlimited".
1718 Note, however, that any provider-side limits for the replication identity
1719 will be enforced by the provider regardless of the limits requested
1720 by the LDAP Content Synchronization operation, much like for any other
1723 The LDAP Content Synchronization protocol has two operation types.
1726 operation, the next synchronization search operation
1727 is periodically rescheduled at an interval time (specified by
1729 parameter; 1 day by default)
1730 after each synchronization operation finishes.
1732 .B refreshAndPersist
1733 operation, a synchronization search remains persistent in the provider slapd.
1734 Further updates to the master replica will generate
1735 .B searchResultEntry
1736 to the consumer slapd as the search responses to the persistent
1737 synchronization search.
1739 If an error occurs during replication, the consumer will attempt to
1740 reconnect according to the
1742 parameter which is a list of the <retry interval> and <# of retries> pairs.
1743 For example, retry="60 10 300 3" lets the consumer retry every 60 seconds
1744 for the first 10 times and then retry every 300 seconds for the next 3
1745 times before stop retrying. The `+' in <# of retries> means indefinite
1746 number of retries until success.
1748 The schema checking can be enforced at the LDAP Sync
1749 consumer site by turning on the
1751 parameter. The default is off.
1757 requires the options
1761 and should only be used when adequate security services
1762 (e.g. TLS or IPSEC) are in place.
1769 Depending on the mechanism, an authentication identity and/or
1770 credentials can be specified using
1776 parameter may be used to specify an authorization identity.
1777 Specific security properties (as with the
1779 keyword above) for a SASL bind can be set with the
1781 option. A non default SASL realm can be set with the
1784 The provider, other than allow authentication of the syncrepl identity,
1785 should grant that identity appropriate access privileges to the data
1786 that is being replicated (\fBaccess\fP directive), and appropriate time
1787 and size limits (\fBlimits\fP directive).
1792 parameter specifies use of the StartTLS extended operation
1793 to establish a TLS session before Binding to the provider. If the
1795 argument is supplied, the session will be aborted if the StartTLS request
1796 fails. Otherwise the syncrepl session continues without TLS. The
1797 tls_reqcert setting defaults to "demand" and the other TLS settings
1798 default to the same as the main slapd TLS settings.
1800 Rather than replicating whole entries, the consumer can query logs of
1801 data modifications. This mode of operation is referred to as \fIdelta
1802 syncrepl\fP. In addition to the above parameters, the
1806 parameters must be set appropriately for the log that will be used. The
1808 parameter must be set to either "accesslog" if the log conforms to the
1809 .BR slapo-accesslog (5)
1810 log format, or "changelog" if the log conforms
1811 to the obsolete \fIchangelog\fP format. If the
1813 parameter is omitted or set to "default" then the log parameters are
1817 .B olcUpdateDN: <dn>
1818 This option is only applicable in a slave
1820 It specifies the DN permitted to update (subject to access controls)
1821 the replica (typically, this is the DN
1823 binds to update the replica). Generally, this DN
1829 .B olcUpdateRef: <url>
1830 Specify the referral to pass back when
1832 is asked to modify a replicated local database.
1833 If multiple values are specified, each url is provided.
1835 .SH DATABASE-SPECIFIC OPTIONS
1836 Each database may allow specific configuration options; they are
1837 documented separately in the backends' manual pages. See the
1838 .BR slapd.backends (5)
1839 manual page for an overview of available backends.
1841 An overlay is a piece of
1842 code that intercepts database operations in order to extend or change
1843 them. Overlays are pushed onto
1844 a stack over the database, and so they will execute in the reverse
1845 of the order in which they were configured and the database itself
1846 will receive control last of all.
1848 Overlays must be configured as child entries of a specific database. The
1849 entry's RDN must be of the form
1850 .B olcOverlay={x}<overlaytype>
1851 and the entry must have the olcOverlayConfig objectClass. Normally the
1852 config engine generates the "{x}" index in the RDN automatically, so
1853 it can be omitted when initially loading these entries.
1856 .BR slapd.overlays (5)
1857 manual page for an overview of available overlays.
1860 Here is a short example of a configuration in LDIF suitable for use with
1867 objectClass: olcGlobal
1869 olcPidFile: LOCALSTATEDIR/run/slapd.pid
1870 olcAttributeOptions: x-hidden lang-
1872 dn: cn=schema,cn=config
1873 objectClass: olcSchemaConfig
1876 include: SYSCONFDIR/schema/core.ldif
1878 dn: olcDatabase=frontend,cn=config
1879 objectClass: olcDatabaseConfig
1880 objectClass: olcFrontendConfig
1881 olcDatabase: frontend
1882 # Subtypes of "name" (e.g. "cn" and "ou") with the
1883 # option ";x-hidden" can be searched for/compared,
1884 # but are not shown. See \fBslapd.access\fP(5).
1885 olcAccess: to attrs=name;x-hidden by * =cs
1886 # Protect passwords. See \fBslapd.access\fP(5).
1887 olcAccess: to attrs=userPassword by * auth
1888 # Read access to other attributes and entries.
1889 olcAccess: to * by * read
1891 # set a rootpw for the config database so we can bind.
1892 # deny access to everyone else.
1893 dn: olcDatabase=config,cn=config
1894 objectClass: olcDatabaseConfig
1896 olcRootPW: {SSHA}XKYnrjvGT3wZFQrDD5040US592LxsdLy
1897 olcAccess: to * by * none
1899 dn: olcDatabase=bdb,cn=config
1900 objectClass: olcDatabaseConfig
1901 objectClass: olcBdbConfig
1903 olcSuffix: "dc=our-domain,dc=com"
1904 # The database directory MUST exist prior to
1905 # running slapd AND should only be accessible
1906 # by the slapd/tools. Mode 0700 recommended.
1907 olcDbDirectory: LOCALSTATEDIR/openldap-data
1908 # Indices to maintain
1909 olcDbIndex: objectClass eq
1910 olcDbIndex: cn,sn,mail pres,eq,approx,sub
1912 # We serve small clients that do not handle referrals,
1913 # so handle remote lookups on their behalf.
1914 dn: olcDatabase=ldap,cn=config
1915 objectClass: olcDatabaseConfig
1916 objectClass: olcLdapConfig
1919 olcDbUri: ldap://ldap.some-server.com/
1923 Assuming the above data was saved in a file named "config.ldif" and the
1924 ETCDIR/slapd.d directory has been created, this command will initialize
1928 slapadd -F ETCDIR/slapd.d -n 0 -l config.ldif
1933 "OpenLDAP Administrator's Guide" contains a longer annotated
1934 example of a slapd configuration.
1936 Alternatively, an existing slapd.conf file can be converted to the new
1937 format using slapd or any of the slap tools:
1940 slaptest -f ETCDIR/slapd.conf -F ETCDIR/slapd.d
1947 default slapd configuration file
1950 default slapd configuration directory
1954 .BR slapd.access (5),
1955 .BR slapd.backends (5),
1957 .BR slapd.overlays (5),
1958 .BR slapd.plugin (5),
1959 .BR slapd.replog (5),
1971 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
1972 .SH ACKNOWLEDGEMENTS
projects / openldap / blob