]> git.sur5r.net Git - openldap/blob - doc/man/man8/slapd.8
4c33418c59f657656d70fe27d61645f712279d06
[openldap] / 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 [\-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 \-l " syslog\-local\-user"
77 Selects the local user of the
78 .BR syslog (8)
79 facility. Values can be 
80 .BR LOCAL0 , 
81 .BR LOCAL1 , 
82 and so on, up to 
83 .BR LOCAL7 . 
84 The default is
85 .BR LOCAL4 .
86 However, this option is only permitted on systems that support
87 local users with the 
88 .BR syslog (8)
89 facility.
90 .TP
91 .BI \-f " slapd\-config\-file"
92 Specifies the slapd configuration file. The default is
93 .BR ETCDIR/slapd.conf .
94 .TP
95 .BI \-h " URLlist"
96 .B slapd
97 will serve
98 .B ldap:///
99 (LDAP over TCP on all interfaces on default LDAP port).  As such,
100 it will bind to INADDR_ANY, port 389.
101 The
102 .B \-h
103 option may be used to specify LDAP (and LDAPS) URLs to serve.
104 For example, if slapd is given
105 .B \-h " ldap://127.0.0.1:9009/ ldaps:///", 
106 It will bind 127.0.0.1:9009 for LDAP and INADDR_ANY:636 for LDAP over TLS.
107 A space separated list of URLs is expected.  The URLS should be of
108 LDAP (ldap://) or, if supported, LDAP over TLS (ldaps://) type without
109 a DN or other optional parameters.  Hosts may be specified in either
110 Internet '.' format (preferred) or by name.  Ports, if specfied,
111 must be numeric.
112 .TP
113 .BI \-u " user"
114 .B slapd
115 will run slapd with the specified user name or id, and that user's
116 supplementary group access list as set with initgroups(3).  The group ID
117 is also changed to this user's gid, unless the -g option is used to
118 override.
119 .TP
120 .BI \-g " group"
121 .B slapd
122 will run with the specified group name or id.
123 .LP
124 Note that on some systems, running as a non-privileged user will prevent
125 passwd back-ends from accessing the encrypted passwords.  Note also that
126 any shell back-ends will run as the specified non-privileged user.
127 .SH EXAMPLES
128 To start 
129 .I slapd
130 and have it fork and detach from the terminal and start serving
131 the LDAP databases defined in the default config file, just type:
132 .LP
133 .nf
134 .ft tt
135         LIBEXECDIR/slapd
136 .ft
137 .fi
138 .LP
139 To start 
140 .B slapd
141 with an alternate configuration file, and turn
142 on voluminous debugging which will be printed on standard error, type:
143 .LP
144 .nf
145 .ft tt
146         LIBEXECDIR/slapd -f ETCDIR/slapd.conf -d 255
147 .ft
148 .fi
149 .LP
150 .SH "SEE ALSO"
151 .BR ldap (3),
152 .BR slapd.conf (5),
153 .BR slurpd (8)
154 .LP
155 "The SLAPD and SLURPD Administrator's Guide"
156 .SH BUGS
157 See http://www.openldap.org/its/
158 .SH ACKNOWLEDGEMENTS
159 .B      OpenLDAP
160 is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
161 .B      OpenLDAP
162 is derived from University of Michigan LDAP 3.3 Release.