Making and Installing the OpenLDAP Distribution
+===============================================
-** It is recommended that you read or at least skim through ALL of the
-** instructions in this file before attempting to build the software.
+This file provides brief instructions on how to build and install
+OpenLDAP on UNIX (and UNIX-like) system. More detailed information
+and instructions can be found in The OpenLDAP Administrator's Guide
+(available from http://www.openldap.org/doc/).
-If you want to build binaries for more than one platform from a single
-source tree, skip ahead to the "Building LDAP For More Than One Platform"
-section near the end of this file.
+It is recommended that you read, or at least skim through, ALL of the
+instructions in this file before attempting to build the software.
-If you simply want to build LDAP for a single machine platform, follow
-these steps:
+It is also recommended you review the Frequently Asked Questions
+(http://www.openldap.org/faq/) pages, in particular the Installation
+section (http://www.openldap.org/faq/index.cgi?file=8) and Platform
+Hints (http://www.openldap.org/faq/index.cgi?file=9) should be
+examined.
- 1. untar the distribution and cd to the top:
-
- % tar xfz openldap-VERSION.tgz
- % cd ldap
-
- If you are reading this file, you probably have already done this!
-
- 2. copy Make-common.dist or Make-common.gmake to Make.common
-
- 3. edit the files Make-common and include/ldapconfig.h.edit to configure
- the software for your site (the files are well-commented):
-
- % vi Make-common
- % vi include/ldapconfig.h.edit
+Making and Installing the OpenLDAP Distribution
+-----------------------------------------------
- Note that you should NOT need to edit the Makefile located at the
- top of the distribution.
+1. Unpack the distribution and change directory:
- If you just want to see if things will build, you can leave the
- configuration alone and change it later. You may want to consult
- the appropriate platform makefile (build/*/Make-platform) for
- platform-specific defaults.
+ % tar xfz openldap-VERSION.tgz
+ % cd openldap-VERSION
- If you have the ISODE package built and want to build the
- LDAP-to-X.500 server (ldapd), be sure to uncomment the appropriate
- lines near the end of the Make-common file. By default only the
- stand-alone server, LDAP libraries and client software are built.
+ (replacing VERSION with the appropriate version string). If you
+ are reading this file, you probably have already done this!
- 4. make the software:
+2. Type:
- % make
+ % ./configure --help
- If all goes well, then make will figure out what platform you are on,
- pick a compiler to use, construct Makefiles, and build everything.
- If you see a message like "unknown platform..." LDAP has probably not
- been set up to build on your machine. See the file build/PORTS for
- hints on what to do in that case.
+ to list available configuration options.
- Note that if your make does not use the Bourne (sh) shell by
- default when executing internal scripts (reportedly the case on SGI
- machines at least), you will need to run the make explicitly from
- within a Bourne shell. If you a syntax error such as "Missing ]"
- when you do the make under your usual shell, try this:
+ Note also that the configure script uses environmental variables
+ for determining compiler/linker options including:
- % sh
- $ make
+ Variable Description Example
+ CC C compiler gcc
+ CFLAGS C flags -O -g
+ CPPFLAGS cpp flags -I/path/include -DFOO=42
+ LDFLAGS ld flags -L/usr/local/lib
+ LIBS libraries -llib
+ PATH command path /usr/local/bin:/usr/bin:/bin
- If you don't like the some of the platform-specific options chosen
- by the automatic build process (such as the compiler to use, etc),
- you can intervene and edit them before anything is actually compiled
- by explicitly doing a "make platform" step, editing the .make-platform
- file (actually a link to the file to be edited), and then doing a
- regular make:
+ See doc/install/configure for generic configure documentation.
- % make platform
- % vi .make-platform
- % make
+3. Configure the build system:
- If you want to choose the build platform yourself from among those that
- the distribution supports, cd to the appropriate directory underneath
- build/platforms and make from there. For example, if you are on a
- machine running SunOS 4.1.4 and you want to force the use of the cc
- compiler, you would do this:
+ % [env settings] ./configure [options]
- % cd build/platforms/sunos4-cc
- % make
+ If all goes well, the configure script will automatically detect
+ the appropriate settings. If the configure script fails, you
+ should read the config.log file that it generated to see what it
+ was trying to do and exactly what failed. You may need to specify
+ additional options and/or environment variables besides those
+ listed above to obtain desired results, depending on your operating
+ system. The Platform Hints section of the FAQ provides help for
+ operating system related problems.
- If you want to run some simple tests after the build is complete, you
- can do this:
+4. Build dependencies:
- % make test
+ % make depend
- 5. install the binaries and man pages. You may need to be superuser to
- do this (depending on where you are installing things):
+5. Build the system:
- % su
- # make install
+ % make
- That's it! See the man pages for the individual clients for information
- on configuring and using them. Eventually you will probably want to
- edit the configuration files used by the various clients (installed in
- the LDAP etc directory). The files are:
+ If all goes well, the system will build as configured. If not,
+ return to step 3 after reviewing the configuration settings. You
+ may want to consult the Platform Hints subsection of the FAQ if
+ you have not done so already.
- ldapfilter.conf - search filter configuration
- ldapfriendly - mapping of X.500 names to human-friendly names
- ldapsearchprefs.conf - search object definitions
- ldaptemplates.conf - display template definitions
+6. Test the standalone system:
- There are section 5 man pages for all of these files.
+ This step requires the standalone LDAP server, slapd(8), with
+ BDB, HDB, and/or LDBM support.
+ % make test
-Building LDAP For More Than One Platform
+ If all goes well, the system has been built as configured. If
+ not, return to step 2 after reviewing your configuration
+ settings. You may want to consult the Installation section of
+ the FAQ if you have not done so already.
-It is now possible to build LDAP for more than one platform from the same
-source tree. This is accomplished by some rules in the Makefiles that
-create a shadow (linked) directory tree where the binaries are placed.
+7. Install the software. You may need to be come the super-user
+ (e.g. root) to do this (depending on where you are installing
+ things):
-Follow these steps for each different platform:
+ % su root -c 'make install'
- 1. move to the directory that matches the platform and compiler you
- want to build for and type make. The directories are all located
- underneath the build/platforms directory. If your platform is not
- there, you may need to do a port - see the build/PORTS file for
- more information. For a Sun running SunOS 4.1.4, you might do
- this:
+8. That's it. Enjoy!
- % cd build/platforms/sunos4-cc
- % make links
+See the OpenLDAP Administrator's Guide and the manual pages for the
+individual applications for configuration and use information. You may
+also want to edit the configuration files used by the various
+components. These configuration files are located in the OpenLDAP
+configuration directory (normally /usr/local/etc/openldap).
- This will create a linked source area.
+ ldap.conf client defaults
+ slapd.conf Standalone LDAP daemon
+ schema/*.schema Schema Definitions
+---
+$OpenLDAP: pkg/openldap-guide/release/install.sdf,v 1.16 2002/02/18
+17:09:26 kurt Exp $
- 2. move to the new directory and make as for a single platform. Follow steps
- 1-4 above to accomplish this. For example:
+This work is part of OpenLDAP Software <http://www.openldap.org/>.
- % cd obj-sunos4-cc
- % make
+Copyright 1998-2005 The OpenLDAP Foundation.
+All rights reserved.
- That's all there is to it. You can also create the linked source area(s)
- by just typing "make links" at the top of the distribution, in which case
- the Makefile will try to automatically determine the platform and
- compiler.
+Redistribution and use in source and binary forms, with or without
+modification, are permitted only as authorized by the OpenLDAP
+Public License.
+A copy of this license is available in the file LICENSE in the
+top-level directory of the distribution or, alternatively, at
+<http://www.OpenLDAP.org/license.html>.
-End of OpenLDAP INSTALL file.
+OpenLDAP is a registered trademark of the OpenLDAP Foundation.
projects / openldap / blobdiff