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

   1 .\" $OpenLDAP$
   2 .\" Copyright 1998-2006 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|acl|auth}
  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 Comma-separated arrays of friendly names can be specified to select
  90 debugging output of the corresponding debugging information.
  91 All the names recognized by the \fIloglevel\fP directive
  92 described in \fBslapd.conf\fP(5) are supported.
  93 Remember that if you turn on packet logging, packets containing bind passwords
  94 will be output, so if you redirect the log to a logfile, that file should
  95 be read-protected.
  96 .TP
  97 .BI \-s " syslog\-level"
  98 This option tells
  99 .B slapd
 100 at what level debugging statements should be logged to the
 101 .BR syslog (8)
 102 facility.
 103 The value "syslog\-level" can be set to any value or combination
 104 allowed by the "-d" switch.
 105 Slapd logs all messages selected by "syslog\-level"
 106 at the syslog(3) severity level "DEBUG",
 107 on the unit specified with "-l".
 108 .TP
 109 .BI \-n " service\-name"
 110 Specifies the service name for logging and other purposes.  Defaults
 111 to basename of argv[0], i.e.: "slapd".
 112 .TP
 113 .BI \-l " syslog\-local\-user"
 114 Selects the local user of the
 115 .BR syslog (8)
 116 facility. Value can be
 117 .BR LOCAL0 ,
 118 through
 119 .BR LOCAL7 ,
 120 as well as
 121 .B USER
 122 and
 123 .BR DAEMON .
 124 The default is
 125 .BR LOCAL4 .
 126 However, this option is only permitted on systems that support
 127 local users with the
 128 .BR syslog (8)
 129 facility.
 130 Logging to syslog(8) occurs at the "DEBUG" severity level.
 131 .TP
 132 .BI \-f " slapd\-config\-file"
 133 Specifies the slapd configuration file. The default is
 134 .BR ETCDIR/slapd.conf .
 135 .TP
 136 .BI \-F " slapd\-config\-directory"
 137 Specifies the slapd configuration directory. The default is
 138 .BR ETCDIR/slapd.d .
 139 If both
 140 .B -f
 141 and
 142 .B -F
 143 are specified, the config file will be read and converted to
 144 config directory format and written to the specified directory.
 145 If neither option is specified, slapd will attempt to read the
 146 default config directory before trying to use the default
 147 config file. If a valid config directory exists then the
 148 default config file is ignored. All of the slap tools that
 149 use the config options observe this same behavior.
 150 .TP
 151 .BI \-h " URLlist"
 152 .B slapd
 153 will by default serve
 154 .B ldap:///
 155 (LDAP over TCP on all interfaces on default LDAP port).  That is,
 156 it will bind using INADDR_ANY and port 389.
 157 The
 158 .B \-h
 159 option may be used to specify LDAP (and other scheme) URLs to serve.
 160 For example, if slapd is given
 161 .BR "\-h \(dqldap://127.0.0.1:9009/ ldaps:/// ldapi:///\(dq" ,
 162 it will listen on 127.0.0.1:9009 for LDAP, 0.0.0.0:636 for LDAP over TLS,
 163 and LDAP over IPC (Unix domain sockets).  Host 0.0.0.0 represents
 164 INADDR_ANY (any interface).
 165 A space separated list of URLs is expected.  The URLs should be of
 166 the LDAP, LDAPS, or LDAPI schemes, and generally
 167 without a DN or other optional parameters (excepting as discussed below).
 168 Support for the latter two schemes depends on selected configuration
 169 options.  Hosts may be specified by name or IPv4 and IPv6 address formats.
 170 Ports, if specified, must be numeric.  The default ldap:// port is 389
 171 and the default ldaps:// port is 636.
 172
 173 The listener permissions are indicated by
 174 "x-mod=-rwxrwxrwx", "x-mod=0777" or "x-mod=777", where any
 175 of the "rwx" can be "-" to suppress the related permission, while any
 176 of the "7" can be any legal octal digit, according to chmod(1).
 177 The listeners can take advantage of the "x-mod"
 178 extension to apply rough limitations to operations, e.g. allow read operations
 179 ("r", which applies to search and compare), write operations ("w",
 180 which applies to add, delete, modify and modrdn), and execute operations
 181 ("x", which means bind is required).
 182 "User" permissions apply to authenticated users, while "other" apply
 183 to anonymous users; "group" permissions are ignored.
 184 For example, "ldap:///????x-mod=-rw-------" means that read and write is only allowed
 185 for authenticated connections, and bind is required for all operations.
 186 This feature is experimental, and requires to be manually enabled
 187 at configure time.
 188 .TP
 189 .BI \-r " directory"
 190 Specifies a directory to become the root directory.  slapd will
 191 change the current working directory to this directory and
 192 then
 193 .BR chroot (2)
 194 to this directory.  This is done after opening listeners but before
 195 reading any configuration file or initializing any backend.  When
 196 used as a security mechanism, it should be used in conjunction with
 197 .B -u
 198 and
 199 .B -g
 200 options.
 201 .TP
 202 .BI \-u " user"
 203 .B slapd
 204 will run slapd with the specified user name or id, and that user's
 205 supplementary group access list as set with initgroups(3).  The group ID
 206 is also changed to this user's gid, unless the -g option is used to
 207 override.  Note when used with
 208 .BR -r ,
 209 slapd will use the user database in the change root environment.
 210
 211 Note that on some systems, running as a non-privileged user will prevent
 212 passwd back-ends from accessing the encrypted passwords.  Note also that
 213 any shell back-ends will run as the specified non-privileged user.
 214 .TP
 215 .BI \-g " group"
 216 .B slapd
 217 will run with the specified group name or id.  Note when used with
 218 .BR -r ,
 219 slapd will use the group database in the change root environment.
 220 .TP
 221 .BI \-c " cookie"
 222 This option provides a cookie for the syncrepl replication consumer.
 223 The cookie is a comma separated list of name=value pairs.
 224 Currently supported syncrepl cookie fields are
 225 .B rid
 226 and
 227 .B csn.
 228 .B rid
 229 identifies a replication thread within the consumer server
 230 and is used to find the syncrepl specification in
 231 .BR slapd.conf (5)
 232 having the matching replication identifier in its definition. The
 233 .B rid
 234 must be provided in order for any other specified values to be used.
 235 .B csn
 236 is the commit sequence number received by a previous synchronization
 237 and represents the state of the consumer replica content which the
 238 syncrepl engine will synchronize to the current provider content.
 239 .SH EXAMPLES
 240 To start
 241 .I slapd
 242 and have it fork and detach from the terminal and start serving
 243 the LDAP databases defined in the default config file, just type:
 244 .LP
 245 .nf
 246 .ft tt
 247         LIBEXECDIR/slapd
 248 .ft
 249 .fi
 250 .LP
 251 To start
 252 .B slapd
 253 with an alternate configuration file, and turn
 254 on voluminous debugging which will be printed on standard error, type:
 255 .LP
 256 .nf
 257 .ft tt
 258         LIBEXECDIR/slapd -f /var/tmp/slapd.conf -d 255
 259 .ft
 260 .fi
 261 .LP
 262 To test whether the configuration file is correct or not, type:
 263 .LP
 264 .nf
 265 .ft tt
 266         LIBEXECDIR/slapd -Tt
 267 .ft
 268 .fi
 269 .LP
 270 .SH "SEE ALSO"
 271 .BR ldap (3),
 272 .BR slapd.conf (5),
 273 .BR slapd.access (5),
 274 .BR slapacl (8),
 275 .BR slapadd (8),
 276 .BR slapauth (8),
 277 .BR slapcat (8),
 278 .BR slapdn (8),
 279 .BR slapindex (8),
 280 .BR slappasswd (8),
 281 .BR slaptest (8),
 282 .BR slurpd (8)
 283 .LP
 284 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
 285 .SH BUGS
 286 See http://www.openldap.org/its/
 287 .SH ACKNOWLEDGEMENTS
 288 .B OpenLDAP
 289 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
 290 .B OpenLDAP
 291 is derived from University of Michigan LDAP 3.3 Release.