git.sur5r.net Git - openldap/blob - doc/man/man8/slapd.8

   1 .\" $OpenLDAP$
   2 .\" Copyright 1998-2007 The OpenLDAP Foundation All Rights Reserved.
   3 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
   4 .TH SLAPD 8C "RELEASEDATE" "OpenLDAP LDVERSION"
   5 .SH NAME
   6 slapd \- Stand-alone LDAP Daemon
   7 .SH SYNOPSIS
   8 .B LIBEXECDIR/slapd
   9 .B [\-[4|6]]
  10 .B [\-T {acl|add|auth|cat|dn|index|passwd|test}]
  11 .B [\-d debug\-level]
  12 .B [\-f slapd\-config\-file]
  13 .B [\-F slapd\-config\-directory]
  14 .B [\-h URLs]
  15 .B [\-n service\-name] [\-s syslog\-level] [\-l syslog\-local\-user]
  16 .B [\-o option[=value]]
  17 .B [\-r directory]
  18 .B [\-u user] [\-g group]
  19 .B [\-c cookie]
  20 .SH DESCRIPTION
  21 .LP
  22 .B Slapd
  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.
  26 .B slapd
  27 is typically invoked at boot time, usually out of
  28 .BR  /etc/rc.local .
  29 Upon startup,
  30 .B slapd
  31 normally forks and disassociates itself from the invoking tty.
  32 If configured in the config file (or config directory),
  33 the
  34 .B slapd
  35 process will print its process ID (see
  36 .BR getpid (2))
  37 to a
  38 .B .pid
  39 file, as well as the command line options during invocation to an
  40 .B .args
  41 file (see
  42 .BR slapd.conf (5)).
  43 If the
  44 .B \-d
  45 flag is given, even with a zero argument,
  46 .B slapd
  47 will not fork and disassociate from the invoking tty.
  48 .LP
  49 See the "OpenLDAP Administrator's Guide" for more details on
  50 .BR slapd .
  51 .SH OPTIONS
  52 .TP
  53 .B \-4
  54 Listen on IPv4 addresses only.
  55 .TP
  56 .B \-6
  57 Listen on IPv6 addresses only.
  58 .TP
  59 .B \-T {a|c|d|i|p|t|acl|auth}
  60 Run in Tool mode. The additional argument selects whether to run as
  61 slapadd, slapcat, slapdn, slapindex, slappasswd, or slaptest
  62 (slapacl and slapauth need the entire "\fIacl\fP" and "\fIauth\fP"
  63 option value to be spelled out, as "\fIa\fP" is reserved to
  64 .BR slapadd ).
  65 This option should be the first option specified when it is used;
  66 any remaining options will be interpreted by the corresponding
  67 slap tool program, according to the respective man pages.
  68 Note that these tool programs will usually be symbolic links to slapd.
  69 This option is provided for situations where symbolic links
  70 are not provided or not usable.
  71 .TP
  72 .BI \-d " debug\-level"
  73 Turn on debugging as defined by
  74 .IR debug\-level .
  75 If this option is specified, even with a zero argument,
  76 .B slapd
  77 will not fork or disassociate from the invoking terminal.  Some general
  78 operation and status messages are printed for any value of \fIdebug\-level\fP.
  79 \fIdebug\-level\fP is taken as a bit string, with each bit corresponding to a
  80 different kind of debugging information.  See <ldap_log.h> for details.
  81 Comma-separated arrays of friendly names can be specified to select
  82 debugging output of the corresponding debugging information.
  83 All the names recognized by the \fIloglevel\fP directive
  84 described in \fBslapd.conf\fP(5) are supported.
  85 If \fIdebug\-level\fP is \fB?\fP, a list of installed levels is printed,
  86 and slapd exits.
  87
  88 Remember that if you turn on packet logging, packets containing bind passwords
  89 will be output, so if you redirect the log to a logfile, that file should
  90 be read-protected.
  91 .TP
  92 .BI \-s " syslog\-level"
  93 This option tells
  94 .B slapd
  95 at what level debugging statements should be logged to the
  96 .BR syslog (8)
  97 facility.
  98 The value "syslog\-level" can be set to any value or combination
  99 allowed by the "-d" switch.
 100 Slapd logs all messages selected by "syslog\-level"
 101 at the syslog(3) severity level "DEBUG",
 102 on the unit specified with "-l".
 103 .TP
 104 .BI \-n " service\-name"
 105 Specifies the service name for logging and other purposes.  Defaults
 106 to basename of argv[0], i.e.: "slapd".
 107 .TP
 108 .BI \-l " syslog\-local\-user"
 109 Selects the local user of the
 110 .BR syslog (8)
 111 facility. Value can be
 112 .BR LOCAL0 ,
 113 through
 114 .BR LOCAL7 ,
 115 as well as
 116 .B USER
 117 and
 118 .BR DAEMON .
 119 The default is
 120 .BR LOCAL4 .
 121 However, this option is only permitted on systems that support
 122 local users with the
 123 .BR syslog (8)
 124 facility.
 125 Logging to syslog(8) occurs at the "DEBUG" severity level.
 126 .TP
 127 .BI \-f " slapd\-config\-file"
 128 Specifies the slapd configuration file. The default is
 129 .BR ETCDIR/slapd.conf .
 130 .TP
 131 .BI \-F " slapd\-config\-directory"
 132 Specifies the slapd configuration directory. The default is
 133 .BR ETCDIR/slapd.d .
 134 If both
 135 .B -f
 136 and
 137 .B -F
 138 are specified, the config file will be read and converted to
 139 config directory format and written to the specified directory.
 140 If neither option is specified, slapd will attempt to read the
 141 default config directory before trying to use the default
 142 config file. If a valid config directory exists then the
 143 default config file is ignored. All of the slap tools that
 144 use the config options observe this same behavior.
 145 .TP
 146 .BI \-h " URLlist"
 147 .B slapd
 148 will by default serve
 149 .B ldap:///
 150 (LDAP over TCP on all interfaces on default LDAP port).  That is,
 151 it will bind using INADDR_ANY and port 389.
 152 The
 153 .B \-h
 154 option may be used to specify LDAP (and other scheme) URLs to serve.
 155 For example, if slapd is given
 156 .BR "\-h \(dqldap://127.0.0.1:9009/ ldaps:/// ldapi:///\(dq" ,
 157 it will listen on 127.0.0.1:9009 for LDAP, 0.0.0.0:636 for LDAP over TLS,
 158 and LDAP over IPC (Unix domain sockets).  Host 0.0.0.0 represents
 159 INADDR_ANY (any interface).
 160 A space separated list of URLs is expected.  The URLs should be of
 161 the LDAP, LDAPS, or LDAPI schemes, and generally
 162 without a DN or other optional parameters (excepting as discussed below).
 163 Support for the latter two schemes depends on selected configuration
 164 options.  Hosts may be specified by name or IPv4 and IPv6 address formats.
 165 Ports, if specified, must be numeric.  The default ldap:// port is 389
 166 and the default ldaps:// port is 636.
 167
 168 The listener permissions are indicated by
 169 "x-mod=-rwxrwxrwx", "x-mod=0777" or "x-mod=777", where any
 170 of the "rwx" can be "-" to suppress the related permission, while any
 171 of the "7" can be any legal octal digit, according to chmod(1).
 172 The listeners can take advantage of the "x-mod"
 173 extension to apply rough limitations to operations, e.g. allow read operations
 174 ("r", which applies to search and compare), write operations ("w",
 175 which applies to add, delete, modify and modrdn), and execute operations
 176 ("x", which means bind is required).
 177 "User" permissions apply to authenticated users, while "other" apply
 178 to anonymous users; "group" permissions are ignored.
 179 For example, "ldap:///????x-mod=-rw-------" means that read and write is only allowed
 180 for authenticated connections, and bind is required for all operations.
 181 This feature is experimental, and requires to be manually enabled
 182 at configure time.
 183 .TP
 184 .BI \-r " directory"
 185 Specifies a directory to become the root directory.  slapd will
 186 change the current working directory to this directory and
 187 then
 188 .BR chroot (2)
 189 to this directory.  This is done after opening listeners but before
 190 reading any configuration file or initializing any backend.  When
 191 used as a security mechanism, it should be used in conjunction with
 192 .B -u
 193 and
 194 .B -g
 195 options.
 196 .TP
 197 .BI \-u " user"
 198 .B slapd
 199 will run slapd with the specified user name or id, and that user's
 200 supplementary group access list as set with initgroups(3).  The group ID
 201 is also changed to this user's gid, unless the -g option is used to
 202 override.  Note when used with
 203 .BR -r ,
 204 slapd will use the user database in the change root environment.
 205
 206 Note that on some systems, running as a non-privileged user will prevent
 207 passwd back-ends from accessing the encrypted passwords.  Note also that
 208 any shell back-ends will run as the specified non-privileged user.
 209 .TP
 210 .BI \-g " group"
 211 .B slapd
 212 will run with the specified group name or id.  Note when used with
 213 .BR -r ,
 214 slapd will use the group database in the change root environment.
 215 .TP
 216 .BI \-c " cookie"
 217 This option provides a cookie for the syncrepl replication consumer.
 218 The cookie is a comma separated list of name=value pairs.
 219 Currently supported syncrepl cookie fields are
 220 .B rid
 221 and
 222 .B csn.
 223 .B rid
 224 identifies a replication thread within the consumer server
 225 and is used to find the syncrepl specification in
 226 .BR slapd.conf (5)
 227 having the matching replication identifier in its definition. The
 228 .B rid
 229 must be provided in order for any other specified values to be used.
 230 .B csn
 231 is the commit sequence number received by a previous synchronization
 232 and represents the state of the consumer replica content which the
 233 syncrepl engine will synchronize to the current provider content.
 234 .TP
 235 .BI \-o " option[=value]"
 236 This option provides a generic means to specify options without the need to reserve
 237 a separate letter for them.
 238
 239 It supports the following options:
 240 .RS
 241 .TP
 242 slp={\fBon\fP|\fBoff\fP|\fIslp\-attrs\fP}
 243 When SLP support is compiled into slapd, disable it (
 244 .B off
 245 ), enable it by registering at SLP DAs without specific SLP attributes (
 246 .B on
 247 ), or with specific SLP attributes
 248 .I slp\-attrs
 249 that must be an SLP attribute list definition according to the SLP standard.
 250
 251 For example, "-o slp=(tree=production),(server-type=OpenLDAP),(server-version=2.3.20)"
 252 registers at SLP DAs with the three SLP attributes tree, server-type and server-version
 253 that have the values given above.
 254 This allows to specifically query the SLP DAs for LDAP servers holding the
 255 .I production
 256 tree in case multiple trees are available.
 257 .RE
 258 .SH EXAMPLES
 259 To start
 260 .I slapd
 261 and have it fork and detach from the terminal and start serving
 262 the LDAP databases defined in the default config file, just type:
 263 .LP
 264 .nf
 265 .ft tt
 266         LIBEXECDIR/slapd
 267 .ft
 268 .fi
 269 .LP
 270 To start
 271 .B slapd
 272 with an alternate configuration file, and turn
 273 on voluminous debugging which will be printed on standard error, type:
 274 .LP
 275 .nf
 276 .ft tt
 277         LIBEXECDIR/slapd -f /var/tmp/slapd.conf -d 255
 278 .ft
 279 .fi
 280 .LP
 281 To test whether the configuration file is correct or not, type:
 282 .LP
 283 .nf
 284 .ft tt
 285         LIBEXECDIR/slapd -Tt
 286 .ft
 287 .fi
 288 .LP
 289 .SH "SEE ALSO"
 290 .BR ldap (3),
 291 .BR slapd.conf (5),
 292 .BR slapd.access (5),
 293 .BR slapacl (8),
 294 .BR slapadd (8),
 295 .BR slapauth (8),
 296 .BR slapcat (8),
 297 .BR slapdn (8),
 298 .BR slapindex (8),
 299 .BR slappasswd (8),
 300 .BR slaptest (8).
 301 .LP
 302 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
 303 .SH BUGS
 304 See http://www.openldap.org/its/
 305 .SH ACKNOWLEDGEMENTS
 306 .so ../Project