MAN page from Mandrake Other ldap-servers-3.3-3.i386.rpm

SLAPD.CONF

Section: File Formats (5)
Updated: 13 November 1995
Index

NAME

slapd.conf - configuration file for slapd, the stand-alone LDAP daemon

SYNOPSIS

/etc/slapd.conf

DESCRIPTION

The file/etc/slapd.confcontains configuration information for theslapd(8)daemon. This configuration file is also used by theslurpd(8)replication daemon and by the LDBM indexing utilitiesldif2ldbm(8),ldif2index(8),ldif2id2entry(8),andldif2id2children(8).

Theslapd.conffile consists of a series of global configuration options that apply toslapdas a whole (including all backends), followed by zero or more databasebackend definitions that contain information specific to a backendinstance.

The general format ofslapd.confis as follows:

    # comment - these options apply to every database    <global configuration options>    # first database definition & configuration options    database    <backend 1 type>    <configuration options specific to backend 1>    # subsequent database definitions & configuration options    ...

As many backend-specific sections as desired may be included. Globaloptions can be overridden in a backend (for options that appear morethan once, the last appearance in theslapd.conffile is used). Blank lines and comment lines beginning with a `#'character are ignored. If a line begins with white space, it isconsidered a continuation of the previous line.

Arguments on configuration lines are separated by white space. If anargument contains white space, the argument should be enclosed indouble quotes. If an argument contains a double quote (`"') or abackslash character (`\'), the character should be preceded by abackslash character.

The specific configuration options available are discussed below in theGlobal Configuration Options, General Backend Options, LDBMBackend-Specific Options, Shell Backend-Specific Options, and PasswordBackend-Specific Options sections. Refer to "The SLAPD and SLURPDAdministrator's Guide" for more details on the slapd configurationfile.

GLOBAL CONFIGURATION OPTIONS

Options described in this section apply to all backends, unless specifically overridden in a backend definition. Arguments that should be replaced by actual text are shown in brackets <>.

access to <what> [ by <who> <accesslevel> ]+

Grant access (specified by <accesslevel>) to a set of entries and/orattributes (specified by <what>) by one or more requestors (specifiedby <who>). Refer to "The SLAPD and SLURPD Administrator's Guide" forinformation on using theslapdaccess-control mechanisms.

attribute <name> [<name2>] { bin | ces | cis | tel | dn }

Associate a syntax with an attribute name. By default, an attribute is assumed to have syntaxcis.An optional alternate name can be given for an attribute. The possible syntaxes and their meanings are:

bin: binary
ces: case exact string
cis: case ignore string
tel: telephone number string
dn: distinguished name

defaultaccess { none | compare | search | read | write | delete }

Specify the default access to grant requestors not matched by any other access line. The default behavior is to grant read access.

include <filename>

Read additional configuration information from the given file beforecontinuing with the next line of the current file.

loglevel <integer>

Specify the level at which debugging statements and operation statistics should be syslogged (currently logged to thesyslogd(8)LOG_LOCAL4 facility). Log levels are additive, and available levelsare:

1: trace function calls
2: debug packet handling
4: heavy trace debugging
8: connection management
16: print out packets sent and received
32: search filter processing
64: configuration file processing
128: access control list processing
256: stats log connections/operations/results
512: stats log entries sent
1024: print communication with shell backends
2048: entry parsing

objectclass <name> requires <attrs> allows <attrs>

Define the schema rules for the object class named <name>. These areused in conjunction with the schemacheck option.

referral <url>

Specify the referral to pass back whenslapd(8)cannot find a local database to handle a request.

schemacheck { on | off }

Turn schema checking on or off. The default is off.

sizelimit <integer>

Specify the maximum number of entries to return from a search operation.The default size limit is 500.

srvtab <filename>

Specify the srvtab file in which the kerberos keys necessary forauthenticating clients using kerberos can be found. This option is onlymeaningful if you are using Kerberos authentication.

timelimit <integer>

Specify the maximum number of seconds (in real time)slapdwill spend answering a search request. The default time limit is 3600.

GENERAL BACKEND OPTIONS

Options in this section only apply to the configuration file sectionfor the backend in which they are defined. They are supported by everytype of backend.

database <databasetype>: Mark the beginning of a new database instance definition. <databasetype>should be one ofldbm,shell,orpasswddepending on which backend will serve the database.
lastmod on | off: Controls whetherslapdwill automatically maintain the modifiersName, modifyTimestamp, creatorsName, and createTimestamp attributes for entries. By default, lastmod is off.
readonly on | off: This option puts the database into "read-only" mode. Any attempts to modify the database will return an "unwilling to perform" error. Bydefault, readonly is off.
replica host=<hostname>[:port] "binddn=<DN>" bindmethod=simple |: kerberos [credentials=<password>] [srvtab=<filename>]
Specify a replication site for this database. Refer to "The SLAPD andSLURPD Administrator's Guide" for detailed information on setting upa replicatedslapddirectory service.
replogfile <filename>: Specify the name of the replication log file to log changes to. The replication log is typically written byslapd(8)and read byslurpd(8).Seeslapd.replog(5)for more information.
rootdn <dn>: Specify the DN of an entry that is not subject to access control or administrative limit restrictions for operations on this database.
rootpw <password>: Specify a password for the rootdn.
suffix <dn suffix>: Specify the DN suffix of queries that will be passed to this backend database. Multiple suffix lines can be given and at least one is required for each database definition.
updatedn <dn>: This option is only applicable in a slaveslapd.It specifies the DN allowed to make changes to the replica (typically,this is the DNslurpd(8)binds as when making changes to the replica).

LDBM BACKEND-SPECIFIC OPTIONS

Options in this category only apply to the LDBM backend database. That is,they must follow a "database ldbm" line and come before any subsequent"database" lines. The LDBM backend is a high-performance database thatmakes extensive use of indexing and caching to speed data access.

cachesize <integer>: Specify the size in entries of the in-memory cache maintained by the LDBM backend database instance. The default is 1000 entries.
dbcachesize <integer>: Specify the size in bytes of the in-memory cache associated with each open index file. If not supported by the underlying database method, this option is ignored without comment. The default is 100000 bytes.
directory <directory>: Specify the directory where the LDBM files containing the database andassociated indexes live. The default is/usr/tmp.
index { <attrlist> | default } [ pres,eq,approx,sub,none ]: Specify the indexes to maintain for the given attribute. If only an <attr> is given, all possible indexes are maintained.
mode <integer>: Specify the file protection mode that newly created database index files should have. The default is 0600.

SHELL BACKEND-SPECIFIC OPTIONS

Options in this category only apply to the SHELL backend database. That is,they must follow a "database shell" line and come before any subsequent"database" lines. The Shell backend executes external programs toimplement operations, and is designed to make it easy to tie an existingdatabase to theslapdfront-end.

bind <pathname>
unbind <pathname>
search <pathname>
compare <pathname>
modify <pathname>
modrdn <pathname>
add <pathname>
delete <pathname>
abandon <pathname>: These options specify the pathname of the command to execute in response to the given LDAP operation. The command given should understand and follow the input/output conventions described in Appendix B of "The SLAPDand SLURPD Administrator's Guide."

Note that you need only supply configuration lines for those commands youwant the backend to handle. Operations for which a command is notsupplied will be refused with an "unwilling to perform" error.

PASSWORD BACKEND-SPECIFIC OPTIONS

Options in this category only apply to the PASSWD backend database.That is, they must follow a "database passwd" line and come before anysubsequent "database" lines. The PASSWD database serves up the useraccount information listed in the systempasswd(5)file.

file <filename>: Specifies an alternate passwd file to use. The default is/etc/passwd.

EXAMPLE

"The SLAPD and SLURPD Administrator's Guide" contains an annotatedexample of a configuration file.

FILES