git.sur5r.net Git - openldap/blob - doc/man/man5/slapd.conf.5

   1 .TH SLAPD.CONF 5 "20 January 1999" "OpenLDAP LDVERSION"
   2 .SH NAME
   3 slapd.conf \- configuration file for slapd, the stand-alone LDAP daemon
   4 .SH SYNOPSIS
   5 ETCDIR/slapd.conf
   6 .SH DESCRIPTION
   7 The file
   8 .B ETCDIR/slapd.conf
   9 contains configuration information for the
  10 .BR slapd (8)
  11 daemon.  This configuration file is also used by the
  12 .BR slurpd (8)
  13 replication daemon and by the LDBM indexing utilities
  14 .BR ldif2ldbm (8),
  15 .BR ldif2index (8),
  16 .BR ldif2id2entry (8),
  17 and
  18 .BR ldif2id2children (8).
  19 .LP
  20 The
  21 .B slapd.conf
  22 file consists of a series of global configuration options that apply to
  23 .B slapd
  24 as a whole (including all backends), followed by zero or more database
  25 backend definitions that contain information specific to a backend
  26 instance.
  27 .LP
  28 The general format of
  29 .B slapd.conf
  30 is as follows:
  31 .LP
  32 .nf
  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
  39     ...
  40 .fi
  41 .LP
  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
  45 .B slapd.conf
  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.
  49 .LP
  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
  54 backslash character.
  55 .LP
  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
  61 file.
  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 <>.
  66 .TP
  67 .B
  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
  73 .B slapd
  74 access-control mechanisms.
  75 .TP
  76 .B
  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
  80 .BR cis .
  81 An optional alternate name can be
  82 given for an attribute. The possible syntaxes and their meanings are:
  83 .RS
  84 .RS
  85 .PD 0
  86 .TP
  87 .B bin
  88 binary
  89 .TP
  90 .B ces
  91 case exact string
  92 .TP
  93 .B cis
  94 case ignore string
  95 .TP
  96 .B tel
  97 telephone number string
  98 .TP
  99 .B dn
 100 distinguished name
 101 .PD
 102 .RE
 103 .RE
 104 .TP
 105 .B
 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.
 109 .TP
 110 .B include <filename>
 111 Read additional configuration information from the given file before
 112 continuing with the next line of the current file.
 113 .TP
 114 .B pidfile <filename>
 115 The ( absolute ) name of a file that will hold the
 116 .B slapd
 117 server's process ID ( see
 118 .BR getpid (2)
 119 ) if started without the debugging command line option.
 120 .TP
 121 .B argsfile <filename>
 122 The ( absolute ) name of a file that will hold the
 123 .B slapd
 124 server's command line options
 125 if started without the debugging command line option.
 126 .TP
 127 .B loglevel <integer>
 128 Specify the level at which debugging statements and operation
 129 statistics should be syslogged (currently logged to the
 130 .BR syslogd (8)
 131 LOG_LOCAL4 facility).  Log levels are additive, and available levels
 132 are:
 133 .RS
 134 .RS
 135 .PD 0
 136 .TP
 137 .B 1
 138 trace function calls
 139 .TP
 140 .B 2
 141 debug packet handling
 142 .TP
 143 .B 4
 144 heavy trace debugging
 145 .TP
 146 .B 8
 147 connection management
 148 .TP
 149 .B 16
 150 print out packets sent and received
 151 .TP
 152 .B 32
 153 search filter processing
 154 .TP
 155 .B 64
 156 configuration file processing
 157 .TP
 158 .B 128
 159 access control list processing
 160 .TP
 161 .B 256
 162 stats log connections/operations/results
 163 .TP
 164 .B 512
 165 stats log entries sent
 166 .TP
 167 .B 1024
 168 print communication with shell backends
 169 .TP
 170 .B 2048
 171 entry parsing
 172 .PD
 173 .RE
 174 .RE
 175 .TP
 176 .B
 177 objectclass <name> requires <attrs> allows <attrs>
 178 Define the schema rules for the object class named <name>.  These are
 179 used in conjunction with the schemacheck option.
 180 .TP
 181 .B referral <url>
 182 Specify the referral to pass back when
 183 .BR slapd (8)
 184 cannot find a local database to handle a request.
 185 .TP
 186 .B schemacheck { on | off }
 187 Turn schema checking on or off. The default is off.
 188 .TP
 189 .B sizelimit <integer>
 190 Specify the maximum number of entries to return from a search operation.
 191 The default size limit is 500.
 192 .TP
 193 .B srvtab <filename>
 194 Specify the srvtab file in which the kerberos keys necessary for
 195 authenticating clients using kerberos can be found. This option is only
 196 meaningful if you are using Kerberos authentication.
 197 .TP
 198 .B timelimit <integer>
 199 Specify the maximum number of seconds (in real time)
 200 .B slapd
 201 will spend answering a search request.  The default time limit is 3600.
 202 .SH GENERAL BACKEND OPTIONS
 203 Options in this section only apply to the configuration file section
 204 for the backend in which they are defined.  They are supported by every
 205 type of backend.
 206 .TP
 207 .B database <databasetype>
 208 Mark the beginning of a new database instance definition. <databasetype>
 209 should be one of
 210 .B ldbm,
 211 .B shell,
 212 or
 213 .B passwd
 214 depending on which backend will serve the database.
 215 .TP
 216 .B lastmod on | off
 217 Controls whether
 218 .B slapd
 219 will automatically maintain the
 220 modifiersName, modifyTimestamp, creatorsName, and
 221 createTimestamp attributes for entries.  By default, lastmod is off.
 222 .TP
 223 .B readonly on | off
 224 This option puts the database into "read-only" mode.  Any attempts to
 225 modify the database will return an "unwilling to perform" error.  By
 226 default, readonly is off.
 227 .TP
 228 .B
 229 replica host=<hostname>[:port] "binddn=<DN>" bindmethod=simple |
 230 .B
 231 kerberos [credentials=<password>] [srvtab=<filename>]
 232 .br
 233 Specify a replication site for this database.  Refer to "The SLAPD and
 234 SLURPD Administrator's Guide" for detailed information on setting up
 235 a replicated
 236 .B slapd
 237 directory service.
 238 .TP
 239 .B replogfile <filename>
 240 Specify the name of the replication log file to log changes to.
 241 The replication log is typically written by
 242 .BR slapd (8)
 243 and read by
 244 .BR slurpd (8).
 245 See
 246 .BR slapd.replog (5)
 247 for more information.
 248 .TP
 249 .B rootdn <dn>
 250 Specify the DN of an entry that is not subject to access control
 251 or administrative limit restrictions for operations on this database.
 252 .TP
 253 .B rootpw <password>
 254 Specify a password (or hash of the password) for the rootdn.
 255 This option accepts all password formats known to the server
 256 including \fB{SHA}\fP, \fB{MD5}\fP, \fB{CRYPT}\fP, and cleartext.
 257 Cleartext passwords are not recommended.
 258 .TP
 259 .B suffix <dn suffix>
 260 Specify the DN suffix of queries that will be passed to this
 261 backend database.  Multiple suffix lines can be given and at least one is
 262 required for each database definition.
 263 .TP
 264 .B updatedn <dn>
 265 This option is only applicable in a slave
 266 .B slapd.
 267 It specifies the DN allowed to make changes to the replica (typically,
 268 this is the DN
 269 .BR slurpd (8)
 270 binds as when making changes to the replica).
 271 .SH LDBM BACKEND-SPECIFIC OPTIONS
 272 Options in this category only apply to the LDBM backend database. That is,
 273 they must follow a "database ldbm" line and come before any subsequent
 274 "database" lines.  The LDBM backend is a high-performance database that
 275 makes extensive use of indexing and caching to speed data access.
 276 .TP
 277 .B cachesize <integer>
 278 Specify the size in entries of the in-memory cache maintained
 279 by the LDBM backend database instance.  The default is 1000 entries.
 280 .TP
 281 .B dbcachesize <integer>
 282 Specify the size in bytes of the in-memory cache associated
 283 with each open index file. If not supported by the underlying database
 284 method, this option is ignored without comment.  The default is 100000 bytes.
 285 .TP
 286 .B dbcachenowsync
 287 Specify that database writes should not be immediately synchronized
 288 with in memory changes.  Enabling this option may improve performance
 289 at the expense of data security.
 290 .TP
 291 .B directory <directory>
 292 Specify the directory where the LDBM files containing the database and
 293 associated indexes live.  The default is
 294 .B /usr/tmp.
 295 .TP
 296 .B
 297 index { <attrlist> | default } [ pres,eq,approx,sub,none ]
 298 Specify the indexes to maintain for the given attribute. If only
 299 an <attr> is given, all possible indexes are maintained.
 300 .TP
 301 .B mode <integer>
 302 Specify the file protection mode that newly created database
 303 index files should have.  The default is 0600.
 304 .SH SHELL BACKEND-SPECIFIC OPTIONS
 305 Options in this category only apply to the SHELL backend database. That is,
 306 they must follow a "database shell" line and come before any subsequent
 307 "database" lines.  The Shell backend executes external programs to
 308 implement operations, and is designed to make it easy to tie an existing
 309 database to the
 310 .B slapd
 311 front-end.
 312 .TP
 313 .B bind <pathname>
 314 .TP
 315 .B unbind <pathname>
 316 .TP
 317 .B search <pathname>
 318 .TP
 319 .B compare <pathname>
 320 .TP
 321 .B modify <pathname>
 322 .TP
 323 .B modrdn <pathname>
 324 .TP
 325 .B add <pathname>
 326 .TP
 327 .B delete <pathname>
 328 .TP
 329 .B abandon <pathname>
 330 These options specify the pathname of the command to execute in response
 331 to the given LDAP operation. The command given should understand and
 332 follow the input/output conventions described in Appendix B of "The SLAPD
 333 and SLURPD Administrator's Guide."
 334 .LP
 335 Note that you need only supply configuration lines for those commands you
 336 want the backend to handle. Operations for which a command is not
 337 supplied will be refused with an "unwilling to perform" error.
 338 .SH PASSWORD BACKEND-SPECIFIC OPTIONS
 339 Options in this category only apply to the PASSWD backend database.
 340 That is, they must follow a "database passwd" line and come before any
 341 subsequent "database" lines.  The PASSWD database serves up the user
 342 account information listed in the system
 343 .BR passwd (5)
 344 file.
 345 .TP
 346 .B file <filename>
 347 Specifies an alternate passwd file to use.  The default is
 348 .B /etc/passwd.
 349 .SH EXAMPLE
 350 "The SLAPD and SLURPD Administrator's Guide" contains an annotated
 351 example of a configuration file.
 352 .SH FILES
 353 ETCDIR/slapd.conf
 354 .SH SEE ALSO
 355 .BR ldap (3),
 356 .BR slapd.replog (5),
 357 .BR passwd (5),
 358 .BR slapd (8),
 359 .BR slurpd (8),
 360 .LP
 361 "The SLAPD and SLURPD Administrator's Guide"
 362 .SH ACKNOWLEDGEMENTS
 363 .B      OpenLDAP
 364 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
 365 .B      OpenLDAP
 366 is derived from University of Michigan LDAP 3.3 Release.