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

   1 .\" $OpenLDAP$
   2 .\" Copyright 1998-2005 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 [\-r directory]
  17 .B [\-u user] [\-g group]
  18 .B [\-c cookie]
  19 .SH DESCRIPTION
  20 .LP
  21 .B Slapd
  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.
  25 .B slapd
  26 is typically invoked at boot time, usually out of
  27 .BR  /etc/rc.local .
  28 Upon startup,
  29 .B slapd
  30 normally forks and disassociates itself from the invoking tty.
  31 If configured in the config file (or config directory),
  32 the
  33 .B slapd
  34 process will print its process ID (see
  35 .BR getpid (2))
  36 to a
  37 .B .pid
  38 file, as well as the command line options during invocation to an
  39 .B .args
  40 file (see
  41 .BR slapd.conf (5)).
  42 If the
  43 .B \-d
  44 flag is given, even with a zero argument,
  45 .B slapd
  46 will not fork and disassociate from the invoking tty.
  47 .LP
  48 .B Slapd
  49 can be configured to provide replicated service for a database with
  50 the help of
  51 .BR slurpd ,
  52 the standalone LDAP update replication daemon.
  53 See
  54 .BR slurpd (8)
  55 for details.
  56 .LP
  57 See the "OpenLDAP Administrator's Guide" for more details on
  58 .BR slapd .
  59 .SH OPTIONS
  60 .TP
  61 .B \-4
  62 Listen on IPv4 addresses only.
  63 .TP
  64 .B \-6
  65 Listen on IPv6 addresses only.
  66 .TP
  67 .B \-T {a|c|d|i|p|t}
  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
  72 .BR slapadd ).
  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.
  79 .TP
  80 .BI \-d " debug\-level"
  81 Turn on debugging as defined by
  82 .I debug\-level.
  83 If this option is specified, even with a zero argument,
  84 .B slapd
  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
  91 be read-protected.
  92 .TP
  93 .BI \-s " syslog\-level"
  94 This option tells
  95 .B slapd
  96 at what level debugging statements should be logged to the
  97 .BR syslog (8)
  98 facility.
  99 .TP
 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".
 103 .TP
 104 .BI \-l " syslog\-local\-user"
 105 Selects the local user of the
 106 .BR syslog (8)
 107 facility. Value can be
 108 .BR LOCAL0 ,
 109 through
 110 .BR LOCAL7 ,
 111 as well as
 112 .B USER
 113 and
 114 .BR DAEMON .
 115 The default is
 116 .BR LOCAL4 .
 117 However, this option is only permitted on systems that support
 118 local users with the
 119 .BR syslog (8)
 120 facility.
 121 .TP
 122 .BI \-f " slapd\-config\-file"
 123 Specifies the slapd configuration file. The default is
 124 .BR ETCDIR/slapd.conf .
 125 .TP
 126 .BI \-F " slapd\-config\-directory"
 127 Specifies the slapd configuration file. The default is
 128 .BR ETCDIR/slapd.d .
 129 If both
 130 .B -f
 131 and
 132 .B -F
 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.
 139 .TP
 140 .BI \-h " URLlist"
 141 .B slapd
 142 will by default serve
 143 .B ldap:///
 144 (LDAP over TCP on all interfaces on default LDAP port).  That is,
 145 it will bind using INADDR_ANY and port 389.
 146 The
 147 .B \-h
 148 option may be used to specify LDAP (and other scheme) URLs to serve.
 149 For example, if slapd is given
 150 .BR "\-h \(dqldap://127.0.0.1:9009/ ldaps:/// ldapi:///\(dq" ,
 151 it will listen on 127.0.0.1:9009 for LDAP, 0.0.0.0:636 for LDAP over TLS,
 152 and LDAP over IPC (Unix domain sockets).  Host 0.0.0.0 represents
 153 INADDR_ANY (any interface).
 154 A space separated list of URLs is expected.  The URLs should be of
 155 the LDAP, LDAPS, or LDAPI schemes, and generally
 156 without a DN or other optional parameters (excepting as discussed below).
 157 Support for the latter two schemes depends on selected configuration
 158 options.  Hosts may be specified by name or IPv4 and IPv6 address formats.
 159 Ports, if specified, must be numeric.  The default ldap:// port is 389
 160 and the default ldaps:// port is 636.
 161 The socket permissions for LDAP over IPC are indicated by
 162 "x-mod=-rwxrwxrwx", "x-mod=0777" or "x-mod=777", where any
 163 of the "rwx" can be "-" to suppress the related permission (note,
 164 however, that sockets only honor the "w" permission), while any
 165 of the "7" can be any legal octal digit, according to chmod(1).
 166 While LDAP over IPC requires write permissions on the socket to allow
 167 any operation, the other listeners can take advantage of the "x-mod"
 168 extension to apply rough limitations to users, 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 bound users, while "other" apply
 173 to anonymous users.
 174 .TP
 175 .BI \-r " directory"
 176 Specifies a directory to become the root directory.  slapd will
 177 change the current working directory to this directory and
 178 then
 179 .BR chroot (2)
 180 to this directory.  This is done after opening listeners but before
 181 reading any configuration file or initializing any backend.  When
 182 used as a security mechanism, it should be used in conjunction with
 183 .B -u
 184 and
 185 .B -g
 186 options.
 187 .TP
 188 .BI \-u " user"
 189 .B slapd
 190 will run slapd with the specified user name or id, and that user's
 191 supplementary group access list as set with initgroups(3).  The group ID
 192 is also changed to this user's gid, unless the -g option is used to
 193 override.  Note when used with
 194 .BR -r ,
 195 slapd will use the user database in the change root environment.
 196
 197 Note that on some systems, running as a non-privileged user will prevent
 198 passwd back-ends from accessing the encrypted passwords.  Note also that
 199 any shell back-ends will run as the specified non-privileged user.
 200 .TP
 201 .BI \-g " group"
 202 .B slapd
 203 will run with the specified group name or id.  Note when used with
 204 .BR -r ,
 205 slapd will use the group database in the change root environment.
 206 .TP
 207 .BI \-c " cookie"
 208 This option provides a cookie for the syncrepl replication consumer.
 209 The cookie is a comma separated list of name=value pairs.
 210 Currently supported syncrepl cookie fields are
 211 .B rid
 212 and
 213 .B csn.
 214 .B rid
 215 identifies a replication thread within the consumer server
 216 and is used to find the syncrepl specification in
 217 .BR slapd.conf (5)
 218 having the matching replication identifier in its definition. The
 219 .B rid
 220 must be provided in order for any other specified values to be used.
 221 .B csn
 222 is the commit sequence number received by a previous synchronization
 223 and represents the state of the consumer replica content which the
 224 syncrepl engine will synchronize to the current provider content.
 225 .SH EXAMPLES
 226 To start
 227 .I slapd
 228 and have it fork and detach from the terminal and start serving
 229 the LDAP databases defined in the default config file, just type:
 230 .LP
 231 .nf
 232 .ft tt
 233         LIBEXECDIR/slapd
 234 .ft
 235 .fi
 236 .LP
 237 To start
 238 .B slapd
 239 with an alternate configuration file, and turn
 240 on voluminous debugging which will be printed on standard error, type:
 241 .LP
 242 .nf
 243 .ft tt
 244         LIBEXECDIR/slapd -f /var/tmp/slapd.conf -d 255
 245 .ft
 246 .fi
 247 .LP
 248 To test whether the configuration file is correct or not, type:
 249 .LP
 250 .nf
 251 .ft tt
 252         LIBEXECDIR/slapd -Tt
 253 .ft
 254 .fi
 255 .LP
 256 .SH "SEE ALSO"
 257 .BR ldap (3),
 258 .BR slapd.conf (5),
 259 .BR slapd.access (5),
 260 .BR slapacl (8),
 261 .BR slapadd (8),
 262 .BR slapauth (8),
 263 .BR slapcat (8),
 264 .BR slapdn (8),
 265 .BR slapindex (8),
 266 .BR slappasswd (8),
 267 .BR slaptest (8),
 268 .BR slurpd (8)
 269 .LP
 270 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
 271 .SH BUGS
 272 See http://www.openldap.org/its/
 273 .SH ACKNOWLEDGEMENTS
 274 .B OpenLDAP
 275 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
 276 .B OpenLDAP
 277 is derived from University of Michigan LDAP 3.3 Release.