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

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