# $OpenLDAP$
-# Copyright 1999-2001, The OpenLDAP Foundation, All Rights Reserved.
+# Copyright 1999-2007 The OpenLDAP Foundation, All Rights Reserved.
# COPYING RESTRICTIONS APPLY, see COPYRIGHT.
H1: A Quick-Start Guide
-The following is a quick start guide to OpenLDAP 2.1 software,
-including the stand-alone LDAP daemon, {{slapd}}(8).
+The following is a quick start guide to [[DOC_NAME]],
+including the Standalone {{TERM:LDAP}} Daemon, {{slapd}}(8).
-It is meant to step you through the basic steps needed to install
-and configure OpenLDAP software. It should be used in conjunction
-with the other chapters of this document, manual pages, and
-other materials provided with the distribution (e.g. the {{F:INSTALL}}
-document) or on the OpenLDAP web site (in particular, the
-OpenLDAP Software FAQ).
+It is meant to walk you through the basic steps needed to install
+and configure {{PRD:OpenLDAP Software}}. It should be used in
+conjunction with the other chapters of this document, manual pages,
+and other materials provided with the distribution (e.g. the
+{{F:INSTALL}} document) or on the {{PRD:OpenLDAP}} web site
+({{URL: http://www.OpenLDAP.org}}), in particular the OpenLDAP
+Software {{TERM:FAQ}} ({{URL: http://www.OpenLDAP.org/faq/?file=2}}).
-If you intend to run OpenLDAP seriously, you should review all
-of this document before attempting to install the software.
+If you intend to run OpenLDAP Software seriously, you should review
+all of this document before attempting to install the software.
Note: This quick start guide does not use strong authentication
nor any integrity or confidential protection services. These
-services are described in other chapters of the OpenLDAP Administrator's
-Guide.
+services are described in other chapters of the
+OpenLDAP Administrator's Guide.
.{{S: }}
^{{B: Get the software}}
. You can obtain a copy of the software by following the
-instructions on the OpenLDAP download
-page ({{URL: http://www.openldap.org/software/download/}}).
-It is recommended that new users start with the (latest)
-{{release}}.
+instructions on the OpenLDAP Software download page
+({{URL: http://www.openldap.org/software/download/}}). It is
+recommended that new users start with the latest {{release}}.
.{{S: }}
+{{B: Unpack the distribution}}
-.Pick a directory for the LDAP source to live under, change
+.Pick a directory for the source to live under, change
directory to there, and unpack the distribution using the
following commands:
{{F:README}} and {{F:INSTALL}} documents provided with the distribution.
The {{F:COPYRIGHT}} and {{F:LICENSE}} provide information on
acceptable use, copying, and limitation of warranty of OpenLDAP
-software.
+Software.
.{{S: }}
. You should also review other chapters of this document.
+{{B: Run {{EX:configure}}}}
. You will need to run the provided {{EX:configure}} script to
-{{configure}} to the distribution for building on your system. The
+{{configure}} the distribution for building on your system. The
{{EX:configure}} script accepts many command line options that enable or
disable optional software features. Usually the defaults are okay,
but you may want to change them. To get a complete list of options
..{{EX:./configure --help}}
-. However, given that you using this guide, we'll assume you'll
-are brave enough to just let {{EX:configure}} to determine
+. However, given that you are using this guide, we'll assume you
+are brave enough to just let {{EX:configure}} determine
what's best:
..{{EX:./configure}}
. Assuming {{EX:configure}} doesn't dislike your system, you can
proceed with building the software. If {{EX:configure}} did
-complain, well, you'll likely need to go to the FAQ Installation
-Section ({{URL:http://www.openldap.org/faq/}} and/or actually
-read the {{SECT:Building and Installing OpenLDAP Software}}
+complain, well, you'll likely need to go to the Software FAQ
+{{Installation}} section ({{URL:http://www.openldap.org/faq/?file=8}})
+and/or actually read the {{SECT:Building and Installing OpenLDAP Software}}
chapter of this document.
.{{S: }}
+{{B:Install the software}}.
-. You are now ready to install the software, this usually requires
-{{super-user}} privledges:
+. You are now ready to install the software; this usually requires
+{{super-user}} privileges:
..{{EX:su root -c 'make install'}}
. Use your favorite editor to edit the provided {{slapd.conf}}(5)
example (usually installed as {{F:/usr/local/etc/openldap/slapd.conf}})
-to contain an BDB database definition of the form:
+to contain a BDB database definition of the form:
..{{EX:database bdb}}
..{{EX:suffix "dc=<MY-DOMAIN>,dc=<COM>"}}
..{{EX:directory /usr/local/var/openldap-data}}
. Details regarding configuring {{slapd}}(8) can be found
-in the {{slapd.conf}}(5) manual page and the
-{{SECT:The slapd Configuration File}} chapter of this
-document.
-
-Note: the directory specified must exist prior to starting slapd(8).
+in the {{slapd.conf}}(5) manual page and the {{SECT:The slapd
+Configuration File}} chapter of this document. Note that the
+specified directory must exist prior to starting {{slapd}}(8).
.{{S: }}
+{{B:Start SLAPD}}.
-. You are now ready to start the stand-alone LDAP server, slapd(8),
+. You are now ready to start the Standalone LDAP Daemon, {{slapd}}(8),
by running the command:
..{{EX:su root -c /usr/local/libexec/slapd}}
. To check to see if the server is running and configured correctly,
you can run a search against it with {{ldapsearch}}(1). By default,
-ldapsearch is installed as {{F:/usr/local/bin/ldapsearch}}:
+{{ldapsearch}} is installed as {{F:/usr/local/bin/ldapsearch}}:
..{{EX:ldapsearch -x -b '' -s base '(objectclass=*)' namingContexts}}
+{{B:Add initial entries to your directory}}.
. You can use {{ldapadd}}(1) to add entries to your LDAP directory.
-{{ldapadd}} expects input in LDIF form. We'll do it in two steps:
+{{ldapadd}} expects input in {{TERM:LDIF}} form. We'll do it in two
+steps:
^^ create an LDIF file
++ run ldapadd
..{{EX:objectclass: organizationalRole}}
..{{EX:cn: Manager}}
-. Be sure to replace {{EX:<MY-DOMAIN>}} and {{EX:<COM>}} with the appropriate domain
-components of your domain name. {{EX:<MY ORGANIZATION>}} should be replaced
-with the name of your organization. If you cut and paste, be sure
-to trim any leading and trailing whitespace from the example.
+. Be sure to replace {{EX:<MY-DOMAIN>}} and {{EX:<COM>}} with the
+appropriate domain components of your domain name. {{EX:<MY
+ORGANIZATION>}} should be replaced with the name of your organization.
+When you cut and paste, be sure to trim any leading and trailing
+whitespace from the example.
..{{EX:dn: dc=example,dc=com}}
..{{EX:objectclass: dcObject}}
. where {{F:example.ldif}} is the file you created above.
..{{EX: }}
-. Additional informaton regarding directory creation can be found
+. Additional information regarding directory creation can be found
in the {{SECT:Database Creation and Maintenance Tools}} chapter of
this document.
You are now ready to add more entries using {{ldapadd}}(1) or
another LDAP client, experiment with various configuration options,
-backend arrangements, etc.
+backend arrangements, etc..
Note that by default, the {{slapd}}(8) database grants {{read access
to everybody}} excepting the {{super-user}} (as specified by the
{{EX:rootdn}} configuration directive). It is highly recommended
that you establish controls to restrict access to authorized users.
-Access controls are discussed in the {{SECT:Access Control}} section
-of the {{SECT:The slapd Configuration File}} chapter. You are also
-encouraged to read {{SECT:Security Considerations}}, {{SECT:Using
-SASL}} and {{SECT:Using TLS}} sections.
+Access controls are discussed in the {{SECT:The access Configuration
+Directive}} section of {{SECT:The slapd Configuration File}} chapter.
+You are also encouraged to read the {{SECT:Security Considerations}},
+{{SECT:Using SASL}} and {{SECT:Using TLS}} sections.
The following chapters provide more detailed information on making,
installing, and running {{slapd}}(8).