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

   1 .\" $OpenLDAP$
   2 .\" Copyright 1998-2004 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 {add|auth|cat|dn|index|passwd|test}]
  11 .B [\-d debug\-level]
  12 .B [\-f slapd\-config\-file]
  13 .B [\-h URLs]
  14 .B [\-n service\-name] [\-s syslog\-level] [\-l syslog\-local\-user]
  15 .B [\-r directory]
  16 .B [\-u user] [\-g group]
  17 .B [\-c cookie]
  18 .SH DESCRIPTION
  19 .LP
  20 .B Slapd
  21 is the stand-alone LDAP daemon. It listens for LDAP connections on
  22 any number of ports (default 389), responding
  23 to the LDAP operations it receives over these connections.
  24 .B slapd
  25 is typically invoked at boot time, usually out of
  26 .BR  /etc/rc.local .
  27 Upon startup,
  28 .B slapd
  29 normally forks and disassociates itself from the invoking tty.
  30 If configured in
  31 .BR ETCDIR/slapd.conf ,
  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 slatest. This option
  70 should be the first option specified when it is used. Any remaining options
  71 will be interpreted by the corresponding slap tool program. Note that these
  72 tool programs will usually be symbolic links to slapd. This option is provided
  73 for situations where symbolic links are not provided or not usable.
  74 .TP
  75 .BI \-d " debug\-level"
  76 Turn on debugging as defined by
  77 .I debug\-level.
  78 If this option is specified, even with a zero argument,
  79 .B slapd
  80 will not fork or disassociate from the invoking terminal.  Some general
  81 operation and status messages are printed for any value of \fIdebug\-level\fP.
  82 \fIdebug\-level\fP is taken as a bit string, with each bit corresponding to a
  83 different kind of debugging information.  See <ldap.h> for details.
  84 Remember that if you turn on packet logging, packets containing bind passwords
  85 will be output, so if you redirect the log to a logfile, that file should
  86 be read-protected.
  87 .TP
  88 .BI \-s " syslog\-level"
  89 This option tells
  90 .B slapd
  91 at what level debugging statements should be logged to the
  92 .BR syslog (8)
  93 facility.
  94 .TP
  95 .BI \-n " service\-name"
  96 Specifies the service name for logging and other purposes.  Defaults
  97 to basename of argv[0], i.e.: "slapd".
  98 .TP
  99 .BI \-l " syslog\-local\-user"
 100 Selects the local user of the
 101 .BR syslog (8)
 102 facility. Value can be
 103 .BR LOCAL0 ,
 104 through
 105 .BR LOCAL7 ,
 106 as well as
 107 .B USER
 108 and
 109 .BR DAEMON .
 110 The default is
 111 .BR LOCAL4 .
 112 However, this option is only permitted on systems that support
 113 local users with the
 114 .BR syslog (8)
 115 facility.
 116 .TP
 117 .BI \-f " slapd\-config\-file"
 118 Specifies the slapd configuration file. The default is
 119 .BR ETCDIR/slapd.conf .
 120 .TP
 121 .BI \-h " URLlist"
 122 .B slapd
 123 will by default serve
 124 .B ldap:///
 125 (LDAP over TCP on all interfaces on default LDAP port).  That is,
 126 it will bind using INADDR_ANY and port 389.
 127 The
 128 .B \-h
 129 option may be used to specify LDAP (and other scheme) URLs to serve.
 130 For example, if slapd is given
 131 .BR "\-h \(dqldap://127.0.0.1:9009/ ldaps:/// ldapi:///\(dq" ,
 132 it will listen on 127.0.0.1:9009 for LDAP, 0.0.0.0:636 for LDAP over TLS,
 133 and LDAP over IPC (Unix domain sockets).  Host 0.0.0.0 represents
 134 INADDR_ANY (any interface).
 135 A space separated list of URLs is expected.  The URLs should be of
 136 LDAP (ldap://) or LDAP over TLS (ldaps://) or LDAP over IPC (ldapi://)
 137 scheme without a DN or other optional parameters, except an experimental
 138 extension to indicate the permissions of the underlying listeners.
 139 Support for the latter two schemes depends on selected configuration
 140 options.  Hosts may be specified by name or IPv4 and IPv6 address formats.
 141 Ports, if specified, must be numeric.  The default ldap:// port is 389
 142 and the default ldaps:// port is 636.
 143 The socket permissions for LDAP over IPC are indicated by
 144 "x-mod=-rwxrwxrwx", "x-mod=0777" or "x-mod=777", where any
 145 of the "rwx" can be "-" to suppress the related permission (note,
 146 however, that sockets only honor the "w" permission), while any
 147 of the "7" can be any legal octal digit, according to chmod(1).
 148 While LDAP over IPC requires write permissions on the socket to allow
 149 any operation, the other listeners can take advantage of the "x-mod"
 150 extension to apply rough limitations to users, e.g. allow read operations
 151 ("r", which applies to search and compare), write operations ("w",
 152 which applies to add, delete, modify and modrdn), and execute operations
 153 ("x", which means bind is required).
 154 "User" permissions apply to bound users, while "other" apply
 155 to anonymous users.
 156 .TP
 157 .BI \-r " directory"
 158 Specifies a directory to become the root directory.  slapd will
 159 change the current working directory to this directory and
 160 then
 161 .BR chroot (2)
 162 to this directory.  This is done after opening listeners but before
 163 reading any configuration file or initializing any backend.  When
 164 used as a security mechanism, it should be used in conjunction with
 165 .B -u
 166 and
 167 .B -g
 168 options.
 169 .TP
 170 .BI \-u " user"
 171 .B slapd
 172 will run slapd with the specified user name or id, and that user's
 173 supplementary group access list as set with initgroups(3).  The group ID
 174 is also changed to this user's gid, unless the -g option is used to
 175 override.  Note when used with
 176 .BR -r ,
 177 slapd will use the user database in the change root environment.
 178 .LP
 179 Note that on some systems, running as a non-privileged user will prevent
 180 passwd back-ends from accessing the encrypted passwords.  Note also that
 181 any shell back-ends will run as the specified non-privileged user.
 182 .TP
 183 .BI \-g " group"
 184 .B slapd
 185 will run with the specified group name or id.  Note when used with
 186 .BR -r ,
 187 slapd will use the group database in the change root environment.
 188 .TP
 189 .BI \-c " cookie"
 190 This option provides a cookie for the syncrepl replication consumer.
 191 The cookie is a comma separated list of name=value pairs.
 192 Currently supported syncrepl cookie fields are
 193 .B csn,
 194 .B sid,
 195 and
 196 .B rid.
 197 .B csn
 198 is the commit sequence number received by a previous synchronization
 199 and represents the state of the consumer replica content which the
 200 syncrepl engine will synchronize to the current provider content.
 201 .B sid
 202 is the identity of the per-scope session log with which the
 203 provider server can process this syncrepl request to reduce
 204 synchronization traffic.
 205 .B rid
 206 identifies a replication thread within the consumer server
 207 and is used to find the syncrepl specification in
 208 .BR slapd.conf (5)
 209 having the matching replication identifier in its definition.
 210 .SH EXAMPLES
 211 To start
 212 .I slapd
 213 and have it fork and detach from the terminal and start serving
 214 the LDAP databases defined in the default config file, just type:
 215 .LP
 216 .nf
 217 .ft tt
 218         LIBEXECDIR/slapd
 219 .ft
 220 .fi
 221 .LP
 222 To start
 223 .B slapd
 224 with an alternate configuration file, and turn
 225 on voluminous debugging which will be printed on standard error, type:
 226 .LP
 227 .nf
 228 .ft tt
 229         LIBEXECDIR/slapd -f /var/tmp/slapd.conf -d 255
 230 .ft
 231 .fi
 232 .LP
 233 To test whether the configuration file is correct or not, type:
 234 .LP
 235 .nf
 236 .ft tt
 237         LIBEXECDIR/slapd -Tt
 238 .ft
 239 .fi
 240 .LP
 241 .SH "SEE ALSO"
 242 .BR ldap (3),
 243 .BR slapd.conf (5),
 244 .BR slapd.access (5),
 245 .BR slapadd (8),
 246 .BR slapcat (8),
 247 .BR slapdn (8),
 248 .BR slapindex (8),
 249 .BR slappasswd (8),
 250 .BR slaptest (8),
 251 .BR slurpd (8)
 252 .LP
 253 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
 254 .SH BUGS
 255 See http://www.openldap.org/its/
 256 .SH ACKNOWLEDGEMENTS
 257 .B OpenLDAP
 258 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
 259 .B OpenLDAP
 260 is derived from University of Michigan LDAP 3.3 Release.