2 .\" Copyright 1998-2007 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_log.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 If \fIdebug\-level\fP is \fB?\fP, a list of installed levels is printed,
97 Remember that if you turn on packet logging, packets containing bind passwords
98 will be output, so if you redirect the log to a logfile, that file should
101 .BI \-s " syslog\-level"
104 at what level debugging statements should be logged to the
107 The value "syslog\-level" can be set to any value or combination
108 allowed by the "-d" switch.
109 Slapd logs all messages selected by "syslog\-level"
110 at the syslog(3) severity level "DEBUG",
111 on the unit specified with "-l".
113 .BI \-n " service\-name"
114 Specifies the service name for logging and other purposes. Defaults
115 to basename of argv[0], i.e.: "slapd".
117 .BI \-l " syslog\-local\-user"
118 Selects the local user of the
120 facility. Value can be
130 However, this option is only permitted on systems that support
134 Logging to syslog(8) occurs at the "DEBUG" severity level.
136 .BI \-f " slapd\-config\-file"
137 Specifies the slapd configuration file. The default is
138 .BR ETCDIR/slapd.conf .
140 .BI \-F " slapd\-config\-directory"
141 Specifies the slapd configuration directory. The default is
147 are specified, the config file will be read and converted to
148 config directory format and written to the specified directory.
149 If neither option is specified, slapd will attempt to read the
150 default config directory before trying to use the default
151 config file. If a valid config directory exists then the
152 default config file is ignored. All of the slap tools that
153 use the config options observe this same behavior.
157 will by default serve
159 (LDAP over TCP on all interfaces on default LDAP port). That is,
160 it will bind using INADDR_ANY and port 389.
163 option may be used to specify LDAP (and other scheme) URLs to serve.
164 For example, if slapd is given
165 .BR "\-h \(dqldap://127.0.0.1:9009/ ldaps:/// ldapi:///\(dq" ,
166 it will listen on 127.0.0.1:9009 for LDAP, 0.0.0.0:636 for LDAP over TLS,
167 and LDAP over IPC (Unix domain sockets). Host 0.0.0.0 represents
168 INADDR_ANY (any interface).
169 A space separated list of URLs is expected. The URLs should be of
170 the LDAP, LDAPS, or LDAPI schemes, and generally
171 without a DN or other optional parameters (excepting as discussed below).
172 Support for the latter two schemes depends on selected configuration
173 options. Hosts may be specified by name or IPv4 and IPv6 address formats.
174 Ports, if specified, must be numeric. The default ldap:// port is 389
175 and the default ldaps:// port is 636.
177 The listener permissions are indicated by
178 "x-mod=-rwxrwxrwx", "x-mod=0777" or "x-mod=777", where any
179 of the "rwx" can be "-" to suppress the related permission, while any
180 of the "7" can be any legal octal digit, according to chmod(1).
181 The listeners can take advantage of the "x-mod"
182 extension to apply rough limitations to operations, e.g. allow read operations
183 ("r", which applies to search and compare), write operations ("w",
184 which applies to add, delete, modify and modrdn), and execute operations
185 ("x", which means bind is required).
186 "User" permissions apply to authenticated users, while "other" apply
187 to anonymous users; "group" permissions are ignored.
188 For example, "ldap:///????x-mod=-rw-------" means that read and write is only allowed
189 for authenticated connections, and bind is required for all operations.
190 This feature is experimental, and requires to be manually enabled
194 Specifies a directory to become the root directory. slapd will
195 change the current working directory to this directory and
198 to this directory. This is done after opening listeners but before
199 reading any configuration file or initializing any backend. When
200 used as a security mechanism, it should be used in conjunction with
208 will run slapd with the specified user name or id, and that user's
209 supplementary group access list as set with initgroups(3). The group ID
210 is also changed to this user's gid, unless the -g option is used to
211 override. Note when used with
213 slapd will use the user database in the change root environment.
215 Note that on some systems, running as a non-privileged user will prevent
216 passwd back-ends from accessing the encrypted passwords. Note also that
217 any shell back-ends will run as the specified non-privileged user.
221 will run with the specified group name or id. Note when used with
223 slapd will use the group database in the change root environment.
226 This option provides a cookie for the syncrepl replication consumer.
227 The cookie is a comma separated list of name=value pairs.
228 Currently supported syncrepl cookie fields are
233 identifies a replication thread within the consumer server
234 and is used to find the syncrepl specification in
236 having the matching replication identifier in its definition. The
238 must be provided in order for any other specified values to be used.
240 is the commit sequence number received by a previous synchronization
241 and represents the state of the consumer replica content which the
242 syncrepl engine will synchronize to the current provider content.
244 .BI \-o " option[=value]"
245 This option provides a generic means to specify options without the need to reserve
246 a separate letter for them.
248 It supports the following options:
251 slp={\fBon\fP|\fBoff\fP|\fIslp\-attrs\fP}
252 When SLP support is compiled into slapd, disable it (
254 ), enable it by registering at SLP DAs without specific SLP attributes (
256 ), or with specific SLP attributes
258 that must be an SLP attribute list definition according to the SLP standard.
260 For example, "-o slp=(tree=production),(server-type=OpenLDAP),(server-version=2.3.20)"
261 registers at SLP DAs with the three SLP attributes tree, server-type and server-version
262 that have the values given above.
263 This allows to specifically query the SLP DAs for LDAP servers holding the
265 tree in case multiple trees are availabe.
270 and have it fork and detach from the terminal and start serving
271 the LDAP databases defined in the default config file, just type:
281 with an alternate configuration file, and turn
282 on voluminous debugging which will be printed on standard error, type:
286 LIBEXECDIR/slapd -f /var/tmp/slapd.conf -d 255
290 To test whether the configuration file is correct or not, type:
301 .BR slapd.access (5),
312 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
314 See http://www.openldap.org/its/
projects / openldap / blob