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

   1 .\" $OpenLDAP$
   2 .\" Copyright 1998-2002 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
  17 .SH DESCRIPTION
  18 .LP
  19 .B Slapd
  20 is the stand-alone LDAP daemon. It listens for LDAP connections on
  21 any number of ports (default 389), responding
  22 to the LDAP operations it receives over these connections.
  23 .B slapd
  24 is typically invoked at boot time, usually out of
  25 .BR  /etc/rc.local .
  26 Upon startup,
  27 .B slapd
  28 normally forks and disassociates itself from the invoking tty.
  29 If configured in
  30 .BR ETCDIR/slapd.conf ,
  31 the
  32 .B slapd
  33 process will print its process ID ( see
  34 .BR getpid (2)
  35 ) to a
  36 .B .pid
  37 file, as well as the command line options during invocation to an
  38 .B .args
  39 file ( see
  40 .BR slapd.conf (5)
  41 ).
  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 " ldap://127.0.0.1:9009/ ldaps:/// ldapi:///",
 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 socket, on those
 128 OSes that honor them.  Support for the
 129 latter two schemes depends on selected configuration options.  Hosts
 130 may be specified by name or IPv4 and IPv6 address formats.
 131 Ports, if specfied, must be numeric.  The default ldap:// port is 389
 132 and the default ldaps:// port is 636.
 133 The socket permissions for LDAP over IPC are indicated by
 134 "x-mod=-rwxrwxrwx", "x-mod=0777" or "x-mod=777", where any
 135 of the "rwx" can be "-" to suppress the related permission (note,
 136 however, that sockets only honor the "w" permission), while any
 137 of the "7" can be any legal octal digit, according to chmod(1).
 138 .TP
 139 .BI \-r " directory"
 140 Specifies a chroot "jail" directory.  slapd will
 141 .BR chdir (2)
 142 then
 143 .BR chroot (2)
 144 to this directory after opening listeners but before reading
 145 any configuration file or initializing any backend.
 146 .TP
 147 .BI \-u " user"
 148 .B slapd
 149 will run slapd with the specified user name or id, and that user's
 150 supplementary group access list as set with initgroups(3).  The group ID
 151 is also changed to this user's gid, unless the -g option is used to
 152 override.
 153 .TP
 154 .BI \-g " group"
 155 .B slapd
 156 will run with the specified group name or id.
 157 .LP
 158 Note that on some systems, running as a non-privileged user will prevent
 159 passwd back-ends from accessing the encrypted passwords.  Note also that
 160 any shell back-ends will run as the specified non-privileged user.
 161 .TP
 162 .BI \-t
 163 .B slapd
 164 will read the configuration file (the default if none is given with the
 165 \fI\-f\fP switch) and check its syntax, without opening any listener
 166 or database.
 167 .SH EXAMPLES
 168 To start
 169 .I slapd
 170 and have it fork and detach from the terminal and start serving
 171 the LDAP databases defined in the default config file, just type:
 172 .LP
 173 .nf
 174 .ft tt
 175         LIBEXECDIR/slapd
 176 .ft
 177 .fi
 178 .LP
 179 To start
 180 .B slapd
 181 with an alternate configuration file, and turn
 182 on voluminous debugging which will be printed on standard error, type:
 183 .LP
 184 .nf
 185 .ft tt
 186         LIBEXECDIR/slapd -f /var/tmp/slapd.conf -d 255
 187 .ft
 188 .fi
 189 .LP
 190 To test whether the configuration file is correct or not, type:
 191 .LP
 192 .nf
 193 .ft tt
 194         LIBEXECDIR/slapd -t
 195 .ft
 196 .fi
 197 .LP
 198 .SH "SEE ALSO"
 199 .BR ldap (3),
 200 .BR slapd.conf (5),
 201 .BR slapd.access (5),
 202 .BR slurpd (8)
 203 .LP
 204 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
 205 .SH BUGS
 206 See http://www.openldap.org/its/
 207 .SH ACKNOWLEDGEMENTS
 208 .B      OpenLDAP
 209 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
 210 .B      OpenLDAP
 211 is derived from University of Michigan LDAP 3.3 Release.