openldap/doc/man/man8/slapd.8

.TH SLAPD 8C "19 September 1999" "OpenLDAP LDVERSION"
.\" $OpenLDAP$
.\" Copyright 1998-2000 The OpenLDAP Foundation All Rights Reserved.
.\" Copying restrictions apply.  See COPYRIGHT/LICENSE.
.SH NAME
slapd \- Stand-alone LDAP Daemon
.SH SYNOPSIS
.B LIBEXECDIR/slapd 
.B [\-f slapd\-config\-file]
.B [\-h URLs]
.B [\-d debug\-level]
.B [\-s syslog\-level] [\-l syslog\-local\-user]
.B [\-u user] [\-g group]
.B 
.SH DESCRIPTION
.LP
.B Slapd
is the stand-alone LDAP daemon. It listens for LDAP connections on
any number of ports (default 389), responding
to the LDAP operations it receives over these connections.
.B slapd
is typically invoked at boot time, usually out of
.BR  /etc/rc.local .
Upon startup,
.B slapd
normally forks and disassociates itself from the invoking tty.
If configured in
.BR ETCDIR/slapd.conf ,
the
.B slapd
process will print its process ID ( see
.BR getpid (2)
) to a 
.B .pid
file, as well as the command line options during invocation to an
.B .args
file ( see 
.BR slapd.conf (5)
).
If the
.B \-d
flag is given, even with a zero argument,
.B slapd
will not fork and disassociate from the invoking tty.
.LP
.B Slapd
can be configured to provide replicated service for a database with
the help of
.BR slurpd ,
the standalone LDAP update replication daemon.
See
.BR slurpd (8)
for details.
.LP
See "The SLAPD and SLURPD Administrator's Guide" for more details on
.BR slapd .
.SH OPTIONS
.TP
.BI \-d " debug\-level"
Turn on debugging as defined by
.I debug\-level.
If this option is specified, even with a zero argument,
.B slapd
will not fork or disassociate from the invoking terminal.  Some general
operation and status messages are printed for any value of \fIdebug\-level\fP.
\fIdebug\-level\fP is taken as a bit string, with each bit corresponding to a
different kind of debugging information.  See <ldap.h> for details.
.TP
.BI \-s " syslog\-level"
This option tells
.B slapd
at what level debugging statements should be logged to the
.BR syslog (8)
facility.
.TP
.BI \-l " syslog\-local\-user"
Selects the local user of the
.BR syslog (8)
facility. Values can be 
.BR LOCAL0 , 
.BR LOCAL1 , 
and so on, up to 
.BR LOCAL7 . 
The default is
.BR LOCAL4 .
However, this option is only permitted on systems that support
local users with the 
.BR syslog (8)
facility.
.TP
.BI \-f " slapd\-config\-file"
Specifies the slapd configuration file. The default is
.BR ETCDIR/slapd.conf .
.TP
.BI \-h " URLlist"
.B slapd
will serve
.B ldap:///
(LDAP over TCP on all interfaces on default LDAP port).  As such,
it will bind to INADDR_ANY, port 389.
The
.B \-h
option may be used to specify LDAP (and LDAPS) URLs to serve.
For example, if slapd is given
.B \-h " ldap://127.0.0.1:9009/ ldaps:///", 
It will bind 127.0.0.1:9009 for LDAP and INADDR_ANY:636 for LDAP over TLS.
A space separated list of URLs is expected.  The URLS should be of
LDAP (ldap://) or, if supported, LDAP over TLS (ldaps://) type without
a DN or other optional parameters.  Hosts may be specified in either
Internet '.' format (preferred) or by name.  Ports, if specfied,
must be numeric.
.TP
.BI \-u " user"
.B slapd
will run slapd with the specified user name or id, and that user's
supplementary group access list as set with initgroups(3).  The group ID
is also changed to this user's gid, unless the -g option is used to
override.
.TP
.BI \-g " group"
.B slapd
will run with the specified group name or id.
.LP
Note that on some systems, running as a non-privileged user will prevent
passwd back-ends from accessing the encrypted passwords.  Note also that
any shell back-ends will run as the specified non-privileged user.
.SH EXAMPLES
To start 
.I slapd
and have it fork and detach from the terminal and start serving
the LDAP databases defined in the default config file, just type:
.LP
.nf
.ft tt
	LIBEXECDIR/slapd
.ft
.fi
.LP
To start 
.B slapd
with an alternate configuration file, and turn
on voluminous debugging which will be printed on standard error, type:
.LP
.nf
.ft tt
	LIBEXECDIR/slapd -f ETCDIR/slapd.conf -d 255
.ft
.fi
.LP
.SH "SEE ALSO"
.BR ldap (3),
.BR slapd.conf (5),
.BR slurpd (8)
.LP
"The SLAPD and SLURPD Administrator's Guide"
.SH BUGS
See http://www.openldap.org/its/
.SH ACKNOWLEDGEMENTS
.B	OpenLDAP
is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
.B	OpenLDAP
is derived from University of Michigan LDAP 3.3 Release.
add deprecated comment to ldapd.8. 1999-09-20 02:12:18 +08:00			`.TH SLAPD 8C "19 September 1999" "OpenLDAP LDVERSION"`
Add RCSid and Copyright 1999-09-12 12:41:47 +08:00			`.\" $OpenLDAP$`
Y2k copyright update 2000-05-13 10:47:56 +08:00			`.\" Copyright 1998-2000 The OpenLDAP Foundation All Rights Reserved.`
Add RCSid and Copyright 1999-09-12 12:41:47 +08:00			`.\" Copying restrictions apply. See COPYRIGHT/LICENSE.`
Initial revision 1998-08-09 08:43:13 +08:00			`.SH NAME`
			`slapd \- Stand-alone LDAP Daemon`
			`.SH SYNOPSIS`
Update slapd(8) with new -h option. 1999-07-20 05:45:11 +08:00			`.B LIBEXECDIR/slapd`
			`.B [\-f slapd\-config\-file]`
			`.B [\-h URLs]`
			`.B [\-d debug\-level]`
			`.B [\-s syslog\-level] [\-l syslog\-local\-user]`
Modify slapd set user/group support to use -u/-g instead -U/-G. Moved -u (udp) to -c (connectionless). Connectionless is depreciated and undocumented. Added tests for set{,e}{u,g}id to configure. Use existance of setuid/setgid to enable feature. Use seteuid/setegid only if they exist. Fixed minor minor leak of username/groupname if specificied more than once. (This should actually be an error) 1999-04-21 08:40:20 +08:00			`.B [\-u user] [\-g group]`
Initial revision 1998-08-09 08:43:13 +08:00			`.B`
			`.SH DESCRIPTION`
			`.LP`
			`.B Slapd`
			`is the stand-alone LDAP daemon. It listens for LDAP connections on`
Update slapd(8) with new -h option. 1999-07-20 05:45:11 +08:00			`any number of ports (default 389), responding`
Initial revision 1998-08-09 08:43:13 +08:00			`to the LDAP operations it receives over these connections.`
			`.B slapd`
			`is typically invoked at boot time, usually out of`
			`.BR /etc/rc.local .`
			`Upon startup,`
			`.B slapd`
			`normally forks and disassociates itself from the invoking tty.`
Definition of slapd pid and args files as slapd.conf general parameters; introduction of pid/agrs parameters to the test-suite slapd.conf files; creation of sub-directory test/var for storage of pid/args files during test; update of the slapd and slapd.conf man pages. (The change reduces dependency on ldapconfig.h, since SLAPD_PIDEXT and SLAPD_ARGSEXT are deleted from the code.) 1999-01-21 23:53:54 +08:00			`If configured in`
			`.BR ETCDIR/slapd.conf ,`
			`the`
Description of the '-l syslog-local-user' option in the slapd manpage; also description of .pid and .args files. 1999-01-08 17:59:09 +08:00			`.B slapd`
Definition of slapd pid and args files as slapd.conf general parameters; introduction of pid/agrs parameters to the test-suite slapd.conf files; creation of sub-directory test/var for storage of pid/args files during test; update of the slapd and slapd.conf man pages. (The change reduces dependency on ldapconfig.h, since SLAPD_PIDEXT and SLAPD_ARGSEXT are deleted from the code.) 1999-01-21 23:53:54 +08:00			`process will print its process ID ( see`
Description of the '-l syslog-local-user' option in the slapd manpage; also description of .pid and .args files. 1999-01-08 17:59:09 +08:00			`.BR getpid (2)`
Definition of slapd pid and args files as slapd.conf general parameters; introduction of pid/agrs parameters to the test-suite slapd.conf files; creation of sub-directory test/var for storage of pid/args files during test; update of the slapd and slapd.conf man pages. (The change reduces dependency on ldapconfig.h, since SLAPD_PIDEXT and SLAPD_ARGSEXT are deleted from the code.) 1999-01-21 23:53:54 +08:00			`) to a`
			`.B .pid`
			`file, as well as the command line options during invocation to an`
Description of the '-l syslog-local-user' option in the slapd manpage; also description of .pid and .args files. 1999-01-08 17:59:09 +08:00			`.B .args`
Definition of slapd pid and args files as slapd.conf general parameters; introduction of pid/agrs parameters to the test-suite slapd.conf files; creation of sub-directory test/var for storage of pid/args files during test; update of the slapd and slapd.conf man pages. (The change reduces dependency on ldapconfig.h, since SLAPD_PIDEXT and SLAPD_ARGSEXT are deleted from the code.) 1999-01-21 23:53:54 +08:00			`file ( see`
			`.BR slapd.conf (5)`
			`).`
Initial revision 1998-08-09 08:43:13 +08:00			`If the`
			`.B \-d`
Change -d option to not detach even with -d 0 or compiled with --disable-debug. 1999-09-05 04:24:40 +08:00			`flag is given, even with a zero argument,`
Initial revision 1998-08-09 08:43:13 +08:00			`.B slapd`
			`will not fork and disassociate from the invoking tty.`
			`.LP`
			`.B Slapd`
			`can be configured to provide replicated service for a database with`
			`the help of`
			`.BR slurpd ,`
			`the standalone LDAP update replication daemon.`
			`See`
			`.BR slurpd (8)`
			`for details.`
			`.LP`
			`See "The SLAPD and SLURPD Administrator's Guide" for more details on`
			`.BR slapd .`
			`.SH OPTIONS`
			`.TP`
			`.BI \-d " debug\-level"`
			`Turn on debugging as defined by`
			`.I debug\-level.`
Change -d option to not detach even with -d 0 or compiled with --disable-debug. 1999-09-05 04:24:40 +08:00			`If this option is specified, even with a zero argument,`
Initial revision 1998-08-09 08:43:13 +08:00			`.B slapd`
			`will not fork or disassociate from the invoking terminal. Some general`
			`operation and status messages are printed for any value of \fIdebug\-level\fP.`
			`\fIdebug\-level\fP is taken as a bit string, with each bit corresponding to a`
			`different kind of debugging information. See <ldap.h> for details.`
			`.TP`
			`.BI \-s " syslog\-level"`
			`This option tells`
			`.B slapd`
			`at what level debugging statements should be logged to the`
			`.BR syslog (8)`
			`facility.`
			`.TP`
Tiny fix to the description of the -l option. 1999-01-08 18:09:07 +08:00			`.BI \-l " syslog\-local\-user"`
Description of the '-l syslog-local-user' option in the slapd manpage; also description of .pid and .args files. 1999-01-08 17:59:09 +08:00			`Selects the local user of the`
			`.BR syslog (8)`
			`facility. Values can be`
			`.BR LOCAL0 ,`
			`.BR LOCAL1 ,`
			`and so on, up to`
			`.BR LOCAL7 .`
			`The default is`
			`.BR LOCAL4 .`
			`However, this option is only permitted on systems that support`
			`local users with the`
			`.BR syslog (8)`
			`facility.`
			`.TP`
Initial revision 1998-08-09 08:43:13 +08:00			`.BI \-f " slapd\-config\-file"`
			`Specifies the slapd configuration file. The default is`
			`.BR ETCDIR/slapd.conf .`
			`.TP`
Update slapd(8) with new -h option. 1999-07-20 05:45:11 +08:00			`.BI \-h " URLlist"`
Add slapd -a address support. Allows you to bind to a specific address. Useful for running multiple servers in a virtual hosting environment. Modified test001-ldif2ldbm to verify this functionality. Assumes localhost is 127.0.0.1. 1999-03-17 11:56:25 +08:00			`.B slapd`
Update slapd(8) with new -h option. 1999-07-20 05:45:11 +08:00			`will serve`
			`.B ldap:///`
			`(LDAP over TCP on all interfaces on default LDAP port). As such,`
			`it will bind to INADDR_ANY, port 389.`
			`The`
			`.B \-h`
			`option may be used to specify LDAP (and LDAPS) URLs to serve.`
			`For example, if slapd is given`
			`.B \-h " ldap://127.0.0.1:9009/ ldaps:///",`
			`It will bind 127.0.0.1:9009 for LDAP and INADDR_ANY:636 for LDAP over TLS.`
			`A space separated list of URLs is expected. The URLS should be of`
			`LDAP (ldap://) or, if supported, LDAP over TLS (ldaps://) type without`
			`a DN or other optional parameters. Hosts may be specified in either`
			`Internet '.' format (preferred) or by name. Ports, if specfied,`
			`must be numeric.`
Add slapd -a address support. Allows you to bind to a specific address. Useful for running multiple servers in a virtual hosting environment. Modified test001-ldif2ldbm to verify this functionality. Assumes localhost is 127.0.0.1. 1999-03-17 11:56:25 +08:00			`.TP`
Modify slapd set user/group support to use -u/-g instead -U/-G. Moved -u (udp) to -c (connectionless). Connectionless is depreciated and undocumented. Added tests for set{,e}{u,g}id to configure. Use existance of setuid/setgid to enable feature. Use seteuid/setegid only if they exist. Fixed minor minor leak of username/groupname if specificied more than once. (This should actually be an error) 1999-04-21 08:40:20 +08:00			`.BI \-u " user"`
Add -U and -G options to set user and group id. Move socket setup to set_socket(), called before the uid/gid change. 1999-04-03 11:19:07 +08:00			`.B slapd`
			`will run slapd with the specified user name or id, and that user's`
			`supplementary group access list as set with initgroups(3). The group ID`
Modify slapd set user/group support to use -u/-g instead -U/-G. Moved -u (udp) to -c (connectionless). Connectionless is depreciated and undocumented. Added tests for set{,e}{u,g}id to configure. Use existance of setuid/setgid to enable feature. Use seteuid/setegid only if they exist. Fixed minor minor leak of username/groupname if specificied more than once. (This should actually be an error) 1999-04-21 08:40:20 +08:00			`is also changed to this user's gid, unless the -g option is used to`
Add -U and -G options to set user and group id. Move socket setup to set_socket(), called before the uid/gid change. 1999-04-03 11:19:07 +08:00			`override.`
			`.TP`
Modify slapd set user/group support to use -u/-g instead -U/-G. Moved -u (udp) to -c (connectionless). Connectionless is depreciated and undocumented. Added tests for set{,e}{u,g}id to configure. Use existance of setuid/setgid to enable feature. Use seteuid/setegid only if they exist. Fixed minor minor leak of username/groupname if specificied more than once. (This should actually be an error) 1999-04-21 08:40:20 +08:00			`.BI \-g " group"`
Add -U and -G options to set user and group id. Move socket setup to set_socket(), called before the uid/gid change. 1999-04-03 11:19:07 +08:00			`.B slapd`
			`will run with the specified group name or id.`
			`.LP`
			`Note that on some systems, running as a non-privileged user will prevent`
			`passwd back-ends from accessing the encrypted passwords. Note also that`
			`any shell back-ends will run as the specified non-privileged user.`
Initial revision 1998-08-09 08:43:13 +08:00			`.SH EXAMPLES`
			`To start`
			`.I slapd`
			`and have it fork and detach from the terminal and start serving`
			`the LDAP databases defined in the default config file, just type:`
			`.LP`
			`.nf`
			`.ft tt`
Modified build environment to correctly support bin,sbin,libexec,etc and setting of variables from Make-platform with defaults in Make-common. 1998-08-20 02:19:39 +08:00			`LIBEXECDIR/slapd`
Initial revision 1998-08-09 08:43:13 +08:00			`.ft`
			`.fi`
			`.LP`
			`To start`
			`.B slapd`
			`with an alternate configuration file, and turn`
			`on voluminous debugging which will be printed on standard error, type:`
			`.LP`
			`.nf`
			`.ft tt`
Added LIBEXECDIR, SBINDIR and patched install rules and files as needed. 1998-08-19 10:38:35 +08:00			`LIBEXECDIR/slapd -f ETCDIR/slapd.conf -d 255`
Initial revision 1998-08-09 08:43:13 +08:00			`.ft`
			`.fi`
			`.LP`
			`.SH "SEE ALSO"`
			`.BR ldap (3),`
			`.BR slapd.conf (5),`
			`.BR slurpd (8)`
			`.LP`
			`"The SLAPD and SLURPD Administrator's Guide"`
			`.SH BUGS`
Remove MODRDN bug from Bugs Insert reference to ITS webpage 1999-09-20 01:57:16 +08:00			`See http://www.openldap.org/its/`
merged with autoconf branch 1998-10-25 09:41:42 +08:00			`.SH ACKNOWLEDGEMENTS`
			`.B OpenLDAP`
			`is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).`
			`.B OpenLDAP`
			`is derived from University of Michigan LDAP 3.3 Release.`