1SLAPD(8C) SLAPD(8C)
2
6 slapd - Stand-alone LDAP Daemon
7
9 slapd [-4|-6] [-T {acl|a[dd]|auth|c[at]|
10 d[n]|i[ndex]|p[asswd]|s[chema]|t[est]}] [-d debug-level] [-f slapd-con‐
11 fig-file] [-F slapd-config-directory] [-h URLs] [-n service-name]
12 [-s syslog-level] [-l syslog-local-user] [-o option[=value]] [-r direc‐
13 tory] [-u user] [-g group] [-c cookie]
14
16 Slapd is the stand-alone LDAP daemon. It listens for LDAP connections
17 on any number of ports (default 389), responding to the LDAP operations
18 it receives over these connections. slapd is typically invoked at boot
19 time, usually out of /etc/rc.local. Upon startup, slapd normally forks
20 and disassociates itself from the invoking tty. If configured in the
21 config file (or config directory), the slapd process will print its
22 process ID (see getpid(2)) to a .pid file, as well as the command line
23 options during invocation to an .args file (see slapd.conf(5)). If the
24 -d flag is given, even with a zero argument, slapd will not fork and
25 disassociate from the invoking tty.
26 See the "OpenLDAP Administrator's Guide" for more details on slapd.
28
30 -4 Listen on IPv4 addresses only.
31 -6 Listen on IPv6 addresses only.
33 -T tool
35 Run in Tool mode. The tool argument selects whether to run as
36 slapadd, slapcat, slapdn, slapindex, slappasswd, slapschema, or
37 slaptest (slapacl and slapauth need the entire acl and auth
38 option value to be spelled out, as a is reserved to slapadd).
39 This option should be the first option specified when it is
40 used; any remaining options will be interpreted by the corre‐
41 sponding slap tool program, according to the respective man
42 pages. Note that these tool programs will usually be symbolic
43 links to slapd. This option is provided for situations where
44 symbolic links are not provided or not usable.
45 -d debug-level
47 Turn on debugging as defined by debug-level. If this option is
48 specified, even with a zero argument, slapd will not fork or
49 disassociate from the invoking terminal. Some general operation
50 and status messages are printed for any value of debug-level.
51 debug-level is taken as a bit string, with each bit correspond‐
52 ing to a different kind of debugging information. See
53 <ldap_log.h> for details. Comma-separated arrays of friendly
54 names can be specified to select debugging output of the corre‐
55 sponding debugging information. All the names recognized by the
56 loglevel directive described in slapd.conf(5) are supported. If
57 debug-level is ?, a list of installed debug-levels is printed,
58 and slapd exits.
59 Remember that if you turn on packet logging, packets containing
61 bind passwords will be output, so if you redirect the log to a
62 logfile, that file should be read-protected.
63 -s syslog-level
65 This option tells slapd at what debug-level debugging statements
66 should be logged to the syslog(8) facility. The value syslog-
67 level can be set to any value or combination allowed by the -d
68 switch. Slapd logs all messages selected by syslog-level at the
69 syslog(3) severity debug-level DEBUG, on the unit specified with
70 -l.
71 -n service-name
73 Specifies the service name for logging and other purposes.
74 Defaults to basename of argv[0], i.e.: "slapd".
75 -l syslog-local-user
77 Selects the local user of the syslog(8) facility. Value can be
78 LOCAL0, through LOCAL7, as well as USER and DAEMON. The default
79 is LOCAL4. However, this option is only permitted on systems
80 that support local users with the syslog(8) facility. Logging
81 to syslog(8) occurs at the "DEBUG" severity debug-level.
82 -f slapd-config-file
84 Specifies the slapd configuration file. The default is
85 /etc/openldap/slapd.conf.
86 -F slapd-config-directory
88 Specifies the slapd configuration directory. The default is
89 /etc/openldap/slapd.d. If both -f and -F are specified, the
90 config file will be read and converted to config directory for‐
91 mat and written to the specified directory. If neither option
92 is specified, slapd will attempt to read the default config
93 directory before trying to use the default config file. If a
94 valid config directory exists then the default config file is
95 ignored. All of the slap tools that use the config options
96 observe this same behavior.
97 -h URLlist
99 slapd will by default serve ldap:/// (LDAP over TCP on all
100 interfaces on default LDAP port). That is, it will bind using
101 INADDR_ANY and port 389. The -h option may be used to specify
102 LDAP (and other scheme) URLs to serve. For example, if slapd is
103 given -h "ldap://127.0.0.1:9009/ ldaps:/// ldapi:///", it will
104 listen on 127.0.0.1:9009 for LDAP, 0.0.0.0:636 for LDAP over
105 TLS, and LDAP over IPC (Unix domain sockets). Host 0.0.0.0 rep‐
106 resents INADDR_ANY (any interface). A space separated list of
107 URLs is expected. The URLs should be of the LDAP, LDAPS, or
108 LDAPI schemes, and generally without a DN or other optional
109 parameters (excepting as discussed below). Support for the lat‐
110 ter two schemes depends on selected configuration options.
111 Hosts may be specified by name or IPv4 and IPv6 address formats.
112 Ports, if specified, must be numeric. The default ldap:// port
113 is 389 and the default ldaps:// port is 636.
114 For LDAP over IPC, name is the name of the socket, and no port
116 is required, nor allowed; note that directory separators must be
117 URL-encoded, like any other characters that are special to URLs;
118 so the socket
119 /usr/local/var/ldapi
121 must be specified as
123 ldapi://%2Fusr%2Flocal%2Fvar%2Fldapi
125 The default location for the IPC socket is /var/run/ldapi
127 The listener permissions are indicated by "x-mod=-rwxrwxrwx",
129 "x-mod=0777" or "x-mod=777", where any of the "rwx" can be "-"
130 to suppress the related permission, while any of the "7" can be
131 any legal octal digit, according to chmod(1). The listeners can
132 take advantage of the "x-mod" extension to apply rough limita‐
133 tions to operations, e.g. allow read operations ("r", which
134 applies to search and compare), write operations ("w", which
135 applies to add, delete, modify and modrdn), and execute opera‐
136 tions ("x", which means bind is required). "User" permissions
137 apply to authenticated users, while "other" apply to anonymous
138 users; "group" permissions are ignored. For example,
139 "ldap:///????x-mod=-rw-------" means that read and write is only
140 allowed for authenticated connections, and bind is required for
141 all operations. This feature is experimental, and requires to
142 be manually enabled at configure time.
143 -r directory
145 Specifies a directory to become the root directory. slapd will
146 change the current working directory to this directory and then
147 chroot(2) to this directory. This is done after opening listen‐
148 ers but before reading any configuration file or initializing
149 any backend. When used as a security mechanism, it should be
150 used in conjunction with -u and -g options.
151 -u user
153 slapd will run slapd with the specified user name or id, and
154 that user's supplementary group access list as set with init‐
155 groups(3). The group ID is also changed to this user's gid,
156 unless the -g option is used to override. Note when used with
157 -r, slapd will use the user database in the change root environ‐
158 ment.
159 Note that on some systems, running as a non-privileged user will
161 prevent passwd back-ends from accessing the encrypted passwords.
162 Note also that any shell back-ends will run as the specified
163 non-privileged user.
164 -g group
166 slapd will run with the specified group name or id. Note when
167 used with -r, slapd will use the group database in the change
168 root environment.
169 -c cookie
171 This option provides a cookie for the syncrepl replication con‐
172 sumer. The cookie is a comma separated list of name=value
173 pairs. Currently supported syncrepl cookie fields are rid, sid,
174 and csn. rid identifies a replication thread within the con‐
175 sumer server and is used to find the syncrepl specification in
176 slapd.conf(5) or slapd-config(5) having the matching replication
177 identifier in its definition. The rid must be provided in order
178 for any other specified values to be used. sid is the server id
179 in a multi-master/mirror-mode configuration. csn is the commit
180 sequence number received by a previous synchronization and rep‐
181 resents the state of the consumer replica content which the syn‐
182 crepl engine will synchronize to the current provider content.
183 In case of mirror-mode or multi-master replication agreement,
184 multiple csn values, semicolon separated, can appear. Use only
185 the rid part to force a full reload.
186 -o option[=value]
188 This option provides a generic means to specify options without
189 the need to reserve a separate letter for them.
190 It supports the following options:
192 slp={on|off|slp-attrs}
194 When SLP support is compiled into slapd, disable it
195 (off),
196 enable it by registering at SLP DAs without specific SLP
197 attributes (on), or with specific SLP attributes slp-
198 attrs that must be an SLP attribute list definition
199 according to the SLP standard.
200 For example, "slp=(tree=production),(server-type=OpenL‐
202 DAP),(server-version=2.4.15)" registers at SLP DAs with
203 the three SLP attributes tree, server-type and server-
204 version that have the values given above. This allows
205 one to specifically query the SLP DAs for LDAP servers
206 holding the production tree in case multiple trees are
207 available.
208
210 To start slapd and have it fork and detach from the terminal and start
211 serving the LDAP databases defined in the default config file, just
212 type:
213 slapd
215 To start slapd with an alternate configuration file, and turn on volu‐
217 minous debugging which will be printed on standard error, type:
218 slapd -f /var/tmp/slapd.conf -d 255
220 To test whether the configuration file is correct or not, type:
222 slapd -Tt
224
226 ldap(3), slapd.conf(5), slapd-config(5), slapd.access(5), slapacl(8),
227 slapadd(8), slapauth(8), slapcat(8), slapdn(8), slapindex(8), slap‐
228 passwd(8), slapschema(8), slaptest(8).
229 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
231
233 See http://www.openldap.org/its/
234
236 OpenLDAP Software is developed and maintained by The OpenLDAP Project
237 <http://www.openldap.org/>. OpenLDAP Software is derived from the Uni‐
238 versity of Michigan LDAP 3.3 Release.
239OpenLDAP 2.4.47 2018/12/19 SLAPD(8C)