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

   1 .TH SLAPD 8C "3 April 1999" "OpenLDAP LDVERSION"
   2 .\" $OpenLDAP$
   3 .\" Copyright 1998-1999 The OpenLDAP Foundation All Rights Reserved.
   4 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
   5 .SH NAME
   6 slapd \- Stand-alone LDAP Daemon
   7 .SH SYNOPSIS
   8 .B LIBEXECDIR/slapd
   9 .B [\-f slapd\-config\-file]
  10 .B [\-h URLs]
  11 .B [\-d debug\-level]
  12 .B [\-p port\-number]
  13 .B [\-P tls\-port\-number]
  14 .B [\-s syslog\-level] [\-l syslog\-local\-user]
  15 .B [\-u user] [\-g group]
  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 SLAPD and SLURPD Administrator's Guide" for more details on
  58 .BR slapd .
  59 .SH OPTIONS
  60 .TP
  61 .BI \-d " debug\-level"
  62 Turn on debugging as defined by
  63 .I debug\-level.
  64 If this option is specified, even with a zero argument,
  65 .B slapd
  66 will not fork or disassociate from the invoking terminal.  Some general
  67 operation and status messages are printed for any value of \fIdebug\-level\fP.
  68 \fIdebug\-level\fP is taken as a bit string, with each bit corresponding to a
  69 different kind of debugging information.  See <ldap.h> for details.
  70 .TP
  71 .BI \-s " syslog\-level"
  72 This option tells
  73 .B slapd
  74 at what level debugging statements should be logged to the
  75 .BR syslog (8)
  76 facility.
  77 .TP
  78 .BI \-l " syslog\-local\-user"
  79 Selects the local user of the
  80 .BR syslog (8)
  81 facility. Values can be
  82 .BR LOCAL0 ,
  83 .BR LOCAL1 ,
  84 and so on, up to
  85 .BR LOCAL7 .
  86 The default is
  87 .BR LOCAL4 .
  88 However, this option is only permitted on systems that support
  89 local users with the
  90 .BR syslog (8)
  91 facility.
  92 .TP
  93 .BI \-f " slapd\-config\-file"
  94 Specifies the slapd configuration file. The default is
  95 .BR ETCDIR/slapd.conf .
  96 .TP
  97 .BI \-h " URLlist"
  98 .B slapd
  99 will serve
 100 .B ldap:///
 101 (LDAP over TCP on all interfaces on default LDAP port).  As such,
 102 it will bind to INADDR_ANY, port 389.
 103 The
 104 .B \-h
 105 option may be used to specify LDAP (and LDAPS) URLs to serve.
 106 For example, if slapd is given
 107 .B \-h " ldap://127.0.0.1:9009/ ldaps:///",
 108 It will bind 127.0.0.1:9009 for LDAP and INADDR_ANY:636 for LDAP over TLS.
 109 A space separated list of URLs is expected.  The URLS should be of
 110 LDAP (ldap://) or, if supported, LDAP over TLS (ldaps://) type without
 111 a DN or other optional parameters.  Hosts may be specified in either
 112 Internet '.' format (preferred) or by name.  Ports, if specfied,
 113 must be numeric.
 114 .TP
 115 .BI \-p " port\-number"
 116 .B slapd
 117 will use on the default port (389) for LDAP URLs unless this
 118 option is given to override the default.
 119 A numeric port number is expected.
 120 .TP
 121 .BI \-P " tls\-port\-number"
 122 .B slapd
 123 will use on the default port (636) for LDAPS (LDAP over TLS) URLs
 124 unless this option is given to override the default.  A numeric port
 125 number is expected.
 126 .TP
 127 .BI \-P " port\-number"
 128 Changes the port where
 129 .B slapd
 130 will expect LDAP over raw TLS connections.  If this option is not given,
 131 the default port for this purpose (636) will be used.  A numeric port
 132 number is expected.
 133 .TP
 134 .BI \-u " user"
 135 .B slapd
 136 will run slapd with the specified user name or id, and that user's
 137 supplementary group access list as set with initgroups(3).  The group ID
 138 is also changed to this user's gid, unless the -g option is used to
 139 override.
 140 .TP
 141 .BI \-g " group"
 142 .B slapd
 143 will run with the specified group name or id.
 144 .LP
 145 Note that on some systems, running as a non-privileged user will prevent
 146 passwd back-ends from accessing the encrypted passwords.  Note also that
 147 any shell back-ends will run as the specified non-privileged user.
 148 .SH EXAMPLES
 149 To start
 150 .I slapd
 151 and have it fork and detach from the terminal and start serving
 152 the LDAP databases defined in the default config file, just type:
 153 .LP
 154 .nf
 155 .ft tt
 156         LIBEXECDIR/slapd
 157 .ft
 158 .fi
 159 .LP
 160 To start
 161 .B slapd
 162 with an alternate configuration file, and turn
 163 on voluminous debugging which will be printed on standard error, type:
 164 .LP
 165 .nf
 166 .ft tt
 167         LIBEXECDIR/slapd -f ETCDIR/slapd.conf -d 255
 168 .ft
 169 .fi
 170 .LP
 171 .SH "SEE ALSO"
 172 .BR ldap (3),
 173 .BR slapd.conf (5),
 174 .BR slurpd (8)
 175 .LP
 176 "The SLAPD and SLURPD Administrator's Guide"
 177 .SH BUGS
 178 When using the LDBM database backend, the Modify RDN operation does not
 179 update the attribute values in the entry that are affected by the change.
 180 .SH ACKNOWLEDGEMENTS
 181 .B      OpenLDAP
 182 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
 183 .B      OpenLDAP
 184 is derived from University of Michigan LDAP 3.3 Release.