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

   1 .\" $OpenLDAP$
   2 .\" Copyright 1998-2000 The OpenLDAP Foundation All Rights Reserved.
   3 .\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
   4 .TH SLAPD 8C "5 Novemeber 2000" "OpenLDAP LDVERSION"
   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, 0.0.0.0:636 for LDAP over TLS,
 112 and LDAP over IPC (Unix domain sockets).  Host 0.0.0.0 represents
 113 INADDR_ANY.
 114 A space separated list of URLs is expected.  The URLs should be of
 115 LDAP (ldap://) or LDAP over TLS (ldaps://) or LDAP over IPC (ldapi://)
 116 scheme without a DN or other optional parameters.  Support for the
 117 latter two schemes depends on selected configuration options.  Hosts
 118 may be specified by name or IPv4 and IPv6 address formats.
 119 Ports, if specfied, must be numeric.  The default ldap:// port is 389
 120 and the default ldaps:// port is 636.
 121 .TP
 122 .BI \-r " directory"
 123 Specifies a chroot "jail" directory.  slapd will
 124 .BR chdir (2)
 125 then
 126 .BR chroot (2)
 127 to this directory after opening listeners but before any reading
 128 any configuration file or initializing any backend.
 129 .TP
 130 .BI \-u " user"
 131 .B slapd
 132 will run slapd with the specified user name or id, and that user's
 133 supplementary group access list as set with initgroups(3).  The group ID
 134 is also changed to this user's gid, unless the -g option is used to
 135 override.
 136 .TP
 137 .BI \-g " group"
 138 .B slapd
 139 will run with the specified group name or id.
 140 .LP
 141 Note that on some systems, running as a non-privileged user will prevent
 142 passwd back-ends from accessing the encrypted passwords.  Note also that
 143 any shell back-ends will run as the specified non-privileged user.
 144 .SH EXAMPLES
 145 To start
 146 .I slapd
 147 and have it fork and detach from the terminal and start serving
 148 the LDAP databases defined in the default config file, just type:
 149 .LP
 150 .nf
 151 .ft tt
 152         LIBEXECDIR/slapd
 153 .ft
 154 .fi
 155 .LP
 156 To start
 157 .B slapd
 158 with an alternate configuration file, and turn
 159 on voluminous debugging which will be printed on standard error, type:
 160 .LP
 161 .nf
 162 .ft tt
 163         LIBEXECDIR/slapd -f ETCDIR/slapd.conf -d 255
 164 .ft
 165 .fi
 166 .LP
 167 .SH "SEE ALSO"
 168 .BR ldap (3),
 169 .BR slapd.conf (5),
 170 .BR slurpd (8)
 171 .LP
 172 "OpenLDAP Administrator's Guide" (http://www.OpenLDAP.org/doc/admin/)
 173 .SH BUGS
 174 See http://www.openldap.org/its/
 175 .SH ACKNOWLEDGEMENTS
 176 .B      OpenLDAP
 177 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
 178 .B      OpenLDAP
 179 is derived from University of Michigan LDAP 3.3 Release.