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 .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|d|i|p|t}
  69 Run in Tool mode. The additional argument selects whether to run as
  70 slapadd, slapcat, slapdn, slapindex, slappasswd, or slatest. This option
  71 should be the first option specified when it is used. Any remaining options
  72 will be interpreted by the corresponding slap tool program. Note that these
  73 tool programs will usually be symbolic links to slapd. This option is provided
  74 for situations 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. Value can be
 104 .BR LOCAL0 ,
 105 through
 106 .BR LOCAL7 ,
 107 as well as
 108 .B USER
 109 and
 110 .BR DAEMON .
 111 The default is
 112 .BR LOCAL4 .
 113 However, this option is only permitted on systems that support
 114 local users with the
 115 .BR syslog (8)
 116 facility.
 117 .TP
 118 .BI \-f " slapd\-config\-file"
 119 Specifies the slapd configuration file. The default is
 120 .BR ETCDIR/slapd.conf .
 121 .TP
 122 .BI \-h " URLlist"
 123 .B slapd
 124 will by default serve
 125 .B ldap:///
 126 (LDAP over TCP on all interfaces on default LDAP port).  That is,
 127 it will bind using INADDR_ANY and port 389.
 128 The
 129 .B \-h
 130 option may be used to specify LDAP (and other scheme) URLs to serve.
 131 For example, if slapd is given
 132 .BR "\-h \(dqldap://127.0.0.1:9009/ ldaps:/// ldapi:///\(dq" ,
 133 it will listen on 127.0.0.1:9009 for LDAP, 0.0.0.0:636 for LDAP over TLS,
 134 and LDAP over IPC (Unix domain sockets).  Host 0.0.0.0 represents
 135 INADDR_ANY (any interface).
 136 A space separated list of URLs is expected.  The URLs should be of
 137 LDAP (ldap://) or LDAP over TLS (ldaps://) or LDAP over IPC (ldapi://)
 138 scheme without a DN or other optional parameters, except an experimental
 139 extension to indicate the permissions of the underlying listeners.
 140 Support for the latter two schemes depends on selected configuration
 141 options.  Hosts may be specified by name or IPv4 and IPv6 address formats.
 142 Ports, if specified, must be numeric.  The default ldap:// port is 389
 143 and the default ldaps:// port is 636.
 144 The socket permissions for LDAP over IPC are indicated by
 145 "x-mod=-rwxrwxrwx", "x-mod=0777" or "x-mod=777", where any
 146 of the "rwx" can be "-" to suppress the related permission (note,
 147 however, that sockets only honor the "w" permission), while any
 148 of the "7" can be any legal octal digit, according to chmod(1).
 149 While LDAP over IPC requires write permissions on the socket to allow
 150 any operation, the other listeners can take advantage of the "x-mod"
 151 extension to apply rough limitations to users, e.g. allow read operations
 152 ("r", which applies to search and compare), write operations ("w",
 153 which applies to add, delete, modify and modrdn), and execute operations
 154 ("x", which means bind is required).
 155 "User" permissions apply to bound users, while "other" apply
 156 to anonymous users.
 157 .TP
 158 .BI \-r " directory"
 159 Specifies a chroot "jail" directory.  slapd will
 160 .BR chdir (2)
 161 then
 162 .BR chroot (2)
 163 to this directory after opening listeners but before reading
 164 any configuration file or initializing any backend.
 165 .TP
 166 .BI \-u " user"
 167 .B slapd
 168 will run slapd with the specified user name or id, and that user's
 169 supplementary group access list as set with initgroups(3).  The group ID
 170 is also changed to this user's gid, unless the -g option is used to
 171 override.
 172 .TP
 173 .BI \-g " group"
 174 .B slapd
 175 will run with the specified group name or id.
 176 .LP
 177 Note that on some systems, running as a non-privileged user will prevent
 178 passwd back-ends from accessing the encrypted passwords.  Note also that
 179 any shell back-ends will run as the specified non-privileged user.
 180 .TP
 181 .BI \-c " cookie"
 182 This option provides a cookie for the syncrepl replication consumer.
 183 The cookie is a comma separated list of name=value pairs.
 184 Currently supported syncrepl cookie fields are
 185 .B csn,
 186 .B sid,
 187 and
 188 .B rid.
 189 .B csn
 190 is the commit sequence number received by a previous synchronization
 191 and represents the state of the consumer replica content which the
 192 syncrepl engine will synchronize to the current provider content.
 193 .B sid
 194 is the identity of the per-scope session log with which the
 195 provider server can process this syncrepl request to reduce
 196 synchronization traffic.
 197 .B rid
 198 identifies a replication thread within the consumer server
 199 and is used to find the syncrepl specification in
 200 .BR slapd.conf (5)
 201 having the matching replication identifier in its definition.
 202 .SH EXAMPLES
 203 To start
 204 .I slapd
 205 and have it fork and detach from the terminal and start serving
 206 the LDAP databases defined in the default config file, just type:
 207 .LP
 208 .nf
 209 .ft tt
 210         LIBEXECDIR/slapd
 211 .ft
 212 .fi
 213 .LP
 214 To start
 215 .B slapd
 216 with an alternate configuration file, and turn
 217 on voluminous debugging which will be printed on standard error, type:
 218 .LP
 219 .nf
 220 .ft tt
 221         LIBEXECDIR/slapd -f /var/tmp/slapd.conf -d 255
 222 .ft
 223 .fi
 224 .LP
 225 To test whether the configuration file is correct or not, type:
 226 .LP
 227 .nf
 228 .ft tt
 229         LIBEXECDIR/slapd -Tt
 230 .ft
 231 .fi
 232 .LP
 233 .SH "SEE ALSO"
 234 .BR ldap (3),
 235 .BR slapd.conf (5),
 236 .BR slapd.access (5),
 237 .BR slapadd (8),
 238 .BR slapcat (8),
 239 .BR slapdn (8),
 240 .BR slapindex (8),
 241 .BR slappasswd (8),
 242 .BR slaptest (8),
 243 .BR slurpd (8)
 244 .LP
 245 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
 246 .SH BUGS
 247 See http://www.openldap.org/its/
 248 .SH ACKNOWLEDGEMENTS
 249 .B OpenLDAP
 250 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
 251 .B OpenLDAP
 252 is derived from University of Michigan LDAP 3.3 Release.