1 .TH SLAPD.CONF 5 "RELEASEDATE" "OpenLDAP LDVERSION"
2 .\" Copyright 1998-2003 The OpenLDAP Foundation All Rights Reserved.
3 .\" Copying restrictions apply. See COPYRIGHT/LICENSE.
6 slapd.conf \- configuration file for slapd, the stand-alone LDAP daemon
12 contains configuration information for the
14 daemon. This configuration file is also used by the
16 replication daemon and by the SLAPD tools
24 file consists of a series of global configuration options that apply to
26 as a whole (including all backends), followed by zero or more database
27 backend definitions that contain information specific to a backend
35 # comment - these options apply to every database
36 <global configuration options>
37 # first database definition & configuration options
38 database <backend 1 type>
39 <configuration options specific to backend 1>
40 # subsequent database definitions & configuration options
44 As many backend-specific sections as desired may be included. Global
45 options can be overridden in a backend (for options that appear more
46 than once, the last appearance in the
48 file is used). Blank lines and comment lines beginning with a `#'
49 character are ignored. If a line begins with white space, it is
50 considered a continuation of the previous line.
52 Arguments on configuration lines are separated by white space. If an
53 argument contains white space, the argument should be enclosed in
54 double quotes. If an argument contains a double quote (`"') or a
55 backslash character (`\\'), the character should be preceded by a
58 The specific configuration options available are discussed below in the
59 Global Configuration Options, General Backend Options, and General Database
60 Options. Backend-specific options are discussed in the
62 manual pages. Refer to the "OpenLDAP Administrator's Guide" for more
63 details on the slapd configuration file.
64 .SH GLOBAL CONFIGURATION OPTIONS
65 Options described in this section apply to all backends, unless specifically
66 overridden in a backend definition. Arguments that should be replaced by
67 actual text are shown in brackets <>.
69 .B access to <what> "[ by <who> <access> <control> ]+"
70 Grant access (specified by <access>) to a set of entries and/or
71 attributes (specified by <what>) by one or more requestors (specified
75 and the "OpenLDAP's Administrator's Guide" for details.
78 Specify a set of features (separated by white space) to
81 allows acceptance of LDAPv2 bind requests. Note that
83 does not truely implement LDAPv2 (RFC 1777), now Historic (RFC 3494).
85 allows anonymous bind when credentials are not empty (e.g.
88 allows unauthenticated (anonymous) bind when DN is not empty.
90 allow unauthenticated (anonymous) update operations to be processed
91 (subject to access controls and other administrative limits).
93 .B argsfile <filename>
94 The ( absolute ) name of a file that will hold the
96 server's command line options
97 if started without the debugging command line option.
99 .B attributeoptions [option-name]...
100 Define tagging attribute options or option tag/range prefixes.
101 Options must not end with `-', prefixes must end with `-'.
102 The `lang-' prefix is predefined.
105 directive, `lang-' will no longer be defined and you must specify it
106 explicitly if you want it defined.
108 An attribute description with a tagging option is a subtype of that
109 attribute description without the option.
110 Except for that, options defined this way have no special semantics.
111 Prefixes defined this way work like the `lang-' options:
112 They define a prefix for tagging options starting with the prefix.
113 That is, if you define the prefix `x-foo-', you can use the option
115 Furthermore, in a search or compare, a prefix or range name (with
116 a trailing `-') matches all options starting with that name, as well
117 as the option with the range name sans the trailing `-'.
118 That is, `x-foo-bar-' matches `x-foo-bar' and `x-foo-bar-baz'.
120 RFC2251 reserves options beginning with `x-' for private experiments.
121 Other options should be registered with IANA, see RFC3383 section 3.4.
122 OpenLDAP also has the `binary' option built in, but this is a transfer
123 option, not a tagging option.
126 .B attributetype "(\ <oid> [NAME\ <name>] [OBSOLETE]\
127 [DESC\ <description>]\
128 [SUP\ <oid>] [EQUALITY\ <oid>] [ORDERING\ <oid>]\
129 [SUBSTR\ <oid>] [SYNTAX\ <oidlen>] [SINGLE\-VALUE] [COLLECTIVE]\
130 [NO\-USER\-MODIFICATION] [USAGE\ <attributeUsage>]\ )"
132 Specify an attribute type using the LDAPv3 syntax defined in RFC 2252.
133 The slapd parser extends the RFC 2252 definition by allowing string
134 forms as well as numeric OIDs to be used for the attribute OID and
135 attribute syntax OID.
141 .B concurrency <integer>
142 Specify a desired level of concurrency. Provided to the underlying
143 thread system as a hint. The default is not to provide any hint.
145 .B conn_max_pending <integer>
146 Specify the maximum number of pending requests for an anonymous session.
147 If requests are submitted faster than the server can process them, they
148 will be queued up to this limit. If the limit is exceeded, the session
149 is closed. The default is 100.
151 .B conn_max_pending_auth <integer>
152 Specify the maximum number of pending requests for an authenticated session.
155 .\".B debug <subsys> <level>
156 .\"Specify a logging level for a particular subsystem. The subsystems include
158 .\"a global level for all subsystems,
162 .\"the backend databases,
164 .\"the entry cache manager,
166 .\"the config file reader,
168 .\"the connection manager,
170 .\"the Cyrus SASL library interface,
172 .\"the search filter processor,
174 .\"the DN normalization library,
176 .\"the database indexer,
178 .\"the ASN.1 BER library,
180 .\"the dynamic module loader,
182 .\"the LDAP operation processors,
184 .\"the SASL authentication subsystem,
186 .\"the schema processor, and
188 .\"the TLS library interface. This is not an exhaustive list; there are many
189 .\"other subsystems and more are added over time.
191 .\"The levels are, in order of decreasing priority:
192 .\".B emergency, alert, critical, error, warning, notice, information, entry,
193 .\".B args, results, detail1, detail2
194 .\"An integer may be used instead, with 0 corresponding to
200 .\"level logs function entry points,
202 .\"adds function call parameters, and
204 .\"adds the function results to the logs.
209 .\"levels add even more low level detail from individual functions.
211 .B defaultsearchbase <dn>
212 Specify a default search base to use when client submits a
213 non-base search request with an empty base DN.
215 .B disallow <features>
216 Specify a set of features (separated by white space) to
217 disallow (default none).
219 disables acceptance of anonymous bind requests.
221 disables simple (bind) authentication.
222 .B bind_simple_unprotected
223 disables simple (bind) authentication when confidentiality
224 protection (e.g. TLS) is not in place. The
228 option provides fine grain control over the confidentiality
229 protection required for simple bind.
231 disables Kerberos V4 (bind) authentication.
233 disables Start TLS from forcing session to anonymous status (see also
236 disables StartTLS if authenticated (see also
239 .B gentlehup { on | off }
240 A SIGHUP signal will only cause a 'gentle' shutdown-attempt:
242 will stop listening for new connections, but will not close the
243 connections to the current clients. Future write operations return
244 unwilling-to-perform, though. Slapd terminates when all clients
245 have closed their connections (if they ever do), or \- as before \-
246 if it receives a SIGTERM signal. This can be useful if you wish to
247 terminate the server and start a new
250 .B with another database,
251 without disrupting the currently active clients.
252 The default is off. You may wish to use
254 along with this option.
256 .B idletimeout <integer>
257 Specify the number of seconds to wait before forcibly closing
258 an idle client connection. A idletimeout of 0 disables this
259 feature. The default is 0.
261 .B include <filename>
262 Read additional configuration information from the given file before
263 continuing with the next line of the current file.
265 .B limits <who> <limit> [<limit> [...]]
266 Specify time and size limits based on who initiated an operation.
273 anonymous | users | [dn[.<style>]=]<pattern>
279 <style> ::= exact | base | one | subtree | children | regex | anonymous
284 matches all unauthenticated clients.
287 matches all authenticated clients;
290 dn pattern is assumed unless otherwise specified by qualifying
291 the (optional) key string
297 (which are synonims), to require an exact match; with
299 to require exactly one level of depth match; with
301 to allow any level of depth match, including the exact match; with
303 to allow any level of depth match, not including the exact match;
305 explicitly requires the (default) match based on regular expression
306 pattern, as detailed in
310 matches unbound operations; the
313 The same behavior is obtained by using the
319 The currently supported limits are
324 The syntax for time limits is
325 .BR time[.{soft|hard}]=<integer> ,
328 is the number of seconds slapd will spend answering a search request.
329 If no time limit is explicitly requested by the client, the
331 limit is used; if the requested time limit exceedes the
333 limit, an "Administrative limit exceeded" is returned.
336 limit is set to 0 or to the keyword "soft", the soft limit is used
337 in either case; if it is set to -1 or to the keyword "none",
338 no hard limit is enforced.
339 Explicit requests for time limits smaller or equal to the
342 If no flag is set, the value is assigned to the
346 limit is set to zero, to preserve the original behavior.
348 The syntax for size limits is
349 .BR size[.{soft|hard|unchecked}]=<integer> ,
352 is the maximum number of entries slapd will return answering a search
354 If no size limit is explicitly requested by the client, the
356 limit is used; if the requested size limit exceedes the
358 limit, an "Administrative limit exceeded" is returned.
361 limit is set to 0 or to the keyword "soft", the soft limit is used
362 in either case; if it is set to -1 or to the keyword "none",
363 no hard limit is enforced.
364 Explicit requests for size limits smaller or equal to the
369 flag sets a limit on the number of candidates a search request is allowed
371 If the selected candidates exceed the
373 limit, the search will abort with "Unwilling to perform".
374 If it is set to -1 or to the keyword "none", no limit is applied (the default).
375 If no flag is set, the value is assigned to the
379 limit is set to zero, to preserve the original behavior.
381 In case of no match, the global limits are used.
382 The default values are the same of
391 control is defined, additional size limits may be enforced; the syntax is
392 .BR size.pr={<integer>|noEstimate} ,
395 is the max page size if no explicit limit is set; the keyword
397 inhibits the server to return an estimate of the total number
398 of entries that will be returned.
401 .\".B logfile <filename>
402 .\"Specify a file for recording debug log messages. By default these messages
403 .\"only go to stderr and are not recorded anywhere else. Specifying a logfile
404 .\"copies messages to both stderr and the logfile.
406 .B loglevel <integer>
407 Specify the level at which debugging statements and operation
408 statistics should be syslogged (currently logged to the
410 LOG_LOCAL4 facility). Log levels are additive, and available levels
420 debug packet handling
423 heavy trace debugging
426 connection management
429 print out packets sent and received
432 search filter processing
435 configuration file processing
438 access control list processing
441 stats log connections/operations/results
444 stats log entries sent
447 print communication with shell backends
455 .B moduleload <filename>
456 Specify the name of a dynamically loadable module to load. The filename
457 may be an absolute path name or a simple filename. Non-absolute names
458 are searched for in the directories specified by the
460 option. This option and the
462 option are only usable if slapd was compiled with --enable-modules.
464 .B modulepath <pathspec>
465 Specify a list of directories to search for loadable modules. Typically
466 the path is colon-separated but this depends on the operating system.
468 .B objectclass "( <oid> [NAME <name>] [DESC <description] [OBSOLETE]\
469 [SUP <oids>] [{ ABSTRACT | STRUCTURAL | AUXILIARY }] [MUST <oids>]\
472 Specify an objectclass using the LDAPv3 syntax defined in RFC 2252.
473 The slapd parser extends the RFC 2252 definition by allowing string
474 forms as well as numeric OIDs to be used for the object class OID.
478 description.) Object classes are "STRUCTURAL" by default.
481 .B objectidentifier <name> "{ <oid> | <name>[:<suffix>] }"
482 Define a string name that equates to the given OID. The string can be used
483 in place of the numeric OID in objectclass and attribute definitions. The
484 name can also be used with a suffix of the form ":xx" in which case the
485 value "oid.xx" will be used.
487 .B password-hash <hash>
488 This option sets the hash to be used in generation of user
489 passwords, stored in userPassword, during processing of
490 LDAP Password Modify Extended Operations (RFC 3052).
491 The <hash> must be one of
505 use the SHA-1 algorithm (FIPS 160-1), the latter with a seed.
510 use the MD5 algorithm (RFC 1321), the latter with a seed.
517 indicates that the new password should be
518 added to userPassword as clear text.
520 Note that this option does not alter the normal user applications
521 handling of userPassword during LDAP Add, Modify, or other LDAP operations.
523 .B password\-crypt\-salt\-format <format>
524 Specify the format of the salt passed to
526 when generating {CRYPT} passwords (see
528 during processing of LDAP Password Modify Extended Operations (RFC 3062).
530 This string needs to be in
532 format and may include one (and only one) %s conversion.
533 This conversion will be substituted with a string random
534 characters from [A\-Za\-z0\-9./]. For example, "%.2s"
535 provides a two character salt and "$1$%.8s" tells some
536 versions of crypt(3) to use an MD5 algorithm and provides
537 8 random characters of salt. The default is "%s", which
538 provides 31 characters of salt.
540 .B pidfile <filename>
541 The ( absolute ) name of a file that will hold the
543 server's process ID ( see
545 ) if started without the debugging command line option.
548 Specify the referral to pass back when
550 cannot find a local database to handle a request.
551 If specified multiple times, each url is provided.
554 The ( absolute ) name of a file that will hold the
556 server's command line options
557 if started without the debugging command line option.
560 The ( absolute ) name of a file that will hold the
562 server's process ID ( see
564 ) if started without the debugging command line option.
566 .B require <conditions>
567 Specify a set of conditions (separated by white space) to
568 require (default none).
569 The directive may be specified globally and/or per-database.
571 requires bind operation prior to directory operations.
573 requires session to be using LDAP version 3.
575 requires authentication prior to directory operations.
577 requires SASL authentication prior to directory operations.
579 requires strong authentication prior to directory operations.
580 The strong keyword allows protected "simple" authentication
581 as well as SASL authentication.
583 may be used to require no conditions (useful for clearly globally
584 set conditions within a particular database).
586 .B reverse-lookup on | off
587 Enable/disable client name unverified reverse lookup (default is
589 if compiled with --enable-rlookups).
592 Specify the name of an LDIF(5) file containing user defined attributes
593 for the root DSE. These attributes are returned in addition to the
594 attributes normally produced by slapd.
596 .B sasl-authz-policy <policy>
597 Used to specify which rules to use for SASL Proxy Authorization. Proxy
598 authorization allows a client to authenticate to the server using one
599 user's credentials, but specify a different identity to use for authorization
600 and access control purposes. It essentially allows user A to login as user
601 B, using user A's password.
604 flag disables proxy authorization. This is the default setting.
607 flag will use rules in the
609 attribute of the authorization DN.
612 flag will use rules in the
614 attribute of the authentication DN.
617 flag will allow both of the above. The rules are simply regular expressions
618 specifying which DNs are allowed to perform proxy authorization. The
620 attribute in an entry specifies which other users
621 are allowed to proxy login to this entry. The
624 an entry specifies which other users this user can authorize as. Use of
627 abused if users are allowed to write arbitrary values to this attribute.
630 attribute must be protected with ACLs such that
631 only privileged users can modify it.
634 Used to specify the fully qualified domain name used for SASL processing.
636 .B sasl-realm <realm>
637 Specify SASL realm. Default is empty.
639 .B sasl-regexp <match> <replace>
640 Used by the SASL authorization mechanism to convert a SASL authenticated
641 username to an LDAP DN. When an authorization request is received, the SASL
645 are taken, when available, and combined into a SASL name of the
650 .B uid=<username>[,cn=<realm>],cn=<mechanism>,cn=auth
653 This SASL name is then compared against the
655 regular expression, and if the match is successful, the SASL name is
658 string. If there are wildcard strings in the
660 regular expression that are enclosed in parenthesis, e.g.
668 then the portion of the SASL name that matched the wildcard will be stored
669 in the numbered placeholder variable $1. If there are other wildcard strings
670 in parenthesis, the matching strings will be in $2, $3, etc. up to $9. The
671 placeholders can then be used in the
677 .B cn=$1,ou=Accounts,dc=$2,dc=$4.
681 The replaced SASL name can be either a DN or an LDAP URI. If the latter, the slapd
682 server will use the URI to search its own database, and if the search returns
683 exactly one entry, the SASL name is replaced by the DN of that entry.
686 options can be given in the configuration file to allow for multiple matching
687 and replacement patterns. The matching patterns are checked in the order they
688 appear in the file, stopping at the first successful match.
691 .\"Because the plus sign + is a character recognized by the regular expression engine,
692 .\"and it will appear in SASL names that include a REALM, be careful to escape the
693 .\"plus sign with a backslash \\+ to remove the character's special meaning.
696 .B sasl-secprops <properties>
697 Used to specify Cyrus SASL security properties.
700 flag (without any other properities) causes the flag properites
701 default, "noanonymous,noplain", to be cleared.
704 flag disables mechanisms susceptible to simple passive attacks.
707 flag disables mechanisms susceptible to active attacks.
710 flag disables mechanisms susceptible to passive dictionary attacks.
713 flag disables mechanisms which support anonymous login.
716 flag require forward secrecy between sessions.
719 require mechanisms which pass client credentials (and allow
720 mechanisms which can pass credentials to do so).
723 property specifies the minimum acceptable
724 .I security strength factor
725 as an integer approximate to effective key length used for
726 encryption. 0 (zero) implies no protection, 1 implies integrity
727 protection only, 56 allows DES or other weak ciphers, 112
728 allows triple DES and other strong ciphers, 128 allows RC4,
729 Blowfish and other modern strong ciphers. The default is 0.
732 property specifies the maximum acceptable
733 .I security strength factor
734 as an integer (see minssf description). The default is INT_MAX.
737 property specifies the maximum security layer receive buffer
738 size allowed. 0 disables security layers. The default is 65536.
741 Specify the distinguished name for the subschema subentry that
742 controls the entries on this server. The default is "cn=Subschema".
744 .B security <factors>
745 Specify a set of factors (separated by white space) to require.
746 An integer value is associated with each factor and is roughly
747 equivalent of the encryption key length to require. A value
748 of 112 is equivalent to 3DES, 128 to Blowfish, etc..
749 The directive may be specified globally and/or per-database.
751 specifies the overall security strength factor.
753 specifies the transport security strength factor.
755 specifies the TLS security strength factor.
757 specifies the SASL security strength factor.
759 specifies the overall security strength factor to require for
761 .B update_transport=<n>
762 specifies the transport security strength factor to require for
765 specifies the TLS security strength factor to require for
768 specifies the SASL security strength factor to require for
771 specifies the security strength factor required for
773 username/password authentication.
776 factor is measure of security provided by the underlying transport,
777 e.g. ldapi:// (and eventually IPSEC). It is not normally used.
779 .B sizelimit {<integer>|unlimited}
781 .B sizelimit size[.{soft|hard|unchecked}]=<integer> [...]
782 Specify the maximum number of entries to return from a search operation.
783 The default size limit is 500.
788 to specify no limits.
789 The second format allows a fine grain setting of the size limits.
790 Extra args can be added on the same line.
793 for an explanation of the different flags.
795 .B sockbuf_max_incoming <integer>
796 Specify the maximum incoming LDAP PDU size for anonymous sessions.
797 The default is 262143.
799 .B sockbuf_max_incoming_auth <integer>
800 Specify the maximum incoming LDAP PDU size for authenticated sessions.
801 The default is 4194303.
804 Specify the srvtab file in which the kerberos keys necessary for
805 authenticating clients using kerberos can be found. This option is only
806 meaningful if you are using Kerberos authentication.
809 Specify the maximum size of the primary thread pool.
812 .B timelimit {<integer>|unlimited}
814 .B timelimit time[.{soft|hard}]=<integer> [...]
815 Specify the maximum number of seconds (in real time)
817 will spend answering a search request. The default time limit is 3600.
822 to specify no limits.
823 The second format allows a fine grain setting of the time limits.
824 Extra args can be added on the same line.
827 for an explanation of the different flags.
829 .B ucdata-path <path>
830 Specify the path to the directory containing the Unicode character
831 tables. The default path is LOCALSTATEDIR/ucdata.
835 is built with support for Transport Layer Security, there are more options
838 .B TLSCipherSuite <cipher-suite-spec>
839 Permits configuring what ciphers will be accepted and the preference order.
840 <cipher-suite-spec> should be a cipher specification for OpenSSL. Example:
842 TLSCipherSuite HIGH:MEDIUM:+SSLv2
844 To check what ciphers a given spec selects, use:
846 openssl ciphers -v <cipher-suite-spec>
848 .B TLSCACertificateFile <filename>
849 Specifies the file that contains certificates for all of the Certificate
854 .B TLSCACertificatePath <path>
855 Specifies the path of a directory that contains Certificate Authority
856 certificates in separate individual files. Usually only one of this
857 or the TLSCACertificateFile is used.
859 .B TLSCertificateFile <filename>
860 Specifies the file that contains the
864 .B TLSCertificateKeyFile <filename>
865 Specifies the file that contains the
867 server private key that matches the certificate stored in the
868 .B TLSCertificateFile
869 file. Currently, the private key must not be protected with a password, so
870 it is of critical importance that it is protected carefully.
872 .B TLSRandFile <filename>
873 Specifies the file to obtain random bits from when /dev/[u]random
874 is not available. Generally set to the name of the EGD/PRNGD socket.
875 The environment variable RANDFILE can also be used to specify the filename.
877 .B TLSVerifyClient <level>
878 Specifies what checks to perform on client certificates in an
879 incoming TLS session, if any.
882 can be specified as one of the following keywords:
888 will not ask the client for a certificate.
891 The client certificate is requested. If no certificate is provided,
892 the session proceeds normally. If a bad certificate is provided,
893 it will be ignored and the session proceeds normally.
896 The client certificate is requested. If no certificate is provided,
897 the session proceeds normally. If a bad certificate is provided,
898 the session is immediately terminated.
900 .B demand | hard | true
901 These keywords are all equivalent, for compatibility reasons.
902 The client certificate is requested. If no certificate is provided,
903 or a bad certificate is provided, the session is immediately terminated.
905 Note that a valid client certificate is required in order to use the
906 SASL EXTERNAL authentication mechanism with a TLS session. As such,
909 setting must be chosen to enable SASL EXTERNAL authentication.
911 .SH GENERAL BACKEND OPTIONS
912 Options in this section only apply to the configuration file section
913 for the specified backend. They are supported by every
916 .B backend <databasetype>
917 Mark the beginning of a backend definition. <databasetype>
932 depending on which backend will serve the database.
934 .SH GENERAL DATABASE OPTIONS
935 Options in this section only apply to the configuration file section
936 for the database in which they are defined. They are supported by every
937 type of backend. Note that the
941 option are mandatory for each database.
943 .B database <databasetype>
944 Mark the beginning of a new database instance definition. <databasetype>
959 depending on which backend will serve the database.
964 will automatically maintain the
965 modifiersName, modifyTimestamp, creatorsName, and
966 createTimestamp attributes for entries. By default, lastmod is on.
968 .B maxderefdepth <depth>
969 Specifies the maximum number of aliases to dereference when trying to
970 resolve an entry, used to avoid inifinite alias loops. The default is 1.
973 This option puts the database into "read-only" mode. Any attempts to
974 modify the database will return an "unwilling to perform" error. By
975 default, readonly is off.
977 .B replica host=<hostname>[:port] [tls=yes|critical]
978 .B [suffix=<suffix> [...]]
979 .B bindmethod=simple|sasl [binddn=<simple DN>] [credentials=<simple password>]
980 .B [saslmech=<SASL mech>] [secprops=<properties>] [realm=<realm>]
981 .B [authcId=<authentication ID>] [authzId=<authorization ID>]
982 .B [attr[!]=<attr list>]
984 Specify a replication site for this database. Refer to the "OpenLDAP
985 Administrator's Guide" for detailed information on setting up a replicated
987 directory service. Zero or more
989 instances can be used to select the subtrees that will be replicated
990 (defaults to all the database). A
998 and should only be used when adequate security services
999 (e.g TLS or IPSEC) are in place. A
1005 Specific security properties (as with the
1007 keyword above) for a SASL bind can be set with the
1009 option. A non-default SASL realm can be set with the
1014 will use Kerberos, a kerberos instance should be given in
1018 can be given after the
1020 keyword to allow the selective replication of the listed attributes only;
1023 mark is used, the list is considered exclusive, i.e. the listed attributes
1025 If an objectClass is listed, all the related attributes
1026 are (are not) replicated.
1029 .B replogfile <filename>
1030 Specify the name of the replication log file to log changes to.
1031 The replication log is typically written by
1036 .BR slapd.replog (5)
1037 for more information. The specified file should be located
1038 in a directory with limited read/write/execute access as the replication
1039 logs may contain sensitive information.
1042 Specify the distinguished name that is not subject to access control
1043 or administrative limit restrictions for operations on this database.
1044 This DN may or may not be associated with an entry. An empty root
1045 DN (the default) specifies no root access is to be granted. It is
1046 recommended that the rootdn only be specified when needed (such as
1047 when initially populating a database). If the rootdn is within
1048 a namingContext (suffix) of the database, a simple bind password
1049 may also be provided using the
1053 .B rootpw <password>
1054 Specify a password (or hash of the password) for the rootdn. The
1055 password can only be set if the rootdn is within the namingContext
1056 (suffix) of the database.
1057 This option accepts all RFC 2307 userPassword formats known to
1060 desription) as well as cleartext.
1062 may be used to generate a hash of a password. Cleartext
1063 and \fB{CRYPT}\fP passwords are not recommended. If empty
1064 (the default), authentication of the root DN is by other means
1065 (e.g. SASL). Use of SASL is encouraged.
1067 .B suffix <dn suffix>
1068 Specify the DN suffix of queries that will be passed to this
1069 backend database. Multiple suffix lines can be given and at least one is
1070 required for each database definition.
1071 If the suffix of one database is "inside" that of another, the database
1072 with the inner suffix must come first in the configuration file.
1075 Specify that the current backend database is a subordinate of another
1076 backend database. A subordinate database may have only one suffix. This
1077 option may be used to glue multiple databases into a single namingContext.
1078 If the suffix of the current database is within the namingContext of a
1079 superior database, searches against the superior database will be
1080 propagated to the subordinate as well. All of the databases
1081 associated with a single namingContext should have identical rootdns.
1082 Behavior of other LDAP operations is unaffected by this setting. In
1083 particular, it is not possible to use moddn to move an entry from
1084 one subordinate to another subordinate within the namingContext.
1087 This option is only applicable in a slave
1089 It specifies the DN allowed to make changes to the replica (typically,
1092 binds as when making changes to the replica).
1095 Specify the referral to pass back when
1097 is asked to modify a replicated local database.
1098 If specified multiple times, each url is provided.
1099 .SH DATABASE-SPECIFIC OPTIONS
1100 Each database may allow specific configuration options; they are
1101 documented separately in the
1102 .BR slapd-<backend> (5)
1106 Here is a short example of a configuration file:
1110 include SYSCONFDIR/schema/core.schema
1111 pidfile LOCALSTATEDIR/slapd.pid
1113 # Subtypes of "name" (e.g. "cn" and "ou") with the
1114 # option ";x-hidden" can be searched for/compared,
1115 # but are not shown. See \fBslapd.access\fP(5).
1116 attributeoptions x-hidden lang-
1117 access to attr=name;x-hidden by * =cs
1120 suffix "dc=our-domain,dc=com"
1121 # The database directory MUST exist prior to
1122 # running slapd AND should only be accessible
1123 # by the slapd/tools. Mode 700 recommended.
1124 directory LOCALSTATEDIR/openldap-data
1125 # Indices to maintain
1126 index objectClass eq
1127 index cn,sn,mail pres,eq,approx,sub
1129 # We serve small clients that do not handle referrals,
1130 # so handle remote lookups on their behalf.
1133 uri ldap://ldap.some-server.com/
1138 "OpenLDAP Administrator's Guide" contains a longer annotated
1139 example of a configuration file.
1140 The original ETCDIR/slapd.conf is another example.
1144 default slapd configuration file
1148 .BR slapd-dnssrv (5),
1153 .BR slapd-passwd (5),
1155 .BR slapd-shell (5),
1158 .BR slapd.replog (5),
1159 .BR slapd.access (5),
1168 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
1169 .SH ACKNOWLEDGEMENTS
1171 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
1173 is derived from University of Michigan LDAP 3.3 Release.
projects / openldap / blob