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 olcAuthzPolicy: <policy>
176 Used to specify which rules to use for Proxy Authorization. Proxy
177 authorization allows a client to authenticate to the server using one
178 user's credentials, but specify a different identity to use for authorization
179 and access control purposes. It essentially allows user A to login as user
180 B, using user A's password.
183 flag disables proxy authorization. This is the default setting.
186 flag will use rules in the
188 attribute of the authorization DN.
191 flag will use rules in the
193 attribute of the authentication DN.
196 flag, an alias for the deprecated value of
198 will allow any of the above, whatever succeeds first (checked in
204 flag requires both authorizations to succeed.
207 The rules are mechanisms to specify which identities are allowed
208 to perform proxy authorization.
211 attribute in an entry specifies which other users
212 are allowed to proxy login to this entry. The
215 an entry specifies which other users this user can authorize as. Use of
218 abused if users are allowed to write arbitrary values to this attribute.
221 attribute must be protected with ACLs such that
222 only privileged users can modify it.
229 or a set of identities; it can take five forms:
232 .B ldap:///<base>??[<scope>]?<filter>
235 .B dn[.<dnstyle>]:<pattern>
238 .B u[<mech>[<realm>]]:<pattern>
241 .B group[/objectClass[/attributeType]]:<pattern>
248 .B <dnstyle>:={exact|onelevel|children|subtree|regex}
251 The first form is a valid LDAP
259 portions must be absent, so that the search occurs locally on either
265 with the optional style modifiers
271 for exact, onelevel, children and subtree matches, which cause
273 to be normalized according to the DN normalization rules, or the special
275 style, which causes the
277 to be treated as a POSIX (''extended'') regular expression, as
284 means any non-anonymous DN.
285 The third form is a SASL
287 with the optional fields
291 that allow to specify a SASL
293 and eventually a SASL
295 for those mechanisms that support one.
296 The need to allow the specification of a mechanism is still debated,
297 and users are strongly discouraged to rely on this possibility.
298 The fourth form is a group specification, consisting of the keyword
300 optionally followed by the specification of the group
306 is searched with base scope, and in case of match, the values of the
309 are searched for the asserted DN.
310 For backwards compatibility, if no identity type is provided, i.e. only
314 is assumed; as a consequence,
316 is subjected to DN normalization.
317 Since the interpretation of
321 can impact security, users are strongly encouraged
322 to explicitly set the type of identity specification that is being used.
323 A subset of these rules can be used as third arg in the
325 statement (see below); significantly, the
332 .B olcAuthzRegexp: <match> <replace>
333 Used by the authentication framework to convert simple user names,
334 such as provided by SASL subsystem, to an LDAP DN used for
335 authorization purposes. Note that the resultant DN need not refer
336 to an existing entry to be considered valid. When an authorization
337 request is received from the SASL subsystem, the SASL
342 are taken, when available, and combined into a name of the form
346 .B UID=<username>[[,CN=<realm>],CN=<mechanism>],CN=auth
349 This name is then compared against the
351 POSIX (''extended'') regular expression, and if the match is successful,
352 the name is replaced with the
354 string. If there are wildcard strings in the
356 regular expression that are enclosed in parenthesis, e.g.
362 then the portion of the name that matched the wildcard will be stored
363 in the numbered placeholder variable $1. If there are other wildcard strings
364 in parenthesis, the matching strings will be in $2, $3, etc. up to $9. The
365 placeholders can then be used in the
370 .B UID=$1,OU=Accounts,DC=example,DC=com
373 The replaced name can be either a DN, i.e. a string prefixed by "dn:",
375 If the latter, the server will use the URI to search its own database(s)
376 and, if the search returns exactly one entry, the name is
377 replaced by the DN of that entry. The LDAP URI must have no
378 hostport, attrs, or extensions components, but the filter is mandatory,
382 .B ldap:///OU=Accounts,DC=example,DC=com??one?(UID=$1)
385 The protocol portion of the URI must be strictly
387 Note that this search is subject to access controls. Specifically,
388 the authentication identity must have "auth" access in the subject.
392 values can be specified to allow for multiple matching
393 and replacement patterns. The matching patterns are checked in the order they
394 appear in the attribute, stopping at the first successful match.
397 .\"Because the plus sign + is a character recognized by the regular expression engine,
398 .\"and it will appear in names that include a REALM, be careful to escape the
399 .\"plus sign with a backslash \\+ to remove the character's special meaning.
402 .B olcConcurrency: <integer>
403 Specify a desired level of concurrency. Provided to the underlying
404 thread system as a hint. The default is not to provide any hint. This setting
405 is only meaningful on some platforms where there is not a one to one
406 correspondence between user threads and kernel threads.
408 .B olcConnMaxPending: <integer>
409 Specify the maximum number of pending requests for an anonymous session.
410 If requests are submitted faster than the server can process them, they
411 will be queued up to this limit. If the limit is exceeded, the session
412 is closed. The default is 100.
414 .B olcConnMaxPendingAuth: <integer>
415 Specify the maximum number of pending requests for an authenticated session.
418 .B olcDisallows: <features>
419 Specify a set of features to disallow (default none).
421 disables acceptance of anonymous bind requests. Note that this setting
422 does not prohibit anonymous directory access (See "require authc").
424 disables simple (bind) authentication.
426 disables forcing session to anonymous status (see also
428 upon StartTLS operation receipt.
430 disallows the StartTLS operation if authenticated (see also
433 .B olcGentleHUP: { TRUE | FALSE }
434 A SIGHUP signal will only cause a 'gentle' shutdown-attempt:
436 will stop listening for new connections, but will not close the
437 connections to the current clients. Future write operations return
438 unwilling-to-perform, though. Slapd terminates when all clients
439 have closed their connections (if they ever do), or - as before -
440 if it receives a SIGTERM signal. This can be useful if you wish to
441 terminate the server and start a new
444 .B with another database,
445 without disrupting the currently active clients.
446 The default is FALSE. You may wish to use
448 along with this option.
450 .B olcIdleTimeout: <integer>
451 Specify the number of seconds to wait before forcibly closing
452 an idle client connection. A setting of 0 disables this
453 feature. The default is 0. You may also want to set the
457 .B olcIndexIntLen: <integer>
458 Specify the key length for ordered integer indices. The most significant
459 bytes of the binary integer will be used for index keys. The default
460 value is 4, which provides exact indexing for 31 bit values.
461 A floating point representation is used to index too large values.
463 .B olcIndexSubstrIfMaxlen: <integer>
464 Specify the maximum length for subinitial and subfinal indices. Only
465 this many characters of an attribute value will be processed by the
466 indexing functions; any excess characters are ignored. The default is 4.
468 .B olcIndexSubstrIfMinlen: <integer>
469 Specify the minimum length for subinitial and subfinal indices. An
470 attribute value must have at least this many characters in order to be
471 processed by the indexing functions. The default is 2.
473 .B olcIndexSubstrAnyLen: <integer>
474 Specify the length used for subany indices. An attribute value must have
475 at least this many characters in order to be processed. Attribute values
476 longer than this length will be processed in segments of this length. The
477 default is 4. The subany index will also be used in subinitial and
478 subfinal index lookups when the filter string is longer than the
479 .I olcIndexSubstrIfMaxlen
482 .B olcIndexSubstrAnyStep: <integer>
483 Specify the steps used in subany index lookups. This value sets the offset
484 for the segments of a filter string that are processed for a subany index
485 lookup. The default is 2. For example, with the default values, a search
486 using this filter "cn=*abcdefgh*" would generate index lookups for
487 "abcd", "cdef", and "efgh".
490 Note: Indexing support depends on the particular backend in use. Also,
491 changing these settings will generally require deleting any indices that
492 depend on these parameters and recreating them with
496 .B olcLocalSSF: <SSF>
497 Specifies the Security Strength Factor (SSF) to be given local LDAP sessions,
498 such as those to the ldapi:// listener. For a description of SSF values,
500 .BR olcSaslSecProps 's
502 option description. The default is 71.
504 .B olcLogFile: <filename>
505 Specify a file for recording debug log messages. By default these messages
506 only go to stderr and are not recorded anywhere else. Specifying a logfile
507 copies messages to both stderr and the logfile.
509 .B olcLogLevel: <integer> [...]
510 Specify the level at which debugging statements and operation
511 statistics should be syslogged (currently logged to the
513 LOG_LOCAL4 facility).
514 They must be considered subsystems rather than increasingly verbose
516 Some messages with higher priority are logged regardless
517 of the configured loglevel as soon as any logging is configured.
518 Log levels are additive, and available levels are:
529 debug packet handling
533 heavy trace debugging (function args)
537 connection management
541 print out packets sent and received
545 search filter processing
549 configuration file processing
553 access control list processing
557 stats log connections/operations/results
561 stats log entries sent
565 print communication with shell backends
577 \"data indexing (unused)
585 only messages that get logged whatever log level is set
588 The desired log level can be input as a single integer that combines
589 the (ORed) desired levels, both in decimal or in hexadecimal notation,
590 as a list of integers (that are ORed internally),
591 or as a list of the names that are shown between brackets, such that
597 olcLogLevel: 0x80 0x1
598 olcLogLevel: acl trace
604 can be used as a shortcut to enable logging at all levels (equivalent to \-1).
607 or the equivalent integer representation, causes those messages
608 that are logged regardless of the configured olcLogLevel to be logged.
609 In fact, if no olcLogLevel (or a 0 level) is defined, no logging occurs,
612 level is required to have high priority messages logged.
615 .B olcPasswordCryptSaltFormat: <format>
616 Specify the format of the salt passed to
618 when generating {CRYPT} passwords (see
619 .BR olcPasswordHash )
620 during processing of LDAP Password Modify Extended Operations (RFC 3062).
622 This string needs to be in
624 format and may include one (and only one) %s conversion.
625 This conversion will be substituted with a string of random
626 characters from [A\-Za\-z0\-9./]. For example, "%.2s"
627 provides a two character salt and "$1$%.8s" tells some
628 versions of crypt(3) to use an MD5 algorithm and provides
629 8 random characters of salt. The default is "%s", which
630 provides 31 characters of salt.
632 .B olcPidFile: <filename>
633 The (absolute) name of a file that will hold the
635 server's process ID (see
638 .B olcPluginLogFile: <filename>
639 The ( absolute ) name of a file that will contain log
646 .B olcReferral: <url>
647 Specify the referral to pass back when
649 cannot find a local database to handle a request.
650 If multiple values are specified, each url is provided.
652 .B olcReverseLookup: TRUE | FALSE
653 Enable/disable client name unverified reverse lookup (default is
655 if compiled with \-\-enable\-rlookups).
657 .B olcRootDSE: <file>
658 Specify the name of an LDIF(5) file containing user defined attributes
659 for the root DSE. These attributes are returned in addition to the
660 attributes normally produced by slapd.
662 The root DSE is an entry with information about the server and its
663 capabilities, in operational attributes.
664 It has the empty DN, and can be read with e.g.:
666 ldapsearch \-x \-b "" \-s base "+"
668 See RFC 4512 section 5.1 for details.
670 .B olcSaslAuxprops: <plugin> [...]
671 Specify which auxprop plugins to use for authentication lookups. The
672 default is empty, which just uses slapd's internal support. Usually
673 no other auxprop plugins are needed.
675 .B olcSaslHost: <fqdn>
676 Used to specify the fully qualified domain name used for SASL processing.
678 .B olcSaslRealm: <realm>
679 Specify SASL realm. Default is empty.
681 .B olcSaslSecProps: <properties>
682 Used to specify Cyrus SASL security properties.
685 flag (without any other properties) causes the flag properties
686 default, "noanonymous,noplain", to be cleared.
689 flag disables mechanisms susceptible to simple passive attacks.
692 flag disables mechanisms susceptible to active attacks.
695 flag disables mechanisms susceptible to passive dictionary attacks.
698 flag disables mechanisms which support anonymous login.
701 flag require forward secrecy between sessions.
704 require mechanisms which pass client credentials (and allow
705 mechanisms which can pass credentials to do so).
708 property specifies the minimum acceptable
709 .I security strength factor
710 as an integer approximate to effective key length used for
711 encryption. 0 (zero) implies no protection, 1 implies integrity
712 protection only, 56 allows DES or other weak ciphers, 112
713 allows triple DES and other strong ciphers, 128 allows RC4,
714 Blowfish and other modern strong ciphers. The default is 0.
717 property specifies the maximum acceptable
718 .I security strength factor
719 as an integer (see minssf description). The default is INT_MAX.
722 property specifies the maximum security layer receive buffer
723 size allowed. 0 disables security layers. The default is 65536.
725 .B olcServerID: <integer> [<URL>]
726 Specify an integer ID from 0 to 4095 for this server (limited
727 to 3 hexadecimal digits). The ID may also be specified as a
728 hexadecimal ID by prefixing the value with "0x".
730 required when using multimaster replication and each master must have a
731 unique ID. Note that this requirement also applies to separate masters
732 contributing to a glued set of databases.
733 If the URL is provided, this directive may be specified
734 multiple times, providing a complete list of participating servers
735 and their IDs. The fully qualified hostname of each server should be
736 used in the supplied URLs. The IDs are used in the "replica id" field
737 of all CSNs generated by the specified server. The default value is zero.
741 olcServerID: 1 ldap://ldap1.example.com
742 olcServerID: 2 ldap://ldap2.example.com
745 .B olcSockbufMaxIncoming: <integer>
746 Specify the maximum incoming LDAP PDU size for anonymous sessions.
747 The default is 262143.
749 .B olcSockbufMaxIncomingAuth: <integer>
750 Specify the maximum incoming LDAP PDU size for authenticated sessions.
751 The default is 4194303.
753 .B olcTCPBuffer [listener=<URL>] [{read|write}=]<size>
754 Specify the size of the TCP buffer.
755 A global value for both read and write TCP buffers related to any listener
756 is defined, unless the listener is explicitly specified,
757 or either the read or write qualifiers are used.
761 Note that some OS-es implement automatic TCP buffer tuning.
763 .B olcThreads: <integer>
764 Specify the maximum size of the primary thread pool.
765 The default is 16; the minimum value is 2.
767 .B olcToolThreads: <integer>
768 Specify the maximum number of threads to use in tool mode.
769 This should not be greater than the number of CPUs in the system.
772 .B olcWriteTimeout: <integer>
773 Specify the number of seconds to wait before forcibly closing
774 a connection with an outstanding write. This allows recovery from
775 various network hang conditions. A setting of 0 disables this
776 feature. The default is 0.
780 is built with support for Transport Layer Security, there are more options
783 .B olcTLSCipherSuite: <cipher-suite-spec>
784 Permits configuring what ciphers will be accepted and the preference order.
785 <cipher-suite-spec> should be a cipher specification for OpenSSL. Example:
787 olcTLSCipherSuite: HIGH:MEDIUM:+SSLv2
789 To check what ciphers a given spec selects in OpenSSL, use:
792 openssl ciphers \-v <cipher-suite-spec>
795 To obtain the list of ciphers in GNUtls use:
801 .B olcTLSCACertificateFile: <filename>
802 Specifies the file that contains certificates for all of the Certificate
807 .B olcTLSCACertificatePath: <path>
808 Specifies the path of a directory that contains Certificate Authority
809 certificates in separate individual files. Usually only one of this
810 or the olcTLSCACertificateFile is defined. If both are specified, both
811 locations will be used. This directive is not supported
814 .B olcTLSCertificateFile: <filename>
815 Specifies the file that contains the
819 .B olcTLSCertificateKeyFile: <filename>
820 Specifies the file that contains the
822 server private key that matches the certificate stored in the
823 .B olcTLSCertificateFile
824 file. If the private key is protected with a password, the password must
825 be manually typed in when slapd starts. Usually the private key is not
826 protected with a password, to allow slapd to start without manual
828 it is of critical importance that the file is protected carefully.
830 .B olcTLSDHParamFile: <filename>
831 This directive specifies the file that contains parameters for Diffie-Hellman
832 ephemeral key exchange. This is required in order to use a DSA certificate on
833 the server. If multiple sets of parameters are present in the file, all of
834 them will be processed. Note that setting this option may also enable
835 Anonymous Diffie-Hellman key exchanges in certain non-default cipher suites.
836 You should append "!ADH" to your cipher suites if you have changed them
837 from the default, otherwise no certificate exchanges or verification will
838 be done. When using GNUtls these parameters are always generated randomly
839 so this directive is ignored.
841 .B olcTLSRandFile: <filename>
842 Specifies the file to obtain random bits from when /dev/[u]random
843 is not available. Generally set to the name of the EGD/PRNGD socket.
844 The environment variable RANDFILE can also be used to specify the filename.
845 This directive is ignored with GNUtls.
847 .B olcTLSVerifyClient: <level>
848 Specifies what checks to perform on client certificates in an
849 incoming TLS session, if any.
852 can be specified as one of the following keywords:
858 will not ask the client for a certificate.
861 The client certificate is requested. If no certificate is provided,
862 the session proceeds normally. If a bad certificate is provided,
863 it will be ignored and the session proceeds normally.
866 The client certificate is requested. If no certificate is provided,
867 the session proceeds normally. If a bad certificate is provided,
868 the session is immediately terminated.
870 .B demand | hard | true
871 These keywords are all equivalent, for compatibility reasons.
872 The client certificate is requested. If no certificate is provided,
873 or a bad certificate is provided, the session is immediately terminated.
875 Note that a valid client certificate is required in order to use the
876 SASL EXTERNAL authentication mechanism with a TLS session. As such,
878 .B olcTLSVerifyClient
879 setting must be chosen to enable SASL EXTERNAL authentication.
882 .B olcTLSCRLCheck: <level>
883 Specifies if the Certificate Revocation List (CRL) of the CA should be
884 used to verify if the client certificates have not been revoked. This
886 .B olcTLSCACertificatePath
887 parameter to be set. This parameter is ignored with GNUtls.
889 can be specified as one of the following keywords:
893 No CRL checks are performed
896 Check the CRL of the peer certificate
899 Check the CRL for a whole certificate chain
902 .B olcTLSCRLFile: <filename>
903 Specifies a file containing a Certificate Revocation List to be used
904 for verifying that certificates have not been revoked. This parameter
905 is only valid when using GNUtls.
906 .SH DYNAMIC MODULE OPTIONS
909 is compiled with \-\-enable\-modules then the module-related entries will
910 be available. These entries are named
911 .B cn=module{x},cn=config
913 must have the olcModuleList objectClass. One entry should be created
916 Normally the config engine generates the "{x}" index in the RDN
917 automatically, so it can be omitted when initially loading these entries.
919 .B olcModuleLoad: <filename>
920 Specify the name of a dynamically loadable module to load. The filename
921 may be an absolute path name or a simple filename. Non-absolute names
922 are searched for in the directories specified by the
926 .B olcModulePath: <pathspec>
927 Specify a list of directories to search for loadable modules. Typically
928 the path is colon-separated but this depends on the operating system.
929 The default is MODULEDIR, which is where the standard OpenLDAP install
930 will place its modules.
932 Schema definitions are created as entries in the
933 .B cn=schema,cn=config
934 subtree. These entries must have the olcSchemaConfig objectClass.
935 As noted above, the actual
936 .B cn=schema,cn=config
937 entry is predefined and any values specified for it are ignored.
941 .B olcAttributetypes: "(\ <oid>\
943 [DESC\ <description>]\
952 [NO\-USER\-MODIFICATION]\
953 [USAGE\ <attributeUsage>]\ )"
955 Specify an attribute type using the LDAPv3 syntax defined in RFC 4512.
956 The slapd parser extends the RFC 4512 definition by allowing string
957 forms as well as numeric OIDs to be used for the attribute OID and
958 attribute syntax OID.
960 .B olcObjectIdentifier
966 .B olcDitContentRules: "(\ <oid>\
968 [DESC\ <description>]\
975 Specify an DIT Content Rule using the LDAPv3 syntax defined in RFC 4512.
976 The slapd parser extends the RFC 4512 definition by allowing string
977 forms as well as numeric OIDs to be used for the attribute OID and
978 attribute syntax OID.
980 .B olcObjectIdentifier
986 .B olcObjectClasses: "(\ <oid>\
988 [DESC\ <description>]\
991 [{ ABSTRACT | STRUCTURAL | AUXILIARY }]\
992 [MUST\ <oids>] [MAY\ <oids>] )"
994 Specify an objectclass using the LDAPv3 syntax defined in RFC 4512.
995 The slapd parser extends the RFC 4512 definition by allowing string
996 forms as well as numeric OIDs to be used for the object class OID.
1000 description.) Object classes are "STRUCTURAL" by default.
1003 .B olcObjectIdentifier: <name> "{ <oid> | <name>[:<suffix>] }"
1004 Define a string name that equates to the given OID. The string can be used
1005 in place of the numeric OID in objectclass and attribute definitions. The
1006 name can also be used with a suffix of the form ":xx" in which case the
1007 value "oid.xx" will be used.
1009 .SH GENERAL BACKEND OPTIONS
1010 Options in these entries only apply to the configuration of a single
1011 type of backend. All backends may support this class of options.
1012 The entry must be named
1013 .B olcBackend=<databasetype>,cn=config
1014 and must have the olcBackendConfig objectClass.
1032 At present, no backend implements any options of this type.
1034 .SH DATABASE OPTIONS
1035 Database options are set in entries named
1036 .B olcDatabase={x}<databasetype>,cn=config
1037 and must have the olcDatabaseConfig objectClass. Normally the config
1038 engine generates the "{x}" index in the RDN automatically, so it
1039 can be omitted when initially loading these entries.
1041 The special frontend database is always numbered "{\-1}" and the config
1042 database is always numbered "{0}".
1044 .SH GLOBAL DATABASE OPTIONS
1045 Options in this section may be set in the special "frontend" database
1046 and inherited in all the other databases. These options may be altered
1047 by further settings in each specific database. The frontend entry must
1049 .B olcDatabase=frontend,cn=config
1050 and must have the olcFrontendConfig objectClass.
1052 .B olcAccess: to <what> "[ by <who> <access> <control> ]+"
1053 Grant access (specified by <access>) to a set of entries and/or
1054 attributes (specified by <what>) by one or more requestors (specified
1056 If no access controls are present, the default policy
1057 allows anyone and everyone to read anything but restricts
1058 updates to rootdn. (e.g., "olcAccess: to * by * read").
1060 .BR slapd.access (5)
1061 and the "OpenLDAP Administrator's Guide" for details.
1063 Access controls set in the frontend are appended to any access
1064 controls set on the specific databases.
1065 The rootdn of a database can always read and write EVERYTHING
1068 Extra special care must be taken with the access controls on the
1069 config database. Unlike other databases, the default policy for the
1070 config database is to only allow access to the rootdn. Regular users
1071 should not have read access, and write access should be granted very
1072 carefully to privileged administrators.
1075 .B olcDefaultSearchBase: <dn>
1076 Specify a default search base to use when client submits a
1077 non-base search request with an empty base DN.
1078 Base scoped search requests with an empty base DN are not affected.
1079 This setting is only allowed in the frontend entry.
1081 .B olcPasswordHash: <hash> [<hash>...]
1082 This option configures one or more hashes to be used in generation of user
1083 passwords stored in the userPassword attribute during processing of
1084 LDAP Password Modify Extended Operations (RFC 3062).
1085 The <hash> must be one of
1099 use the SHA-1 algorithm (FIPS 160-1), the latter with a seed.
1104 use the MD5 algorithm (RFC 1321), the latter with a seed.
1111 indicates that the new password should be
1112 added to userPassword as clear text.
1114 Note that this option does not alter the normal user applications
1115 handling of userPassword during LDAP Add, Modify, or other LDAP operations.
1116 This setting is only allowed in the frontend entry.
1118 .B olcReadOnly: TRUE | FALSE
1119 This option puts the database into "read-only" mode. Any attempts to
1120 modify the database will return an "unwilling to perform" error. By
1121 default, olcReadOnly is FALSE. Note that when this option is set
1122 TRUE on the frontend, it cannot be reset without restarting the
1123 server, since further writes to the config database will be rejected.
1125 .B olcRequires: <conditions>
1126 Specify a set of conditions to require (default none).
1127 The directive may be specified globally and/or per-database;
1128 databases inherit global conditions, so per-database specifications
1131 requires bind operation prior to directory operations.
1133 requires session to be using LDAP version 3.
1135 requires authentication prior to directory operations.
1137 requires SASL authentication prior to directory operations.
1139 requires strong authentication prior to directory operations.
1140 The strong keyword allows protected "simple" authentication
1141 as well as SASL authentication.
1143 may be used to require no conditions (useful to clear out globally
1144 set conditions within a particular database); it must occur first
1145 in the list of conditions.
1147 .B olcRestrict: <oplist>
1148 Specify a list of operations that are restricted.
1149 Restrictions on a specific database override any frontend setting.
1150 Operations can be any of
1155 .BR extended[=<OID>] ,
1159 or the special pseudo-operations
1163 which respectively summarize read and write operations.
1167 .I olcReadOnly: TRUE
1171 keyword allows to indicate the OID of the specific operation
1174 .B olcSchemaDN: <dn>
1175 Specify the distinguished name for the subschema subentry that
1176 controls the entries on this server. The default is "cn=Subschema".
1178 .B olcSecurity: <factors>
1179 Specify a set of security strength factors (separated by white space)
1181 .BR olcSaslSecprops 's
1183 option for a description of security strength factors).
1184 The directive may be specified globally and/or per-database.
1186 specifies the overall security strength factor.
1188 specifies the transport security strength factor.
1190 specifies the TLS security strength factor.
1192 specifies the SASL security strength factor.
1194 specifies the overall security strength factor to require for
1196 .B update_transport=<n>
1197 specifies the transport security strength factor to require for
1200 specifies the TLS security strength factor to require for
1203 specifies the SASL security strength factor to require for
1206 specifies the security strength factor required for
1208 username/password authentication.
1211 factor is measure of security provided by the underlying transport,
1212 e.g. ldapi:// (and eventually IPSEC). It is not normally used.
1214 .B olcSizeLimit: {<integer>|unlimited}
1216 .B olcSizeLimit: size[.{soft|hard|unchecked}]=<integer> [...]
1217 Specify the maximum number of entries to return from a search operation.
1218 The default size limit is 500.
1221 to specify no limits.
1222 The second format allows a fine grain setting of the size limits.
1223 Extra args can be added in the same value or as additional values.
1226 for an explanation of the different flags.
1228 .B olcSortVals: <attr> [...]
1229 Specify a list of multi-valued attributes whose values will always
1230 be maintained in sorted order. Using this option will allow Modify,
1231 Compare, and filter evaluations on these attributes to be performed
1232 more efficiently. The resulting sort order depends on the
1233 attributes' syntax and matching rules and may not correspond to
1234 lexical order or any other recognizable order.
1235 This setting is only allowed in the frontend entry.
1237 .B olcTimeLimit: {<integer>|unlimited}
1239 .B olcTimeLimit: time[.{soft|hard}]=<integer> [...]
1240 Specify the maximum number of seconds (in real time)
1242 will spend answering a search request. The default time limit is 3600.
1245 to specify no limits.
1246 The second format allows a fine grain setting of the time limits.
1247 Extra args can be added in the same value or as additional values.
1250 for an explanation of the different flags.
1252 .SH GENERAL DATABASE OPTIONS
1253 Options in this section only apply to the specific database for
1254 which they are defined. They are supported by every
1255 type of backend. All of the Global Database Options may also be
1258 .B olcAddContentAcl: TRUE | FALSE
1259 Controls whether Add operations will perform ACL checks on
1260 the content of the entry being added. This check is off
1262 .BR slapd.access (5)
1263 manual page for more details on ACL requirements for
1266 .B olcHidden: TRUE | FALSE
1267 Controls whether the database will be used to answer
1268 queries. A database that is hidden will never be
1269 selected to answer any queries, and any suffix configured
1270 on the database will be ignored in checks for conflicts
1271 with other databases. By default, olcHidden is FALSE.
1273 .B olcLastMod: TRUE | FALSE
1276 will automatically maintain the
1277 modifiersName, modifyTimestamp, creatorsName, and
1278 createTimestamp attributes for entries. It also controls
1279 the entryCSN and entryUUID attributes, which are needed
1280 by the syncrepl provider. By default, olcLastMod is TRUE.
1282 .B olcLimits: <selector> <limit> [<limit> [...]]
1283 Specify time and size limits based on the operation's initiator or
1291 anonymous | users | [<dnspec>=]<pattern> | group[/oc[/at]]=<pattern>
1297 <dnspec> ::= dn[.<type>][.<style>]
1299 <type> ::= self | this
1301 <style> ::= exact | base | onelevel | subtree | children | regex | anonymous
1306 is the default and means the bound user, while
1308 means the base DN of the operation.
1311 matches all unauthenticated clients.
1314 matches all authenticated clients;
1317 dn pattern is assumed unless otherwise specified by qualifying
1318 the (optional) key string
1324 (which are synonyms), to require an exact match; with
1326 to require exactly one level of depth match; with
1328 to allow any level of depth match, including the exact match; with
1330 to allow any level of depth match, not including the exact match;
1332 explicitly requires the (default) match based on POSIX (''extended'')
1333 regular expression pattern.
1336 matches unbound operations; the
1339 The same behavior is obtained by using the
1346 with the optional objectClass
1352 sets the limits for any DN listed in the values of the
1358 group objectClass (default
1360 whose DN exactly matches
1363 The currently supported limits are
1368 The syntax for time limits is
1369 .BR time[.{soft|hard}]=<integer> ,
1372 is the number of seconds slapd will spend answering a search request.
1373 If no time limit is explicitly requested by the client, the
1375 limit is used; if the requested time limit exceeds the
1378 .\".I "Administrative limit exceeded"
1379 .\"error is returned.
1380 limit, the value of the limit is used instead.
1383 limit is set to the keyword
1385 the soft limit is used in either case; if it is set to the keyword
1387 no hard limit is enforced.
1388 Explicit requests for time limits smaller or equal to the
1391 If no limit specifier is set, the value is assigned to the
1397 to preserve the original behavior.
1399 The syntax for size limits is
1400 .BR size[.{soft|hard|unchecked}]=<integer> ,
1403 is the maximum number of entries slapd will return answering a search
1405 If no size limit is explicitly requested by the client, the
1407 limit is used; if the requested size limit exceeds the
1410 .\".I "Administrative limit exceeded"
1411 .\"error is returned.
1412 limit, the value of the limit is used instead.
1415 limit is set to the keyword
1417 the soft limit is used in either case; if it is set to the keyword
1419 no hard limit is enforced.
1420 Explicit requests for size limits smaller or equal to the
1425 specifier sets a limit on the number of candidates a search request is allowed
1427 The rationale behind it is that searches for non-properly indexed
1428 attributes may result in large sets of candidates, which must be
1431 to determine whether they match the search filter or not.
1434 limit provides a means to drop such operations before they are even
1436 If the selected candidates exceed the
1438 limit, the search will abort with
1439 .IR "Unwilling to perform" .
1440 If it is set to the keyword
1442 no limit is applied (the default).
1445 the search is not even performed; this can be used to disallow searches
1446 for a specific set of users.
1447 If no limit specifier is set, the value is assigned to the
1453 to preserve the original behavior.
1455 In case of no match, the global limits are used.
1456 The default values are the same as for
1465 control is requested, the
1467 size limit is used by default, because the request of a specific page size
1468 is considered an explicit request for a limitation on the number
1469 of entries to be returned.
1470 However, the size limit applies to the total count of entries returned within
1471 the search, and not to a single page.
1472 Additional size limits may be enforced; the syntax is
1473 .BR size.pr={<integer>|noEstimate|unlimited} ,
1476 is the max page size if no explicit limit is set; the keyword
1478 inhibits the server from returning an estimate of the total number
1479 of entries that might be returned
1480 (note: the current implementation does not return any estimate).
1483 indicates that no limit is applied to the pagedResults control page size.
1485 .B size.prtotal={<integer>|unlimited|disabled}
1486 allows to set a limit on the total number of entries that a pagedResults
1487 control allows to return.
1488 By default it is set to the
1493 is the max number of entries that the whole search with pagedResults control
1497 to allow unlimited number of entries to be returned, e.g. to allow
1498 the use of the pagedResults control as a means to circumvent size
1499 limitations on regular searches; the keyword
1501 disables the control, i.e. no paged results can be returned.
1502 Note that the total number of entries returned when the pagedResults control
1503 is requested cannot exceed the
1505 size limit of regular searches unless extended by the
1510 .B olcMaxDerefDepth: <depth>
1511 Specifies the maximum number of aliases to dereference when trying to
1512 resolve an entry, used to avoid infinite alias loops. The default is 15.
1514 .B olcMirrorMode: TRUE | FALSE
1515 This option puts a replica database into "mirror" mode. Update
1516 operations will be accepted from any user, not just the updatedn. The
1517 database must already be configured as syncrepl consumer
1518 before this keyword may be set. This mode also requires a
1520 (see above) to be configured.
1521 By default, this setting is FALSE.
1523 .B olcPlugin: <plugin_type> <lib_path> <init_function> [<arguments>]
1524 Configure a SLAPI plugin. See the
1525 .BR slapd.plugin (5)
1526 manpage for more details.
1529 Specify the distinguished name that is not subject to access control
1530 or administrative limit restrictions for operations on this database.
1531 This DN may or may not be associated with an entry. An empty root
1532 DN (the default) specifies no root access is to be granted. It is
1533 recommended that the rootdn only be specified when needed (such as
1534 when initially populating a database). If the rootdn is within
1535 a namingContext (suffix) of the database, a simple bind password
1536 may also be provided using the
1538 directive. Note that the rootdn is always needed when using syncrepl.
1540 .B olcRootPW: <password>
1541 Specify a password (or hash of the password) for the rootdn. The
1542 password can only be set if the rootdn is within the namingContext
1543 (suffix) of the database.
1544 This option accepts all RFC 2307 userPassword formats known to
1547 description) as well as cleartext.
1549 may be used to generate a hash of a password. Cleartext
1550 and \fB{CRYPT}\fP passwords are not recommended. If empty
1551 (the default), authentication of the root DN is by other means
1552 (e.g. SASL). Use of SASL is encouraged.
1554 .B olcSubordinate: [TRUE | FALSE | advertise]
1555 Specify that the current backend database is a subordinate of another
1556 backend database. A subordinate database may have only one suffix. This
1557 option may be used to glue multiple databases into a single namingContext.
1558 If the suffix of the current database is within the namingContext of a
1559 superior database, searches against the superior database will be
1560 propagated to the subordinate as well. All of the databases
1561 associated with a single namingContext should have identical rootdns.
1562 Behavior of other LDAP operations is unaffected by this setting. In
1563 particular, it is not possible to use moddn to move an entry from
1564 one subordinate to another subordinate within the namingContext.
1566 If the optional \fBadvertise\fP flag is supplied, the naming context of
1567 this database is advertised in the root DSE. The default is to hide this
1568 database context, so that only the superior context is visible.
1575 are used on the superior database, any glued subordinates that support
1576 these tools are opened as well.
1578 Databases that are glued together should usually be configured with the
1579 same indices (assuming they support indexing), even for attributes that
1580 only exist in some of these databases. In general, all of the glued
1581 databases should be configured as similarly as possible, since the intent
1582 is to provide the appearance of a single directory.
1584 Note that the subordinate functionality is implemented internally
1585 by the \fIglue\fP overlay and as such its behavior will interact with other
1586 overlays in use. By default, the glue overlay is automatically configured as
1587 the last overlay on the superior database. Its position on the database
1588 can be explicitly configured by setting an \fBoverlay glue\fP directive
1589 at the desired position. This explicit configuration is necessary e.g.
1590 when using the \fIsyncprov\fP overlay, which needs to follow \fIglue\fP
1591 in order to work over all of the glued databases. E.g.
1594 dn: olcDatabase={1}bdb,cn=config
1595 olcSuffix: dc=example,dc=com
1598 dn: olcOverlay={0}glue,olcDatabase={1}bdb,cn=config
1601 dn: olcOverlay={1}syncprov,olcDatabase={1}bdb,cn=config
1605 See the Overlays section below for more details.
1607 .B olcSuffix: <dn suffix>
1608 Specify the DN suffix of queries that will be passed to this
1609 backend database. Multiple suffix lines can be given and at least one is
1610 required for each database definition.
1612 If the suffix of one database is "inside" that of another, the database
1613 with the inner suffix must come first in the configuration file.
1614 You may also want to glue such databases together with the
1618 .B olcSyncUseSubentry: TRUE | FALSE
1619 Store the syncrepl contextCSN in a subentry instead of the context entry
1620 of the database. The subentry's RDN will be "cn=ldapsync". The default is
1621 FALSE, meaning the contextCSN is stored in the context entry.
1624 .B olcSyncrepl: rid=<replica ID>
1625 .B provider=ldap[s]://<hostname>[:port]
1626 .B searchbase=<base DN>
1627 .B [type=refreshOnly|refreshAndPersist]
1628 .B [interval=dd:hh:mm:ss]
1629 .B [retry=[<retry interval> <# of retries>]+]
1630 .B [filter=<filter str>]
1631 .B [scope=sub|one|base|subord]
1632 .B [attrs=<attr list>]
1633 .B [exattrs=<attr list>]
1635 .B [sizelimit=<limit>]
1636 .B [timelimit=<limit>]
1637 .B [schemachecking=on|off]
1638 .B [network\-timeout=<seconds>]
1639 .B [timeout=<seconds>]
1640 .B [bindmethod=simple|sasl]
1642 .B [saslmech=<mech>]
1643 .B [authcid=<identity>]
1644 .B [authzid=<identity>]
1645 .B [credentials=<passwd>]
1647 .B [secprops=<properties>]
1648 .B [starttls=yes|critical]
1649 .B [tls_cert=<file>]
1651 .B [tls_cacert=<file>]
1652 .B [tls_cacertdir=<path>]
1653 .B [tls_reqcert=never|allow|try|demand]
1654 .B [tls_ciphersuite=<ciphers>]
1655 .B [tls_crlcheck=none|peer|all]
1656 .B [logbase=<base DN>]
1657 .B [logfilter=<filter str>]
1658 .B [syncdata=default|accesslog|changelog]
1660 Specify the current database as a replica which is kept up-to-date with the
1661 master content by establishing the current
1663 as a replication consumer site running a
1666 The replica content is kept synchronized to the master content using
1667 the LDAP Content Synchronization protocol. Refer to the
1668 "OpenLDAP Administrator's Guide" for detailed information on
1669 setting up a replicated
1671 directory service using the
1676 identifies the current
1678 directive within the replication consumer site.
1679 It is a non-negative integer having no more than three decimal digits.
1682 specifies the replication provider site containing the master content
1683 as an LDAP URI. If <port> is not given, the standard LDAP port number
1684 (389 or 636) is used.
1688 replica is defined using a search
1689 specification as its result set. The consumer
1691 will send search requests to the provider
1693 according to the search specification. The search specification includes
1694 .B searchbase, scope, filter, attrs, attrsonly, sizelimit,
1697 parameters as in the normal search specification. The
1699 option may also be used to specify attributes that should be omitted
1700 from incoming entries.
1701 The \fBscope\fP defaults to \fBsub\fP, the \fBfilter\fP defaults to
1702 \fB(objectclass=*)\fP, and there is no default \fBsearchbase\fP. The
1703 \fBattrs\fP list defaults to \fB"*,+"\fP to return all user and operational
1704 attributes, and \fBattrsonly\fP and \fBexattrs\fP are unset by default.
1705 The \fBsizelimit\fP and \fBtimelimit\fP only
1706 accept "unlimited" and positive integers, and both default to "unlimited".
1707 Note, however, that any provider-side limits for the replication identity
1708 will be enforced by the provider regardless of the limits requested
1709 by the LDAP Content Synchronization operation, much like for any other
1712 The LDAP Content Synchronization protocol has two operation types.
1715 operation, the next synchronization search operation
1716 is periodically rescheduled at an interval time (specified by
1718 parameter; 1 day by default)
1719 after each synchronization operation finishes.
1721 .B refreshAndPersist
1722 operation, a synchronization search remains persistent in the provider slapd.
1723 Further updates to the master replica will generate
1724 .B searchResultEntry
1725 to the consumer slapd as the search responses to the persistent
1726 synchronization search.
1728 If an error occurs during replication, the consumer will attempt to
1729 reconnect according to the
1731 parameter which is a list of the <retry interval> and <# of retries> pairs.
1732 For example, retry="60 10 300 3" lets the consumer retry every 60 seconds
1733 for the first 10 times and then retry every 300 seconds for the next 3
1734 times before stop retrying. The `+' in <# of retries> means indefinite
1735 number of retries until success.
1737 The schema checking can be enforced at the LDAP Sync
1738 consumer site by turning on the
1740 parameter. The default is off.
1744 parameter sets how long the consumer will wait to establish a
1745 network connection to the provider. Once a connection is
1748 parameter determines how long the consumer will wait for the initial
1749 Bind request to complete. The defaults for these parameters come
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. It is only needed in certain push-mode
1822 replication scenarios. Generally, this DN
1828 .B olcUpdateRef: <url>
1829 Specify the referral to pass back when
1831 is asked to modify a replicated local database.
1832 If multiple values are specified, each url is provided.
1834 .SH DATABASE-SPECIFIC OPTIONS
1835 Each database may allow specific configuration options; they are
1836 documented separately in the backends' manual pages. See the
1837 .BR slapd.backends (5)
1838 manual page for an overview of available backends.
1840 An overlay is a piece of
1841 code that intercepts database operations in order to extend or change
1842 them. Overlays are pushed onto
1843 a stack over the database, and so they will execute in the reverse
1844 of the order in which they were configured and the database itself
1845 will receive control last of all.
1847 Overlays must be configured as child entries of a specific database. The
1848 entry's RDN must be of the form
1849 .B olcOverlay={x}<overlaytype>
1850 and the entry must have the olcOverlayConfig objectClass. Normally the
1851 config engine generates the "{x}" index in the RDN automatically, so
1852 it can be omitted when initially loading these entries.
1855 .BR slapd.overlays (5)
1856 manual page for an overview of available overlays.
1859 Here is a short example of a configuration in LDIF suitable for use with
1866 objectClass: olcGlobal
1868 olcPidFile: LOCALSTATEDIR/run/slapd.pid
1869 olcAttributeOptions: x\-hidden lang\-
1871 dn: cn=schema,cn=config
1872 objectClass: olcSchemaConfig
1875 include: SYSCONFDIR/schema/core.ldif
1877 dn: olcDatabase=frontend,cn=config
1878 objectClass: olcDatabaseConfig
1879 objectClass: olcFrontendConfig
1880 olcDatabase: frontend
1881 # Subtypes of "name" (e.g. "cn" and "ou") with the
1882 # option ";x\-hidden" can be searched for/compared,
1883 # but are not shown. See \fBslapd.access\fP(5).
1884 olcAccess: to attrs=name;x\-hidden by * =cs
1885 # Protect passwords. See \fBslapd.access\fP(5).
1886 olcAccess: to attrs=userPassword by * auth
1887 # Read access to other attributes and entries.
1888 olcAccess: to * by * read
1890 # set a rootpw for the config database so we can bind.
1891 # deny access to everyone else.
1892 dn: olcDatabase=config,cn=config
1893 objectClass: olcDatabaseConfig
1895 olcRootPW: {SSHA}XKYnrjvGT3wZFQrDD5040US592LxsdLy
1896 olcAccess: to * by * none
1898 dn: olcDatabase=bdb,cn=config
1899 objectClass: olcDatabaseConfig
1900 objectClass: olcBdbConfig
1902 olcSuffix: "dc=our\-domain,dc=com"
1903 # The database directory MUST exist prior to
1904 # running slapd AND should only be accessible
1905 # by the slapd/tools. Mode 0700 recommended.
1906 olcDbDirectory: LOCALSTATEDIR/openldap\-data
1907 # Indices to maintain
1908 olcDbIndex: objectClass eq
1909 olcDbIndex: cn,sn,mail pres,eq,approx,sub
1911 # We serve small clients that do not handle referrals,
1912 # so handle remote lookups on their behalf.
1913 dn: olcDatabase=ldap,cn=config
1914 objectClass: olcDatabaseConfig
1915 objectClass: olcLdapConfig
1918 olcDbUri: ldap://ldap.some\-server.com/
1922 Assuming the above data was saved in a file named "config.ldif" and the
1923 ETCDIR/slapd.d directory has been created, this command will initialize
1927 slapadd \-F ETCDIR/slapd.d \-n 0 \-l config.ldif
1932 "OpenLDAP Administrator's Guide" contains a longer annotated
1933 example of a slapd configuration.
1935 Alternatively, an existing slapd.conf file can be converted to the new
1936 format using slapd or any of the slap tools:
1939 slaptest \-f ETCDIR/slapd.conf \-F ETCDIR/slapd.d
1946 default slapd configuration file
1949 default slapd configuration directory
1953 .BR slapd.access (5),
1954 .BR slapd.backends (5),
1956 .BR slapd.overlays (5),
1957 .BR slapd.plugin (5),
1958 .BR slapd.replog (5),
1969 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
1970 .SH ACKNOWLEDGEMENTS
projects / openldap / blob