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
 128 locale { <locale-name> | on | off }
 129 Obey <locale-name>'s character classification and case conversion; i.e. the
 130 .BR locale (5)
 131 LC_CTYPE category.  See
 132 .BR locale (5)
 133 for details about locales.  "on" takes the locale from the environment,
 134 typically $LANG or $LC_CTYPE, and will only work properly if slapd will
 135 run with the same environment variables as when the database was
 136 generated.  "off" (the default setting) resets to the initial "C" locale.
 137 .TP
 138 .B loglevel <integer>
 139 Specify the level at which debugging statements and operation
 140 statistics should be syslogged (currently logged to the
 141 .BR syslogd (8)
 142 LOG_LOCAL4 facility).  Log levels are additive, and available levels
 143 are:
 144 .RS
 145 .RS
 146 .PD 0
 147 .TP
 148 .B 1
 149 trace function calls
 150 .TP
 151 .B 2
 152 debug packet handling
 153 .TP
 154 .B 4
 155 heavy trace debugging
 156 .TP
 157 .B 8
 158 connection management
 159 .TP
 160 .B 16
 161 print out packets sent and received
 162 .TP
 163 .B 32
 164 search filter processing
 165 .TP
 166 .B 64
 167 configuration file processing
 168 .TP
 169 .B 128
 170 access control list processing
 171 .TP
 172 .B 256
 173 stats log connections/operations/results
 174 .TP
 175 .B 512
 176 stats log entries sent
 177 .TP
 178 .B 1024
 179 print communication with shell backends
 180 .TP
 181 .B 2048
 182 entry parsing
 183 .PD
 184 .RE
 185 .RE
 186 .TP
 187 .B
 188 objectclass <name> requires <attrs> allows <attrs>
 189 Define the schema rules for the object class named <name>.  These are
 190 used in conjunction with the schemacheck option.
 191 .TP
 192 .B referral <url>
 193 Specify the referral to pass back when
 194 .BR slapd (8)
 195 cannot find a local database to handle a request.
 196 .TP
 197 .B schemacheck { on | off }
 198 Turn schema checking on or off. The default is on.
 199 .TP
 200 .B sizelimit <integer>
 201 Specify the maximum number of entries to return from a search operation.
 202 The default size limit is 500.
 203 .TP
 204 .B srvtab <filename>
 205 Specify the srvtab file in which the kerberos keys necessary for
 206 authenticating clients using kerberos can be found. This option is only
 207 meaningful if you are using Kerberos authentication.
 208 .TP
 209 .B timelimit <integer>
 210 Specify the maximum number of seconds (in real time)
 211 .B slapd
 212 will spend answering a search request.  The default time limit is 3600.
 213 .SH GENERAL BACKEND OPTIONS
 214 Options in this section only apply to the configuration file section
 215 for the backend in which they are defined.  They are supported by every
 216 type of backend.
 217 .TP
 218 .B database <databasetype>
 219 Mark the beginning of a new database instance definition. <databasetype>
 220 should be one of
 221 .B ldbm,
 222 .B shell,
 223 or
 224 .B passwd
 225 depending on which backend will serve the database.
 226 .TP
 227 .B lastmod on | off
 228 Controls whether
 229 .B slapd
 230 will automatically maintain the
 231 modifiersName, modifyTimestamp, creatorsName, and
 232 createTimestamp attributes for entries.  By default, lastmod is off.
 233 .TP
 234 .B readonly on | off
 235 This option puts the database into "read-only" mode.  Any attempts to
 236 modify the database will return an "unwilling to perform" error.  By
 237 default, readonly is off.
 238 .TP
 239 .B
 240 replica host=<hostname>[:port] "binddn=<DN>" bindmethod=simple |
 241 .B
 242 kerberos [credentials=<password>] [srvtab=<filename>]
 243 .br
 244 Specify a replication site for this database.  Refer to "The SLAPD and
 245 SLURPD Administrator's Guide" for detailed information on setting up
 246 a replicated
 247 .B slapd
 248 directory service.
 249 .TP
 250 .B replogfile <filename>
 251 Specify the name of the replication log file to log changes to.
 252 The replication log is typically written by
 253 .BR slapd (8)
 254 and read by
 255 .BR slurpd (8).
 256 See
 257 .BR slapd.replog (5)
 258 for more information.
 259 .TP
 260 .B rootdn <dn>
 261 Specify the DN of an entry that is not subject to access control
 262 or administrative limit restrictions for operations on this database.
 263 .TP
 264 .B rootpw <password>
 265 Specify a password (or hash of the password) for the rootdn.
 266 This option accepts all password formats known to the server
 267 including \fB{SHA}\fP, \fB{MD5}\fP, \fB{CRYPT}\fP, and cleartext.
 268 Cleartext passwords are not recommended.
 269 .TP
 270 .B suffix <dn suffix>
 271 Specify the DN suffix of queries that will be passed to this
 272 backend database.  Multiple suffix lines can be given and at least one is
 273 required for each database definition.
 274 .TP
 275 .B updatedn <dn>
 276 This option is only applicable in a slave
 277 .B slapd.
 278 It specifies the DN allowed to make changes to the replica (typically,
 279 this is the DN
 280 .BR slurpd (8)
 281 binds as when making changes to the replica).
 282 .SH LDBM BACKEND-SPECIFIC OPTIONS
 283 Options in this category only apply to the LDBM backend database. That is,
 284 they must follow a "database ldbm" line and come before any subsequent
 285 "database" lines.  The LDBM backend is a high-performance database that
 286 makes extensive use of indexing and caching to speed data access.
 287 .TP
 288 .B cachesize <integer>
 289 Specify the size in entries of the in-memory cache maintained
 290 by the LDBM backend database instance.  The default is 1000 entries.
 291 .TP
 292 .B dbcachesize <integer>
 293 Specify the size in bytes of the in-memory cache associated
 294 with each open index file. If not supported by the underlying database
 295 method, this option is ignored without comment.  The default is 100000 bytes.
 296 .TP
 297 .B dbcachenowsync
 298 Specify that database writes should not be immediately synchronized
 299 with in memory changes.  Enabling this option may improve performance
 300 at the expense of data security.
 301 .TP
 302 .B directory <directory>
 303 Specify the directory where the LDBM files containing the database and
 304 associated indexes live.  The default is
 305 .B /usr/tmp.
 306 .TP
 307 .B
 308 index { <attrlist> | default } [ pres,eq,approx,sub,none ]
 309 Specify the indexes to maintain for the given attribute. If only
 310 an <attr> is given, all possible indexes are maintained.
 311 .TP
 312 .B mode <integer>
 313 Specify the file protection mode that newly created database
 314 index files should have.  The default is 0600.
 315 .SH SHELL BACKEND-SPECIFIC OPTIONS
 316 Options in this category only apply to the SHELL backend database. That is,
 317 they must follow a "database shell" line and come before any subsequent
 318 "database" lines.  The Shell backend executes external programs to
 319 implement operations, and is designed to make it easy to tie an existing
 320 database to the
 321 .B slapd
 322 front-end.
 323 .TP
 324 .B bind <pathname>
 325 .TP
 326 .B unbind <pathname>
 327 .TP
 328 .B search <pathname>
 329 .TP
 330 .B compare <pathname>
 331 .TP
 332 .B modify <pathname>
 333 .TP
 334 .B modrdn <pathname>
 335 .TP
 336 .B add <pathname>
 337 .TP
 338 .B delete <pathname>
 339 .TP
 340 .B abandon <pathname>
 341 These options specify the pathname of the command to execute in response
 342 to the given LDAP operation. The command given should understand and
 343 follow the input/output conventions described in Appendix B of "The SLAPD
 344 and SLURPD Administrator's Guide."
 345 .LP
 346 Note that you need only supply configuration lines for those commands you
 347 want the backend to handle. Operations for which a command is not
 348 supplied will be refused with an "unwilling to perform" error.
 349 .SH PASSWORD BACKEND-SPECIFIC OPTIONS
 350 Options in this category only apply to the PASSWD backend database.
 351 That is, they must follow a "database passwd" line and come before any
 352 subsequent "database" lines.  The PASSWD database serves up the user
 353 account information listed in the system
 354 .BR passwd (5)
 355 file.
 356 .TP
 357 .B file <filename>
 358 Specifies an alternate passwd file to use.  The default is
 359 .B /etc/passwd.
 360 .SH EXAMPLE
 361 "The SLAPD and SLURPD Administrator's Guide" contains an annotated
 362 example of a configuration file.
 363 .SH FILES
 364 ETCDIR/slapd.conf
 365 .SH SEE ALSO
 366 .BR ldap (3),
 367 .BR slapd.replog (5),
 368 .BR locale (5),
 369 .BR passwd (5),
 370 .BR slapd (8),
 371 .BR slurpd (8),
 372 .LP
 373 "The SLAPD and SLURPD Administrator's Guide"
 374 .SH ACKNOWLEDGEMENTS
 375 .B      OpenLDAP
 376 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
 377 .B      OpenLDAP
 378 is derived from University of Michigan LDAP 3.3 Release.