2 .\" Copyright 1998-2005 The OpenLDAP Foundation All Rights Reserved.
3 .\" Copying restrictions apply. See COPYRIGHT/LICENSE.
4 .TH SLAPD 8C "RELEASEDATE" "OpenLDAP LDVERSION"
6 slapd \- Stand-alone LDAP Daemon
10 .B [\-T {acl|add|auth|cat|dn|index|passwd|test}]
12 .B [\-f slapd\-config\-file]
13 .B [\-F slapd\-config\-directory]
15 .B [\-n service\-name] [\-s syslog\-level] [\-l syslog\-local\-user]
17 .B [\-u user] [\-g group]
22 is the stand-alone LDAP daemon. It listens for LDAP connections on
23 any number of ports (default 389), responding
24 to the LDAP operations it receives over these connections.
26 is typically invoked at boot time, usually out of
30 normally forks and disassociates itself from the invoking tty.
31 If configured in the config file (or config directory),
34 process will print its process ID (see
38 file, as well as the command line options during invocation to an
44 flag is given, even with a zero argument,
46 will not fork and disassociate from the invoking tty.
49 can be configured to provide replicated service for a database with
52 the standalone LDAP update replication daemon.
57 See the "OpenLDAP Administrator's Guide" for more details on
62 Listen on IPv4 addresses only.
65 Listen on IPv6 addresses only.
68 Run in Tool mode. The additional argument selects whether to run as
69 slapadd, slapcat, slapdn, slapindex, slappasswd, or slaptest
70 (slapacl and slapauth need the entire "\fIacl\fP" and "\fIauth\fP"
71 option value to be spelled out, as "\fIa\fP" is reserved to
73 This option should be the first option specified when it is used;
74 any remaining options will be interpreted by the corresponding
75 slap tool program, according to the respective man pages.
76 Note that these tool programs will usually be symbolic links to slapd.
77 This option is provided for situations where symbolic links
78 are not provided or not usable.
80 .BI \-d " debug\-level"
81 Turn on debugging as defined by
83 If this option is specified, even with a zero argument,
85 will not fork or disassociate from the invoking terminal. Some general
86 operation and status messages are printed for any value of \fIdebug\-level\fP.
87 \fIdebug\-level\fP is taken as a bit string, with each bit corresponding to a
88 different kind of debugging information. See <ldap.h> for details.
89 Remember that if you turn on packet logging, packets containing bind passwords
90 will be output, so if you redirect the log to a logfile, that file should
93 .BI \-s " syslog\-level"
96 at what level debugging statements should be logged to the
100 .BI \-n " service\-name"
101 Specifies the service name for logging and other purposes. Defaults
102 to basename of argv[0], i.e.: "slapd".
104 .BI \-l " syslog\-local\-user"
105 Selects the local user of the
107 facility. Value can be
117 However, this option is only permitted on systems that support
122 .BI \-f " slapd\-config\-file"
123 Specifies the slapd configuration file. The default is
124 .BR ETCDIR/slapd.conf .
126 .BI \-F " slapd\-config\-directory"
127 Specifies the slapd configuration file. The default is
133 are specified, the config file will be read and converted to
134 config directory format and written to the specified directory.
135 If neither option is specified, slapd will attempt to read the
136 default config directory before trying to use the default
137 config file. If a valid config directory exists then the
138 default config file is ignored. All of the slap tools that
139 use the config options observe this same behavior.
143 will by default serve
145 (LDAP over TCP on all interfaces on default LDAP port). That is,
146 it will bind using INADDR_ANY and port 389.
149 option may be used to specify LDAP (and other scheme) URLs to serve.
150 For example, if slapd is given
151 .BR "\-h \(dqldap://127.0.0.1:9009/ ldaps:/// ldapi:///\(dq" ,
152 it will listen on 127.0.0.1:9009 for LDAP, 0.0.0.0:636 for LDAP over TLS,
153 and LDAP over IPC (Unix domain sockets). Host 0.0.0.0 represents
154 INADDR_ANY (any interface).
155 A space separated list of URLs is expected. The URLs should be of
156 the LDAP, LDAPS, or LDAPI schemes, and generally
157 without a DN or other optional parameters (excepting as discussed below).
158 Support for the latter two schemes depends on selected configuration
159 options. Hosts may be specified by name or IPv4 and IPv6 address formats.
160 Ports, if specified, must be numeric. The default ldap:// port is 389
161 and the default ldaps:// port is 636.
163 The listener permissions are indicated by
164 "x-mod=-rwxrwxrwx", "x-mod=0777" or "x-mod=777", where any
165 of the "rwx" can be "-" to suppress the related permission, while any
166 of the "7" can be any legal octal digit, according to chmod(1).
167 The listeners can take advantage of the "x-mod"
168 extension to apply rough limitations to operations, e.g. allow read operations
169 ("r", which applies to search and compare), write operations ("w",
170 which applies to add, delete, modify and modrdn), and execute operations
171 ("x", which means bind is required).
172 "User" permissions apply to authenticated users, while "other" apply
173 to anonymous users; "group" permissions are ignored.
174 For example, "ldap:///????x-mod=-rw-------" means that read and write is only allowed
175 for authenticated connections, and bind is required for all operations.
176 This feature is experimental, and requires to be manually enabled
180 Specifies a directory to become the root directory. slapd will
181 change the current working directory to this directory and
184 to this directory. This is done after opening listeners but before
185 reading any configuration file or initializing any backend. When
186 used as a security mechanism, it should be used in conjunction with
194 will run slapd with the specified user name or id, and that user's
195 supplementary group access list as set with initgroups(3). The group ID
196 is also changed to this user's gid, unless the -g option is used to
197 override. Note when used with
199 slapd will use the user database in the change root environment.
201 Note that on some systems, running as a non-privileged user will prevent
202 passwd back-ends from accessing the encrypted passwords. Note also that
203 any shell back-ends will run as the specified non-privileged user.
207 will run with the specified group name or id. Note when used with
209 slapd will use the group database in the change root environment.
212 This option provides a cookie for the syncrepl replication consumer.
213 The cookie is a comma separated list of name=value pairs.
214 Currently supported syncrepl cookie fields are
219 identifies a replication thread within the consumer server
220 and is used to find the syncrepl specification in
222 having the matching replication identifier in its definition. The
224 must be provided in order for any other specified values to be used.
226 is the commit sequence number received by a previous synchronization
227 and represents the state of the consumer replica content which the
228 syncrepl engine will synchronize to the current provider content.
232 and have it fork and detach from the terminal and start serving
233 the LDAP databases defined in the default config file, just type:
243 with an alternate configuration file, and turn
244 on voluminous debugging which will be printed on standard error, type:
248 LIBEXECDIR/slapd -f /var/tmp/slapd.conf -d 255
252 To test whether the configuration file is correct or not, type:
263 .BR slapd.access (5),
274 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
276 See http://www.openldap.org/its/
279 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
281 is derived from University of Michigan LDAP 3.3 Release.