2 .\" Copyright 1998-2006 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]
16 .B [\-o option[=value]]
18 .B [\-u user] [\-g group]
23 is the stand-alone LDAP daemon. It listens for LDAP connections on
24 any number of ports (default 389), responding
25 to the LDAP operations it receives over these connections.
27 is typically invoked at boot time, usually out of
31 normally forks and disassociates itself from the invoking tty.
32 If configured in the config file (or config directory),
35 process will print its process ID (see
39 file, as well as the command line options during invocation to an
45 flag is given, even with a zero argument,
47 will not fork and disassociate from the invoking tty.
50 can be configured to provide replicated service for a database with
53 the standalone LDAP update replication daemon.
58 See the "OpenLDAP Administrator's Guide" for more details on
63 Listen on IPv4 addresses only.
66 Listen on IPv6 addresses only.
68 .B \-T {a|c|d|i|p|t|acl|auth}
69 Run in Tool mode. The additional argument selects whether to run as
70 slapadd, slapcat, slapdn, slapindex, slappasswd, or slaptest
71 (slapacl and slapauth need the entire "\fIacl\fP" and "\fIauth\fP"
72 option value to be spelled out, as "\fIa\fP" is reserved to
74 This option should be the first option specified when it is used;
75 any remaining options will be interpreted by the corresponding
76 slap tool program, according to the respective man pages.
77 Note that these tool programs will usually be symbolic links to slapd.
78 This option is provided for situations where symbolic links
79 are not provided or not usable.
81 .BI \-d " debug\-level"
82 Turn on debugging as defined by
84 If this option is specified, even with a zero argument,
86 will not fork or disassociate from the invoking terminal. Some general
87 operation and status messages are printed for any value of \fIdebug\-level\fP.
88 \fIdebug\-level\fP is taken as a bit string, with each bit corresponding to a
89 different kind of debugging information. See <ldap.h> for details.
90 Comma-separated arrays of friendly names can be specified to select
91 debugging output of the corresponding debugging information.
92 All the names recognized by the \fIloglevel\fP directive
93 described in \fBslapd.conf\fP(5) are supported.
94 Remember that if you turn on packet logging, packets containing bind passwords
95 will be output, so if you redirect the log to a logfile, that file should
98 .BI \-s " syslog\-level"
101 at what level debugging statements should be logged to the
104 The value "syslog\-level" can be set to any value or combination
105 allowed by the "-d" switch.
106 Slapd logs all messages selected by "syslog\-level"
107 at the syslog(3) severity level "DEBUG",
108 on the unit specified with "-l".
110 .BI \-n " service\-name"
111 Specifies the service name for logging and other purposes. Defaults
112 to basename of argv[0], i.e.: "slapd".
114 .BI \-l " syslog\-local\-user"
115 Selects the local user of the
117 facility. Value can be
127 However, this option is only permitted on systems that support
131 Logging to syslog(8) occurs at the "DEBUG" severity level.
133 .BI \-f " slapd\-config\-file"
134 Specifies the slapd configuration file. The default is
135 .BR ETCDIR/slapd.conf .
137 .BI \-F " slapd\-config\-directory"
138 Specifies the slapd configuration directory. The default is
144 are specified, the config file will be read and converted to
145 config directory format and written to the specified directory.
146 If neither option is specified, slapd will attempt to read the
147 default config directory before trying to use the default
148 config file. If a valid config directory exists then the
149 default config file is ignored. All of the slap tools that
150 use the config options observe this same behavior.
154 will by default serve
156 (LDAP over TCP on all interfaces on default LDAP port). That is,
157 it will bind using INADDR_ANY and port 389.
160 option may be used to specify LDAP (and other scheme) URLs to serve.
161 For example, if slapd is given
162 .BR "\-h \(dqldap://127.0.0.1:9009/ ldaps:/// ldapi:///\(dq" ,
163 it will listen on 127.0.0.1:9009 for LDAP, 0.0.0.0:636 for LDAP over TLS,
164 and LDAP over IPC (Unix domain sockets). Host 0.0.0.0 represents
165 INADDR_ANY (any interface).
166 A space separated list of URLs is expected. The URLs should be of
167 the LDAP, LDAPS, or LDAPI schemes, and generally
168 without a DN or other optional parameters (excepting as discussed below).
169 Support for the latter two schemes depends on selected configuration
170 options. Hosts may be specified by name or IPv4 and IPv6 address formats.
171 Ports, if specified, must be numeric. The default ldap:// port is 389
172 and the default ldaps:// port is 636.
174 The listener permissions are indicated by
175 "x-mod=-rwxrwxrwx", "x-mod=0777" or "x-mod=777", where any
176 of the "rwx" can be "-" to suppress the related permission, while any
177 of the "7" can be any legal octal digit, according to chmod(1).
178 The listeners can take advantage of the "x-mod"
179 extension to apply rough limitations to operations, e.g. allow read operations
180 ("r", which applies to search and compare), write operations ("w",
181 which applies to add, delete, modify and modrdn), and execute operations
182 ("x", which means bind is required).
183 "User" permissions apply to authenticated users, while "other" apply
184 to anonymous users; "group" permissions are ignored.
185 For example, "ldap:///????x-mod=-rw-------" means that read and write is only allowed
186 for authenticated connections, and bind is required for all operations.
187 This feature is experimental, and requires to be manually enabled
191 Specifies a directory to become the root directory. slapd will
192 change the current working directory to this directory and
195 to this directory. This is done after opening listeners but before
196 reading any configuration file or initializing any backend. When
197 used as a security mechanism, it should be used in conjunction with
205 will run slapd with the specified user name or id, and that user's
206 supplementary group access list as set with initgroups(3). The group ID
207 is also changed to this user's gid, unless the -g option is used to
208 override. Note when used with
210 slapd will use the user database in the change root environment.
212 Note that on some systems, running as a non-privileged user will prevent
213 passwd back-ends from accessing the encrypted passwords. Note also that
214 any shell back-ends will run as the specified non-privileged user.
218 will run with the specified group name or id. Note when used with
220 slapd will use the group database in the change root environment.
223 This option provides a cookie for the syncrepl replication consumer.
224 The cookie is a comma separated list of name=value pairs.
225 Currently supported syncrepl cookie fields are
230 identifies a replication thread within the consumer server
231 and is used to find the syncrepl specification in
233 having the matching replication identifier in its definition. The
235 must be provided in order for any other specified values to be used.
237 is the commit sequence number received by a previous synchronization
238 and represents the state of the consumer replica content which the
239 syncrepl engine will synchronize to the current provider content.
241 .BI \-o " option[=value]"
242 This option provides a generic means to specify options without the need to reserve
243 a separate letter for them.
245 It supports the following options:
248 slp={\fBon\fP|\fBoff\fP|\fIslp\-attrs\fP}
249 When SLP support is compiled into slapd, disable it (
251 ), enable it by registering at SLP DAs without specific SLP attributes (
253 ), or with specific SLP attributes
255 that must be an SLP attribute list definition according to the SLP standard.
257 For example, "-o slp=(tree=production),(server-type=OpenLDAP),(server-version=2.3.20)"
258 registers at SLP DAs with the three SLP attributes tree, server-type and server-version
259 that have the values given above.
260 This allows to specifically query the SLP DAs for LDAP servers holding the
262 tree in case multiple trees are availabe.
267 and have it fork and detach from the terminal and start serving
268 the LDAP databases defined in the default config file, just type:
278 with an alternate configuration file, and turn
279 on voluminous debugging which will be printed on standard error, type:
283 LIBEXECDIR/slapd -f /var/tmp/slapd.conf -d 255
287 To test whether the configuration file is correct or not, type:
298 .BR slapd.access (5),
309 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
311 See http://www.openldap.org/its/
314 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
316 is derived from University of Michigan LDAP 3.3 Release.
projects / openldap / blob