1 .TH SLAPD.CONF 5 "22 September 1998" "OpenLDAP LDVERSION"
3 slapd.conf \- configuration file for slapd, the stand-alone LDAP daemon
9 contains configuration information for the
11 daemon. This configuration file is also used by the
13 replication daemon and by the LDBM indexing utilities
16 .BR ldif2id2entry (8),
18 .BR ldif2id2children (8).
22 file consists of a series of global configuration options that apply to
24 as a whole (including all backends), followed by zero or more database
25 backend definitions that contain information specific to a backend
33 # comment - these options apply to every database
34 <global configuration options>
35 # first database definition & configuration options
36 database <backend 1 type>
37 <configuration options specific to backend 1>
38 # subsequent database definitions & configuration options
42 As many backend-specific sections as desired may be included. Global
43 options can be overridden in a backend (for options that appear more
44 than once, the last appearance in the
46 file is used). Blank lines and comment lines beginning with a `#'
47 character are ignored. If a line begins with white space, it is
48 considered a continuation of the previous line.
50 Arguments on configuration lines are separated by white space. If an
51 argument contains white space, the argument should be enclosed in
52 double quotes. If an argument contains a double quote (`"') or a
53 backslash character (`\\'), the character should be preceded by a
56 The specific configuration options available are discussed below in the
57 Global Configuration Options, General Backend Options, LDBM
58 Backend-Specific Options, Shell Backend-Specific Options, and Password
59 Backend-Specific Options sections. Refer to "The SLAPD and SLURPD
60 Administrator's Guide" for more details on the slapd configuration
62 .SH GLOBAL CONFIGURATION OPTIONS
63 Options described in this section apply to all backends, unless specifically
64 overridden in a backend definition. Arguments that should be replaced by
65 actual text are shown in brackets <>.
68 access to <what> [ by <who> <accesslevel> ]+
69 Grant access (specified by <accesslevel>) to a set of entries and/or
70 attributes (specified by <what>) by one or more requestors (specified
71 by <who>). Refer to "The SLAPD and SLURPD Administrator's Guide" for
72 information on using the
74 access-control mechanisms.
77 attribute <name> [<name2>] { bin | ces | cis | tel | dn }
78 Associate a syntax with an attribute name. By default, an
79 attribute is assumed to have syntax
81 An optional alternate name can be
82 given for an attribute. The possible syntaxes and their meanings are:
97 telephone number string
106 defaultaccess { none | compare | search | read | write | delete }
107 Specify the default access to grant requestors not matched by
108 any other access line. The default behavior is to grant read access.
110 .B include <filename>
111 Read additional configuration information from the given file before
112 continuing with the next line of the current file.
114 .B loglevel <integer>
115 Specify the level at which debugging statements and operation
116 statistics should be syslogged (currently logged to the
118 LOG_LOCAL4 facility). Log levels are additive, and available levels
128 debug packet handling
131 heavy trace debugging
134 connection management
137 print out packets sent and received
140 search filter processing
143 configuration file processing
146 access control list processing
149 stats log connections/operations/results
152 stats log entries sent
155 print communication with shell backends
164 objectclass <name> requires <attrs> allows <attrs>
165 Define the schema rules for the object class named <name>. These are
166 used in conjunction with the schemacheck option.
169 Specify the referral to pass back when
171 cannot find a local database to handle a request.
173 .B schemacheck { on | off }
174 Turn schema checking on or off. The default is off.
176 .B sizelimit <integer>
177 Specify the maximum number of entries to return from a search operation.
178 The default size limit is 500.
181 Specify the srvtab file in which the kerberos keys necessary for
182 authenticating clients using kerberos can be found. This option is only
183 meaningful if you are using Kerberos authentication.
185 .B timelimit <integer>
186 Specify the maximum number of seconds (in real time)
188 will spend answering a search request. The default time limit is 3600.
189 .SH GENERAL BACKEND OPTIONS
190 Options in this section only apply to the configuration file section
191 for the backend in which they are defined. They are supported by every
194 .B database <databasetype>
195 Mark the beginning of a new database instance definition. <databasetype>
201 depending on which backend will serve the database.
206 will automatically maintain the
207 modifiersName, modifyTimestamp, creatorsName, and
208 createTimestamp attributes for entries. By default, lastmod is off.
211 This option puts the database into "read-only" mode. Any attempts to
212 modify the database will return an "unwilling to perform" error. By
213 default, readonly is off.
216 replica host=<hostname>[:port] "binddn=<DN>" bindmethod=simple |
218 kerberos [credentials=<password>] [srvtab=<filename>]
220 Specify a replication site for this database. Refer to "The SLAPD and
221 SLURPD Administrator's Guide" for detailed information on setting up
226 .B replogfile <filename>
227 Specify the name of the replication log file to log changes to.
228 The replication log is typically written by
234 for more information.
237 Specify the DN of an entry that is not subject to access control
238 or administrative limit restrictions for operations on this database.
241 Specify a password for the rootdn.
243 .B suffix <dn suffix>
244 Specify the DN suffix of queries that will be passed to this
245 backend database. Multiple suffix lines can be given and at least one is
246 required for each database definition.
249 This option is only applicable in a slave
251 It specifies the DN allowed to make changes to the replica (typically,
254 binds as when making changes to the replica).
255 .SH LDBM BACKEND-SPECIFIC OPTIONS
256 Options in this category only apply to the LDBM backend database. That is,
257 they must follow a "database ldbm" line and come before any subsequent
258 "database" lines. The LDBM backend is a high-performance database that
259 makes extensive use of indexing and caching to speed data access.
261 .B cachesize <integer>
262 Specify the size in entries of the in-memory cache maintained
263 by the LDBM backend database instance. The default is 1000 entries.
265 .B dbcachesize <integer>
266 Specify the size in bytes of the in-memory cache associated
267 with each open index file. If not supported by the underlying database
268 method, this option is ignored without comment. The default is 100000 bytes.
270 Specify that database writes should not be immediately synchronized
271 with in memory changes. Enabling this option may improving performance
272 at the expense of data security.
274 .B directory <directory>
275 Specify the directory where the LDBM files containing the database and
276 associated indexes live. The default is
280 index { <attrlist> | default } [ pres,eq,approx,sub,none ]
281 Specify the indexes to maintain for the given attribute. If only
282 an <attr> is given, all possible indexes are maintained.
285 Specify the file protection mode that newly created database
286 index files should have. The default is 0600.
287 .SH SHELL BACKEND-SPECIFIC OPTIONS
288 Options in this category only apply to the SHELL backend database. That is,
289 they must follow a "database shell" line and come before any subsequent
290 "database" lines. The Shell backend executes external programs to
291 implement operations, and is designed to make it easy to tie an existing
302 .B compare <pathname>
312 .B abandon <pathname>
313 These options specify the pathname of the command to execute in response
314 to the given LDAP operation. The command given should understand and
315 follow the input/output conventions described in Appendix B of "The SLAPD
316 and SLURPD Administrator's Guide."
318 Note that you need only supply configuration lines for those commands you
319 want the backend to handle. Operations for which a command is not
320 supplied will be refused with an "unwilling to perform" error.
321 .SH PASSWORD BACKEND-SPECIFIC OPTIONS
322 Options in this category only apply to the PASSWD backend database.
323 That is, they must follow a "database passwd" line and come before any
324 subsequent "database" lines. The PASSWD database serves up the user
325 account information listed in the system
330 Specifies an alternate passwd file to use. The default is
333 "The SLAPD and SLURPD Administrator's Guide" contains an annotated
334 example of a configuration file.
339 .BR slapd.replog (5),
344 "The SLAPD and SLURPD Administrator's Guide"
347 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
349 is derived from University of Michigan LDAP 3.3 Release.