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

   1 .TH SLAPD.CONF 5  "13 November 1995" "U-M LDAP 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 loglevel <integer>
 115 Specify the level at which debugging statements and operation
 116 statistics should be syslogged (currently logged to the
 117 .BR syslogd (8)
 118 LOG_LOCAL4 facility).  Log levels are additive, and available levels
 119 are:
 120 .RS
 121 .RS
 122 .PD 0
 123 .TP
 124 .B 1
 125 trace function calls
 126 .TP
 127 .B 2
 128 debug packet handling
 129 .TP
 130 .B 4
 131 heavy trace debugging
 132 .TP
 133 .B 8
 134 connection management
 135 .TP
 136 .B 16
 137 print out packets sent and received
 138 .TP
 139 .B 32
 140 search filter processing
 141 .TP
 142 .B 64
 143 configuration file processing
 144 .TP
 145 .B 128
 146 access control list processing
 147 .TP
 148 .B 256
 149 stats log connections/operations/results
 150 .TP
 151 .B 512
 152 stats log entries sent
 153 .TP
 154 .B 1024
 155 print communication with shell backends
 156 .TP
 157 .B 2048
 158 entry parsing
 159 .PD
 160 .RE
 161 .RE
 162 .TP
 163 .B
 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.
 167 .TP
 168 .B referral <url>
 169 Specify the referral to pass back when
 170 .BR slapd (8)
 171 cannot find a local database to handle a request.
 172 .TP
 173 .B schemacheck { on | off }
 174 Turn schema checking on or off. The default is off.
 175 .TP
 176 .B sizelimit <integer>
 177 Specify the maximum number of entries to return from a search operation.
 178 The default size limit is 500.
 179 .TP
 180 .B srvtab <filename>
 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.
 184 .TP
 185 .B timelimit <integer>
 186 Specify the maximum number of seconds (in real time)
 187 .B slapd
 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
 192 type of backend.
 193 .TP
 194 .B database <databasetype>
 195 Mark the beginning of a new database instance definition. <databasetype>
 196 should be one of
 197 .B ldbm,
 198 .B shell,
 199 or
 200 .B passwd
 201 depending on which backend will serve the database.
 202 .TP
 203 .B lastmod on | off
 204 Controls whether
 205 .B slapd
 206 will automatically maintain the
 207 modifiersName, modifyTimestamp, creatorsName, and
 208 createTimestamp attributes for entries.  By default, lastmod is off.
 209 .TP
 210 .B readonly on | 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.
 214 .TP
 215 .B
 216 replica host=<hostname>[:port] "binddn=<DN>" bindmethod=simple |
 217 .B
 218 kerberos [credentials=<password>] [srvtab=<filename>]
 219 .br
 220 Specify a replication site for this database.  Refer to "The SLAPD and
 221 SLURPD Administrator's Guide" for detailed information on setting up
 222 a replicated
 223 .B slapd
 224 directory service.
 225 .TP
 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
 229 .BR slapd (8)
 230 and read by
 231 .BR slurpd (8).
 232 See
 233 .BR slapd.replog (5)
 234 for more information.
 235 .TP
 236 .B rootdn <dn>
 237 Specify the DN of an entry that is not subject to access control
 238 or administrative limit restrictions for operations on this database.
 239 .TP
 240 .B rootpw <password>
 241 Specify a password for the rootdn.
 242 .TP
 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.
 247 .TP
 248 .B updatedn <dn>
 249 This option is only applicable in a slave
 250 .B slapd.
 251 It specifies the DN allowed to make changes to the replica (typically,
 252 this is the DN
 253 .BR slurpd (8)
 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.
 260 .TP
 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.
 264 .TP
 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.
 269 .TP
 270 .B directory <directory>
 271 Specify the directory where the LDBM files containing the database and
 272 associated indexes live.  The default is
 273 .B /usr/tmp.
 274 .TP
 275 .B
 276 index { <attrlist> | default } [ pres,eq,approx,sub,none ]
 277 Specify the indexes to maintain for the given attribute. If only
 278 an <attr> is given, all possible indexes are maintained.
 279 .TP
 280 .B mode <integer>
 281 Specify the file protection mode that newly created database
 282 index files should have.  The default is 0600.
 283 .SH SHELL BACKEND-SPECIFIC OPTIONS
 284 Options in this category only apply to the SHELL backend database. That is,
 285 they must follow a "database shell" line and come before any subsequent
 286 "database" lines.  The Shell backend executes external programs to
 287 implement operations, and is designed to make it easy to tie an existing
 288 database to the
 289 .B slapd
 290 front-end.
 291 .TP
 292 .B bind <pathname>
 293 .TP
 294 .B unbind <pathname>
 295 .TP
 296 .B search <pathname>
 297 .TP
 298 .B compare <pathname>
 299 .TP
 300 .B modify <pathname>
 301 .TP
 302 .B modrdn <pathname>
 303 .TP
 304 .B add <pathname>
 305 .TP
 306 .B delete <pathname>
 307 .TP
 308 .B abandon <pathname>
 309 These options specify the pathname of the command to execute in response
 310 to the given LDAP operation. The command given should understand and
 311 follow the input/output conventions described in Appendix B of "The SLAPD
 312 and SLURPD Administrator's Guide."
 313 .LP
 314 Note that you need only supply configuration lines for those commands you
 315 want the backend to handle. Operations for which a command is not
 316 supplied will be refused with an "unwilling to perform" error.
 317 .SH PASSWORD BACKEND-SPECIFIC OPTIONS
 318 Options in this category only apply to the PASSWD backend database.
 319 That is, they must follow a "database passwd" line and come before any
 320 subsequent "database" lines.  The PASSWD database serves up the user
 321 account information listed in the system
 322 .BR passwd (5)
 323 file.
 324 .TP
 325 .B file <filename>
 326 Specifies an alternate passwd file to use.  The default is
 327 .B /etc/passwd.
 328 .SH EXAMPLE
 329 "The SLAPD and SLURPD Administrator's Guide" contains an annotated
 330 example of a configuration file.
 331 .SH FILES
 332 ETCDIR/slapd.conf
 333 .SH SEE ALSO
 334 .BR ldap (3),
 335 .BR slapd.replog (5),
 336 .BR passwd (5),
 337 .BR slapd (8),
 338 .BR slurpd (8),
 339 .LP
 340 "The SLAPD and SLURPD Administrator's Guide"