2 # Copyright 1999-2014 The OpenLDAP Foundation, All Rights Reserved.
3 # COPYING RESTRICTIONS APPLY, see COPYRIGHT.
5 H1: A Quick-Start Guide
7 The following is a quick start guide to [[DOC_NAME]],
8 including the Standalone {{TERM:LDAP}} Daemon, {{slapd}}(8).
10 It is meant to walk you through the basic steps needed to install
11 and configure {{PRD:OpenLDAP Software}}. It should be used in
12 conjunction with the other chapters of this document, manual pages,
13 and other materials provided with the distribution (e.g. the
14 {{F:INSTALL}} document) or on the {{PRD:OpenLDAP}} web site
15 ({{URL: http://www.OpenLDAP.org}}), in particular the OpenLDAP
16 Software {{TERM:FAQ}} ({{URL: http://www.OpenLDAP.org/faq/?file=2}}).
18 If you intend to run OpenLDAP Software seriously, you should review
19 all of this document before attempting to install the software.
21 Note: This quick start guide does not use strong authentication
22 nor any integrity or confidential protection services. These
23 services are described in other chapters of the
24 OpenLDAP Administrator's Guide.
28 ^{{B: Get the software}}
30 . You can obtain a copy of the software by following the
31 instructions on the OpenLDAP Software download page
32 ({{URL: http://www.openldap.org/software/download/}}). It is
33 recommended that new users start with the latest {{release}}.
37 +{{B: Unpack the distribution}}
39 .Pick a directory for the source to live under, change
40 directory to there, and unpack the distribution using the
43 ..{{EX:gunzip -c openldap-VERSION.tgz | tar xvfB -}}
45 . then relocate yourself into the distribution directory:
47 ..{{EX:cd openldap-VERSION}}
49 . You'll have to replace {{F:VERSION}} with the version
54 +{{B: Review documentation}}
56 . You should now review the {{F:COPYRIGHT}}, {{F:LICENSE}},
57 {{F:README}} and {{F:INSTALL}} documents provided with the distribution.
58 The {{F:COPYRIGHT}} and {{F:LICENSE}} provide information on
59 acceptable use, copying, and limitation of warranty of OpenLDAP
63 . You should also review other chapters of this document.
64 In particular, the {{SECT:Building and Installing OpenLDAP Software}}
65 chapter of this document provides detailed information on prerequisite
66 software and installation procedures.
70 +{{B: Run {{EX:configure}}}}
72 . You will need to run the provided {{EX:configure}} script to
73 {{configure}} the distribution for building on your system. The
74 {{EX:configure}} script accepts many command line options that enable or
75 disable optional software features. Usually the defaults are okay,
76 but you may want to change them. To get a complete list of options
77 that {{EX:configure}} accepts, use the {{EX:--help}} option:
79 ..{{EX:./configure --help}}
81 . However, given that you are using this guide, we'll assume you
82 are brave enough to just let {{EX:configure}} determine
87 . Assuming {{EX:configure}} doesn't dislike your system, you can
88 proceed with building the software. If {{EX:configure}} did
89 complain, well, you'll likely need to go to the Software FAQ
90 {{Installation}} section ({{URL:http://www.openldap.org/faq/?file=8}})
91 and/or actually read the {{SECT:Building and Installing OpenLDAP Software}}
92 chapter of this document.
96 +{{B:Build the software}}.
98 . The next step is to build the software. This step has two
99 parts, first we construct dependencies and then we compile the
106 . Both makes should complete without error.
110 +{{B:Test the build}}.
112 . To ensure a correct build, you should run the test suite
113 (it only takes a few minutes):
117 . Tests which apply to your configuration will run and they
118 should pass. Some tests, such as the replication test, may
123 +{{B:Install the software}}.
125 . You are now ready to install the software; this usually requires
126 {{super-user}} privileges:
128 ..{{EX:su root -c 'make install'}}
130 . Everything should now be installed under {{F:/usr/local}} (or
131 whatever installation prefix was used by {{EX:configure}}).
134 +{{B:Edit the configuration file}}.
136 . Use your favorite editor to edit the provided {{slapd.ldif}}
137 example (usually installed as {{F:/usr/local/etc/openldap/slapd.ldif}})
138 to contain a MDB database definition of the form:
140 ..{{EX:dn: olcDatabase=mdb,cn=config}}
141 ..{{EX:objectClass: olcDatabaseConfig}}
142 ..{{EX:objectClass: olcMdbConfig}}
143 ..{{EX:olcDatabase: mdb}}
144 ..{{EX:OlcDbMaxSize: 1073741824}}
145 ..{{EX:olcSuffix: dc=<MY-DOMAIN>,dc=<COM>}}
146 ..{{EX:olcRootDN: cn=Manager,dc=<MY-DOMAIN>,dc=<COM>}}
147 ..{{EX:olcRootPW: secret}}
148 ..{{EX:olcDbDirectory: /usr/local/var/openldap-data}}
149 ..{{EX:olcDbIndex: objectClass eq}}
151 . Be sure to replace {{EX:<MY-DOMAIN>}} and {{EX:<COM>}} with
152 the appropriate domain components of your domain name. For
153 example, for {{EX:example.com}}, use:
155 ..{{EX:dn: olcDatabase=mdb,cn=config}}
156 ..{{EX:objectClass: olcDatabaseConfig}}
157 ..{{EX:objectClass: olcMdbConfig}}
158 ..{{EX:olcDatabase: mdb}}
159 ..{{EX:OlcDbMaxSize: 1073741824}}
160 ..{{EX:olcSuffix: dc=example,dc=com}}
161 ..{{EX:olcRootDN: cn=Manager,dc=example,dc=com}}
162 ..{{EX:olcRootPW: secret}}
163 ..{{EX:olcDbDirectory: /usr/local/var/openldap-data}}
164 ..{{EX:olcDbIndex: objectClass eq}}
166 .If your domain contains additional components, such as
167 {{EX:eng.uni.edu.eu}}, use:
169 ..{{EX:dn: olcDatabase=mdb,cn=config}}
170 ..{{EX:objectClass: olcDatabaseConfig}}
171 ..{{EX:objectClass: olcMdbConfig}}
172 ..{{EX:olcDatabase: mdb}}
173 ..{{EX:OlcDbMaxSize: 1073741824}}
174 ..{{EX:olcSuffix: dc=eng,dc=uni,dc=edu,dc=eu}}
175 ..{{EX:olcRootDN: cn=Manager,dc=eng,dc=uni,dc=edu,dc=eu}}
176 ..{{EX:olcRootPW: secret}}
177 ..{{EX:olcDbDirectory: /usr/local/var/openldap-data}}
178 ..{{EX:olcDbIndex: objectClass eq}}
180 . Details regarding configuring {{slapd}}(8) can be found
181 in the {{slapd-config}}(5) manual page and the {{SECT:Configuring
182 slapd}} chapter of this document. Note that the
183 specified olcDbDirectory must exist prior to starting {{slapd}}(8).
187 +{{B:Import the configuration database}}
188 . You are now ready to import your configration database for use by
189 {{slapd}}(8), by running the command:
191 ..{{EX: su root -c /usr/local/sbin/slapadd -F /usr/local/etc/cn=config -l /usr/local/etc/openldap/slapd.ldif}}
196 . You are now ready to start the Standalone LDAP Daemon, {{slapd}}(8),
197 by running the command:
199 ..{{EX:su root -c /usr/local/libexec/slapd -F /usr/local/etc/cn=config}}
202 . To check to see if the server is running and configured correctly,
203 you can run a search against it with {{ldapsearch}}(1). By default,
204 {{ldapsearch}} is installed as {{F:/usr/local/bin/ldapsearch}}:
206 ..{{EX:ldapsearch -x -b '' -s base '(objectclass=*)' namingContexts}}
208 . Note the use of single quotes around command parameters to prevent
209 special characters from being interpreted by the shell. This should return:
212 ..{{EX:namingContexts: dc=example,dc=com}}
214 . Details regarding running {{slapd}}(8) can be found
215 in the {{slapd}}(8) manual page and the
216 {{SECT:Running slapd}} chapter of this document.
220 +{{B:Add initial entries to your directory}}.
222 . You can use {{ldapadd}}(1) to add entries to your LDAP directory.
223 {{ldapadd}} expects input in {{TERM:LDIF}} form. We'll do it in two
226 ^^ create an LDIF file
229 . Use your favorite editor and create an LDIF file that contains:
231 ..{{EX:dn: dc=<MY-DOMAIN>,dc=<COM>}}
232 ..{{EX:objectclass: dcObject}}
233 ..{{EX:objectclass: organization}}
234 ..{{EX:o: <MY ORGANIZATION>}}
235 ..{{EX:dc: <MY-DOMAIN>}}
237 ..{{EX:dn: cn=Manager,dc=<MY-DOMAIN>,dc=<COM>}}
238 ..{{EX:objectclass: organizationalRole}}
241 . Be sure to replace {{EX:<MY-DOMAIN>}} and {{EX:<COM>}} with the
242 appropriate domain components of your domain name. {{EX:<MY
243 ORGANIZATION>}} should be replaced with the name of your organization.
244 When you cut and paste, be sure to trim any leading and trailing
245 whitespace from the example.
247 ..{{EX:dn: dc=example,dc=com}}
248 ..{{EX:objectclass: dcObject}}
249 ..{{EX:objectclass: organization}}
250 ..{{EX:o: Example Company}}
253 ..{{EX:dn: cn=Manager,dc=example,dc=com}}
254 ..{{EX:objectclass: organizationalRole}}
257 . Now, you may run {{ldapadd}}(1) to insert these entries into
260 ..{{EX:ldapadd -x -D "cn=Manager,dc=<MY-DOMAIN>,dc=<COM>" -W -f example.ldif}}
262 . Be sure to replace {{EX:<MY-DOMAIN>}} and {{EX:<COM>}} with the
263 appropriate domain components of your domain name. You will be
264 prompted for the "{{EX:secret}}" specified in {{F:slapd.conf}}.
265 For example, for {{EX:example.com}}, use:
267 ..{{EX:ldapadd -x -D "cn=Manager,dc=example,dc=com" -W -f example.ldif}}
269 . where {{F:example.ldif}} is the file you created above.
271 . Additional information regarding directory creation can be found
272 in the {{SECT:Database Creation and Maintenance Tools}} chapter of
276 +{{B:See if it works}}.
278 . Now we're ready to verify the added entries are in your directory.
279 You can use any LDAP client to do this, but our example uses the
280 {{ldapsearch}}(1) tool. Remember to replace {{EX:dc=example,dc=com}}
281 with the correct values for your site:
283 ..{{EX:ldapsearch -x -b 'dc=example,dc=com' '(objectclass=*)'}}
285 . This command will search for and retrieve every entry in the database.
287 You are now ready to add more entries using {{ldapadd}}(1) or
288 another LDAP client, experiment with various configuration options,
289 backend arrangements, etc..
291 Note that by default, the {{slapd}}(8) database grants {{read access
292 to everybody}} excepting the {{super-user}} (as specified by the
293 {{EX:rootdn}} configuration directive). It is highly recommended
294 that you establish controls to restrict access to authorized users.
295 Access controls are discussed in the {{SECT:Access Control}} chapter.
296 You are also encouraged to read the {{SECT:Security Considerations}},
297 {{SECT:Using SASL}} and {{SECT:Using TLS}} sections.
299 The following chapters provide more detailed information on making,
300 installing, and running {{slapd}}(8).