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

   1 .TH SLAPD 8C "3 April 1999" "OpenLDAP LDVERSION"
   2 .SH NAME
   3 slapd \- Stand-alone LDAP Daemon
   4 .SH SYNOPSIS
   5 .B LIBEXECDIR/slapd
   6 .B [\-f slapd\-config\-file]
   7 .B [\-h URLs]
   8 .B [\-d debug\-level]
   9 .B [\-p port\-number]
  10 .B [\-P tls\-port\-number]
  11 .B [\-s syslog\-level] [\-l syslog\-local\-user]
  12 .B [\-u user] [\-g group]
  13 .B
  14 .SH DESCRIPTION
  15 .LP
  16 .B Slapd
  17 is the stand-alone LDAP daemon. It listens for LDAP connections on
  18 any number of ports (default 389), responding
  19 to the LDAP operations it receives over these connections.
  20 .B slapd
  21 is typically invoked at boot time, usually out of
  22 .BR  /etc/rc.local .
  23 Upon startup,
  24 .B slapd
  25 normally forks and disassociates itself from the invoking tty.
  26 If configured in
  27 .BR ETCDIR/slapd.conf ,
  28 the
  29 .B slapd
  30 process will print its process ID ( see
  31 .BR getpid (2)
  32 ) to a
  33 .B .pid
  34 file, as well as the command line options during invocation to an
  35 .B .args
  36 file ( see
  37 .BR slapd.conf (5)
  38 ).
  39 If the
  40 .B \-d
  41 flag is given and debugging is set to some non-zero
  42 value,
  43 .B slapd
  44 will not fork and disassociate from the invoking tty.
  45 .LP
  46 .B Slapd
  47 can be configured to provide replicated service for a database with
  48 the help of
  49 .BR slurpd ,
  50 the standalone LDAP update replication daemon.
  51 See
  52 .BR slurpd (8)
  53 for details.
  54 .LP
  55 See "The SLAPD and SLURPD Administrator's Guide" for more details on
  56 .BR slapd .
  57 .SH OPTIONS
  58 .TP
  59 .BI \-d " debug\-level"
  60 Turn on debugging as defined by
  61 .I debug\-level.
  62 If this option is specified,
  63 .B slapd
  64 will not fork or disassociate from the invoking terminal.  Some general
  65 operation and status messages are printed for any value of \fIdebug\-level\fP.
  66 \fIdebug\-level\fP is taken as a bit string, with each bit corresponding to a
  67 different kind of debugging information.  See <ldap.h> for details.
  68 .TP
  69 .BI \-s " syslog\-level"
  70 This option tells
  71 .B slapd
  72 at what level debugging statements should be logged to the
  73 .BR syslog (8)
  74 facility.
  75 .TP
  76 .BI \-l " syslog\-local\-user"
  77 Selects the local user of the
  78 .BR syslog (8)
  79 facility. Values can be
  80 .BR LOCAL0 ,
  81 .BR LOCAL1 ,
  82 and so on, up to
  83 .BR LOCAL7 .
  84 The default is
  85 .BR LOCAL4 .
  86 However, this option is only permitted on systems that support
  87 local users with the
  88 .BR syslog (8)
  89 facility.
  90 .TP
  91 .BI \-f " slapd\-config\-file"
  92 Specifies the slapd configuration file. The default is
  93 .BR ETCDIR/slapd.conf .
  94 .TP
  95 .BI \-h " URLlist"
  96 .B slapd
  97 will serve
  98 .B ldap:///
  99 (LDAP over TCP on all interfaces on default LDAP port).  As such,
 100 it will bind to INADDR_ANY, port 389.
 101 The
 102 .B \-h
 103 option may be used to specify LDAP (and LDAPS) URLs to serve.
 104 For example, if slapd is given
 105 .B \-h " ldap://127.0.0.1:9009/ ldaps:///",
 106 It will bind 127.0.0.1:9009 for LDAP and INADDR_ANY:636 for LDAP over TLS.
 107 A space separated list of URLs is expected.  The URLS should be of
 108 LDAP (ldap://) or, if supported, LDAP over TLS (ldaps://) type without
 109 a DN or other optional parameters.  Hosts may be specified in either
 110 Internet '.' format (preferred) or by name.  Ports, if specfied,
 111 must be numeric.
 112 .TP
 113 .BI \-p " port\-number"
 114 .B slapd
 115 will use on the default port (389) for LDAP URLs unless this
 116 option is given to override the default.
 117 A numeric port number is expected.
 118 .TP
 119 .BI \-P " tls\-port\-number"
 120 .B slapd
 121 will use on the default port (636) for LDAPS (LDAP over TLS) URLs
 122 unless this option is given to override the default.  A numeric port
 123 number is expected.
 124 .TP
 125 .BI \-P " port\-number"
 126 Changes the port where
 127 .B slapd
 128 will expect LDAP over raw TLS connections.  If this option is not given,
 129 the default port for this purpose (636) will be used.  A numeric port
 130 number is expected.
 131 .TP
 132 .BI \-u " user"
 133 .B slapd
 134 will run slapd with the specified user name or id, and that user's
 135 supplementary group access list as set with initgroups(3).  The group ID
 136 is also changed to this user's gid, unless the -g option is used to
 137 override.
 138 .TP
 139 .BI \-g " group"
 140 .B slapd
 141 will run with the specified group name or id.
 142 .LP
 143 Note that on some systems, running as a non-privileged user will prevent
 144 passwd back-ends from accessing the encrypted passwords.  Note also that
 145 any shell back-ends will run as the specified non-privileged user.
 146 .SH EXAMPLES
 147 To start
 148 .I slapd
 149 and have it fork and detach from the terminal and start serving
 150 the LDAP databases defined in the default config file, just type:
 151 .LP
 152 .nf
 153 .ft tt
 154         LIBEXECDIR/slapd
 155 .ft
 156 .fi
 157 .LP
 158 To start
 159 .B slapd
 160 with an alternate configuration file, and turn
 161 on voluminous debugging which will be printed on standard error, type:
 162 .LP
 163 .nf
 164 .ft tt
 165         LIBEXECDIR/slapd -f ETCDIR/slapd.conf -d 255
 166 .ft
 167 .fi
 168 .LP
 169 .SH "SEE ALSO"
 170 .BR ldap (3),
 171 .BR slapd.conf (5),
 172 .BR slurpd (8)
 173 .LP
 174 "The SLAPD and SLURPD Administrator's Guide"
 175 .SH BUGS
 176 When using the LDBM database backend, the Modify RDN operation does not
 177 update the attribute values in the entry that are affected by the change.
 178 .SH ACKNOWLEDGEMENTS
 179 .B      OpenLDAP
 180 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
 181 .B      OpenLDAP
 182 is derived from University of Michigan LDAP 3.3 Release.