]> git.sur5r.net Git - openldap/blobdiff - doc/guide/admin/install.sdf
Scale image
[openldap] / doc / guide / admin / install.sdf
index 107066148e46cc740aed2898c3e99369e6fca2ec..92d0a902c9fb1dcccd33ca50c06b83510e85a48e 100644 (file)
@@ -11,17 +11,19 @@ Building and installing OpenLDAP requires several steps: installing
 prerequisite software, configuring OpenLDAP itself, making, and finally
 installing.  The following sections describe this process in detail.
 
-In case you haven't already obtained OpenLDAP it is available at the following
-location: {{URL: ftp://ftp.openldap.org/pub/OpenLDAP/openldap-release.tgz}}
+In case you haven't already obtained OpenLDAP it is available at
+the following location:
+{{URL: ftp://ftp.openldap.org/pub/OpenLDAP/openldap-release.tgz}}.
 
 The {{ORG[expand]OLP}} also maintains an extensive site
 ({{URL:http://www.OpenLDAP.org/}}) on the World Wide Web.  The site
 makes available a number of resources which you may utilize to
 properly install OpenLDAP Software.  This includes:
 
-!block table; align=Center; coltags="N,URL"
+!block table; align=Center; coltags="N,URL"; \
+       title="Table 4.1: Other OpenLDAP resources"
 Resource                       URL
-Documentation Catalog          http://www.OpenLDAP.org/doc/
+Document Catalog               http://www.OpenLDAP.org/doc/
 Frequently Asked Questions     http://www.OpenLDAP.org/faq/
 Issue Tracking System          http://www.OpenLDAP.org/its/
 Mailing Lists                  http://www.OpenLDAP.org/lists/
@@ -31,13 +33,14 @@ Support Page                        http://www.OpenLDAP.org/support/
  
 H2: Prerequisite software
 
-OpenLDAP relies a number of software packages distributed by third
-parties.  Depending on the features you intend to use, you may have
-to download and install a number of additional software packages.
-This section details commonly needed third party software packages
-you might have to install.  Note that some of these third party
-packages may depend on additional software packages.  Install each
-package per installation instructions provided with it.
+OpenLDAP Software relies upon a number of software packages distributed
+by third parties.  Depending on the features you intend to use,
+you may have to download and install a number of additional
+software packages.  This section details commonly needed third party
+software packages you might have to install.  Note that some of
+these third party packages may depend on additional software
+packages.  Install each package per installation instructions
+provided with it.
 
 H3: {{TERM[expand]TLS}}
 
@@ -52,15 +55,16 @@ OpenSSL is available from {{URL: http://www.openssl.org/}}.
 OpenLDAP will not be fully LDAPv3 compliant unless OpenLDAP's
 {{EX:configure}} detects a usable OpenSSL installation.
 
+
 H3: Kerberos Authentication Services
 
-OpenLDAP clients and servers support Kerberos based authentication
+OpenLDAP clients and servers support Kerberos-based authentication
 services.
-In particular, OpenLDAP supports {{TERM:SASL}}/{{TERM:GSSAPI}} based
-authentication using either {{PRD:Heimdal}} or {{PRD:MIT Kerberos}}
-V packages.
-If you desire to use Kerberos based authentication, you should
-install either Heimdal or MIT Kerberos V.
+In particular, OpenLDAP supports {{TERM:SASL}}/{{TERM:GSSAPI}}
+authentication mechanism using either {{PRD:Heimdal}} or
+{{PRD:MIT Kerberos}} V packages.
+If you desire to use Kerberos-based SASL/GSSAPI authentication,
+you should install either Heimdal or MIT Kerberos V.
 
 Heimdal Kerberos is available from {{URL:http://www.pdc.kth.se/heimdal/}}.
 MIT Kerberos is available from {{URL:http://web.mit.edu/kerberos/www/}}.
@@ -68,21 +72,24 @@ MIT Kerberos is available from {{URL:http://web.mit.edu/kerberos/www/}}.
 Use of strong authentication services, such as those provided by
 Kerberos, is highly recommended.
 
+
 H3: {{TERM[expand]SASL}}
 
-OpenLDAP clients and servers require installation of {{PRD:Cyrus}}
-SASL libraries to provide {{TERM[expand]SASL}} services.  Though
+OpenLDAP clients and servers require installation of {{PRD:Cyrus}}'s
+{{PRD:SASL}} libraries to provide {{TERM[expand]SASL}} services.  Though
 some operating systems may provide this library as part of the
 base system or as an optional software component, Cyrus SASL
 often requires separate installation.
 
-Cyrus SASL is available from {{URL:http://asg.cmu.edu/cyrus/sasl/}}.
+Cyrus SASL is available from
+{{URL:http://asg.web.cmu.edu/sasl/sasl-library.html}}.
 Cyrus SASL will make use of OpenSSL and Kerberos/GSSAPI libraries
 if preinstalled.
 
 OpenLDAP will not be fully LDAPv3 compliant unless OpenLDAP's
 configure detects a usable Cyrus SASL installation.
 
+
 H3: Database software
 
 OpenLDAP's {{slapd}}(8) primary database backend, {{TERM:LDBM}},
@@ -105,6 +112,7 @@ the latest release, version 3.1, is recommended.
 {{URL: ftp://ftp.gnu.org/pub/gnu/gdbm/}}.
 At the time of this writing, version 1.8 is the latest release.
 
+
 H3: Threads
 
 OpenLDAP is designed to take advantage of threads.  OpenLDAP
@@ -114,6 +122,7 @@ find a suitable thread subsystem.   If this occurs, please
 consult the {{F:Software|Installation|Platform Hints}} section
 of the OpenLDAP FAQ {{URL: http://www.openldap.org/faq/}}.
 
+
 H3: TCP Wrappers
 
 {{slapd}}(8) supports TCP wrappers (IP level access control filters)
@@ -122,7 +131,7 @@ filters (such as those provided by a IP-level firewall) is recommended
 for servers containing non-public information.
 
 
-H2: Configuring OpenLDAP
+H2: Running configure
 
 If you haven't already done so, extra the distribution for the
 compressed archive file and change directory to the top of the
@@ -162,8 +171,10 @@ environment variables.
 
 >      [[env] settings] ./configure [options]
 
-As an example, lets assume that we want a copy of OpenLDAP configured to use the
-LDBM backend, and the shell backend.  The LDBM backend is turned on by default, so we don't need to do anything special to enable it.
+As an example, let's assume that we want a copy of OpenLDAP configured
+to use the LDBM backend, and the shell backend.  The LDBM backend
+is turned on by default, so we don't need to do anything special
+to enable it.
 
 Additionally, we've installed the BerkeleyDB database package.  
 {{EX:configure}} is smart enough to use BerkeleyDB automatically
@@ -190,6 +201,7 @@ The {{EX:configure}} script will normally auto-detect appropriate settings.
 If you have problems at this stage, consult any platform specific
 hints and check your {{EX:configure}} options if any.
 
+
 H2: Building the Software
 
 Once you have run the {{EX:configure}} script the last line of output
@@ -209,6 +221,7 @@ You should examine the output of this command carefully to make sure
 everything is built correctly. Note that this command builds the LDAP
 libraries and associated clients as well as {{slapd}}(8) and {{slurpd}}(8).
 
+
 H2: Testing the Software
 
 Once the software has been properly configured and successfully
@@ -218,6 +231,7 @@ made, you should run the test suite to verify the build.
 
 The test will run a number of tests.
 
+
 H2: Installing the Software
 
 One you have successfully tested the software, you are ready to install it.
@@ -234,6 +248,6 @@ source directory, type:
 
 You should examine the output of this command carefully to make sure
 everything is installed correctly. You will find the configuration files
-for slapd in {{F:/usr/local/etc/openldap}} by default.  See chapter 5 for more
-information on the configuration files.
+for slapd in {{F:/usr/local/etc/openldap}} by default.  See the
+{{SECT:The slapd Configuration File}} chapter for additional information.