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