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

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