git.sur5r.net Git - openldap/blob - doc/guide/admin/install.sdf

   1 # $OpenLDAP$
   2 # Copyright 1999-2006 The OpenLDAP Foundation, All Rights Reserved.
   3 # COPYING RESTRICTIONS APPLY, see COPYRIGHT.
   4
   5 H1: Building and Installing OpenLDAP Software
   6
   7 This chapter details how to build and install the {{PRD:OpenLDAP}}
   8 Software package including {{slapd}}(8), the stand-alone LDAP daemon
   9 and {{slurpd}}(8), the stand-alone update replication daemon.
  10 Building and installing OpenLDAP Software requires several steps:
  11 installing prerequisite software, configuring OpenLDAP Software
  12 itself, making, and finally installing.  The following sections
  13 describe this process in detail.
  14
  15
  16 H2: Obtaining and Extracting the Software
  17
  18 You can obtain OpenLDAP Software from the project's download
  19 page at {{URL: http://www.openldap.org/software/download/}} or
  20 directly from the project's {{TERM:FTP}} service at
  21 {{URL: ftp://ftp.openldap.org/pub/OpenLDAP/}}.
  22
  23 The project makes available two series of packages for {{general
  24 use}}.  The project makes {{releases}} as new features and bug fixes
  25 come available.  Though the project takes steps to improve stablity
  26 of these releases, it is common for problems to arise only after
  27 {{release}}.  The {{stable}} release is the latest {{release}} which
  28 has demonstrated stability through general use.
  29
  30 Users of OpenLDAP Software can choose, depending on their desire
  31 for the {{latest features}} versus {{demonstrated stability}}, the
  32 most appropriate series to install.
  33
  34 After downloading OpenLDAP Software, you need to extract the
  35 distribution from the compressed archive file and change your working
  36 directory to the top directory of the distribution:
  37
  38 .{{EX:gunzip -c openldap-VERSION.tgz | tar xf -}}
  39 .{{EX:cd openldap-VERSION}}
  40
  41 You'll have to replace {{EX:VERSION}} with the version name of
  42 the release.
  43
  44 You should now review the {{F:COPYRIGHT}}, {{F:LICENSE}}, {{F:README}}
  45 and {{F:INSTALL}} documents provided with the distribution.  The
  46 {{F:COPYRIGHT}} and {{F:LICENSE}} provide information on acceptable
  47 use, copying, and limitation of warranty of OpenLDAP Software. The
  48 {{F:README}} and {{F:INSTALL}} documents provide detailed information
  49 on prerequisite software and installation procedures.
  50
  51
  52 H2: Prerequisite software
  53
  54 OpenLDAP Software relies upon a number of software packages distributed
  55 by third parties.  Depending on the features you intend to use, you
  56 may have to download and install a number of additional software
  57 packages.  This section details commonly needed third party software
  58 packages you might have to install.  However, for an up-to-date
  59 prerequisite information, the {{F:README}} document should be
  60 consulted.  Note that some of these third party packages may depend
  61 on additional software packages.  Install each package per the
  62 installation instructions provided with it.
  63
  64
  65 H3: {{TERM[expand]TLS}}
  66
  67 OpenLDAP clients and servers require installation of {{PRD:OpenSSL}}
  68 {{TERM:TLS}} libraries to provide {{TERM[expand]TLS}} services.  Though
  69 some operating systems may provide these libraries as part of the
  70 base system or as an optional software component, OpenSSL often
  71 requires separate installation.
  72
  73 OpenSSL is available from {{URL: http://www.openssl.org/}}.
  74
  75 OpenLDAP Software will not be fully LDAPv3 compliant unless OpenLDAP's
  76 {{EX:configure}} detects a usable OpenSSL installation.
  77
  78
  79 H3: {{TERM[expand]SASL}}
  80
  81 OpenLDAP clients and servers require installation of {{PRD:Cyrus SASL}}
  82 libraries to provide {{TERM[expand]SASL}} services.  Though
  83 some operating systems may provide this library as part of the
  84 base system or as an optional software component, Cyrus SASL
  85 often requires separate installation.
  86
  87 Cyrus SASL is available from
  88 {{URL:http://asg.web.cmu.edu/sasl/sasl-library.html}}.
  89 Cyrus SASL will make use of OpenSSL and Kerberos/GSSAPI libraries
  90 if preinstalled.
  91
  92 OpenLDAP Software will not be fully LDAPv3 compliant unless OpenLDAP's
  93 configure detects a usable Cyrus SASL installation.
  94
  95
  96 H3: {{TERM[expand]Kerberos}}
  97
  98 OpenLDAP clients and servers support {{TERM:Kerberos}} authentication
  99 services.  In particular, OpenLDAP supports the Kerberos V
 100 {{TERM:GSS-API}} {{TERM:SASL}} authentication mechanism known as
 101 the {{TERM:GSSAPI}} mechanism.  This feature requires, in addition to
 102 Cyrus SASL libraries, either {{PRD:Heimdal}} or {{PRD:MIT Kerberos}}
 103 V libraries.
 104
 105 Heimdal Kerberos is available from {{URL:http://www.pdc.kth.se/heimdal/}}.
 106 MIT Kerberos is available from {{URL:http://web.mit.edu/kerberos/www/}}.
 107
 108 Use of strong authentication services, such as those provided by
 109 Kerberos, is highly recommended.
 110
 111
 112
 113 H3: Database Software
 114
 115 OpenLDAP's {{slapd}}(8) {{TERM:BDB}} and {{TERM:HDB}} primary database backends
 116 require {{ORG[expand]Oracle}} {{PRD:Berkeley DB}}.
 117 If not available at configure time, you will not be able build
 118 {{slapd}}(8) with these primary database backends.
 119
 120 Your operating system may provide a supported version of
 121 {{PRD:Berkeley DB}} in the base system or as an optional
 122 software component.  If not, you'll have to obtain and
 123 install it yourself.
 124
 125 {{PRD:Berkeley DB}} is available from {{ORG[expand]Oracle}}'s Berkeley DB
 126 download page
 127 {{URL: http://www.oracle.com/technology/software/products/berkeley-db/index.html}}.  There are several versions available.  Generally, the most recent
 128 release (with published patches) is recommended.  This package is required
 129 if you wish to use the {{TERM:BDB}} or {{TERM:HDB}} database backends.
 130
 131
 132 H3: Threads
 133
 134 OpenLDAP is designed to take advantage of threads.  OpenLDAP
 135 supports POSIX {{pthreads}}, Mach {{CThreads}}, and a number of
 136 other varieties.  {{EX:configure}} will complain if it cannot
 137 find a suitable thread subsystem.   If this occurs, please
 138 consult the {{F:Software|Installation|Platform Hints}} section
 139 of the OpenLDAP FAQ {{URL: http://www.openldap.org/faq/}}.
 140
 141
 142 H3: TCP Wrappers
 143
 144 {{slapd}}(8) supports TCP Wrappers (IP level access control filters)
 145 if preinstalled.  Use of TCP Wrappers or other IP-level access
 146 filters (such as those provided by an IP-level firewall) is recommended
 147 for servers containing non-public information.
 148
 149
 150 H2: Running configure
 151
 152 Now you should probably run the {{EX:configure}} script with the
 153 {{EX:--help}} option.
 154 This will give you a list of options that you can change when building
 155 OpenLDAP.  Many of the features of OpenLDAP can be enabled or disabled
 156 using this method.
 157 !if 0
 158 Please see the appendix for a more detailed list of configure options,
 159 and their usage.
 160 !endif
 161 >       ./configure --help
 162
 163 The {{EX:configure}} script will also look at various environment variables
 164 for certain settings.  These environment variables include:
 165
 166 !block table; align=Center; coltags="EX,N"; title="Table 4.1: Environment Variables"
 167 Variable        Description
 168 CC              Specify alternative C Compiler
 169 CFLAGS          Specify additional compiler flags
 170 CPPFLAGS        Specify C Preprocessor flags
 171 LDFLAGS         Specify linker flags
 172 LIBS            Specify additional libraries
 173 !endblock
 174
 175 Now run the configure script with any desired configuration options or
 176 environment variables.
 177
 178 >       [[env] settings] ./configure [options]
 179
 180 As an example, let's assume that we want to install OpenLDAP with
 181 BDB backend and TCP Wrappers support.  By default, BDB
 182 is enabled and TCP Wrappers is not.  So, we just need to specify
 183 {{EX:--with-wrappers}} to include TCP Wrappers support:
 184
 185 >       ./configure --with-wrappers
 186
 187 However, this will fail to locate dependent software not
 188 installed in system directories.  For example, if TCP Wrappers
 189 headers and libraries are installed in {{F:/usr/local/include}}
 190 and {{F:/usr/local/lib}} respectively, the {{EX:configure}}
 191 script should be called as follows:
 192
 193 >       env CPPFLAGS="-I/usr/local/include" LDFLAGS="-L/usr/local/lib" \
 194 >               ./configure --with-wrappers
 195
 196 Note: Some shells, such as those derived from the Bourne {{sh}}(1),
 197 do not require use of the {{env}}(1) command.  In some cases, environmental
 198 variables have to be specified using alternative syntaxes.
 199
 200 The {{EX:configure}} script will normally auto-detect appropriate
 201 settings.  If you have problems at this stage, consult any platform
 202 specific hints and check your {{EX:configure}} options, if any.
 203
 204
 205 H2: Building the Software
 206
 207 Once you have run the {{EX:configure}} script the last line of output
 208 should be:
 209 >       Please "make depend" to build dependencies
 210
 211 If the last line of output does not match, {{EX:configure}} has failed,
 212 and you will need to review its output to determine what went wrong.
 213 You should not proceed until {{EX:configure}} completes successfully.
 214
 215 To build dependencies, run:
 216 >       make depend
 217
 218 Now build the software, this step will actually compile OpenLDAP.
 219 >       make
 220
 221 You should examine the output of this command carefully to make sure
 222 everything is built correctly. Note that this command builds the LDAP
 223 libraries and associated clients as well as {{slapd}}(8) and {{slurpd}}(8).
 224
 225
 226 H2: Testing the Software
 227
 228 Once the software has been properly configured and successfully
 229 made, you should run the test suite to verify the build.
 230
 231 >       make test
 232
 233 Tests which apply to your configuration will run and they should pass.
 234 Some tests, such as the replication test, may be skipped if not supported
 235 by your configuration.
 236
 237
 238 H2: Installing the Software
 239
 240 Once you have successfully tested the software, you are ready to
 241 install it.  You will need to have write permission to the installation
 242 directories you specified when you ran configure.  By default
 243 OpenLDAP Software is installed in {{F:/usr/local}}.  If you changed
 244 this setting with the {{EX:--prefix}} configure option, it will be
 245 installed in the location you provided.
 246
 247 Typically, the installation requires {{super-user}} privileges.
 248 From the top level OpenLDAP source directory, type:
 249
 250 >       su root -c 'make install'
 251
 252 and enter the appropriate password when requested.
 253
 254 You should examine the output of this command carefully to make sure
 255 everything is installed correctly. You will find the configuration files
 256 for {{slapd}}(8) in {{F:/usr/local/etc/openldap}} by default.  See the
 257 chapter {{SECT:Configuring slapd}} for additional information.
 258