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

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