X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=INSTALL;h=7f9aced3afb3b2dbbc19c8efea19b754323738d0;hb=9f3f281df0d733b6a8ec90a76cc9c79096631b98;hp=fa2c404b7075fe31f826d67bffd237e5ecc2014d;hpb=377b46fc095714889a838d06dc7d96b2338594e5;p=openldap
diff --git a/INSTALL b/INSTALL
index fa2c404b70..7f9aced3af 100644
--- a/INSTALL
+++ b/INSTALL
@@ -1,104 +1,121 @@
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 ldap-stable.tgz
- % cd ldap
-
- If you are reading this file, you probably have already done this!
+Making and Installing the OpenLDAP Distribution
+-----------------------------------------------
- 2. Type:
- % ./configure --help
+1. Unpack the distribution and change directory:
- to list available configuration options.
+ % tar xfz openldap-VERSION.tgz
+ % cd openldap-VERSION
- The configure script will also use your environmental
- variables for determining compiler/linker options.
+ (replacing VERSION with the appropriate version string). If you
+ are reading this file, you probably have already done this!
- These environment variables are used:
- CC C Compiler (cc, ecgs)
- CFLAGS C Flags (-ansi)
- CPPFLAGS CPP Flags (-I/path/include -Ddef)
- LDFLAGS LDFLAGS (-L/path/lib -llib)
+2. Type:
- 3. edit the file include/ldapconfig.h.edit to configure
- the software for your site (the files are well-commented):
+ % ./configure --help
- % vi include/ldapconfig.h.edit
+ to list available configuration options.
- 4. Configure the build system
+ Note also that the configure script uses environmental variables
+ for determining compiler/linker options including:
- % [env settings] ./configure [options]
+ 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 all goes well, the configure script with auto-detect the
- appropriate settings. Use configure enable/with options and/or
- environment variables to obtain desired results.
+ See doc/install/configure for generic configure documentation.
- 5. Build dependencies
+3. Configure the build system:
- % make depend
+ % [env settings] ./configure [options]
- 6. Build the system
+ 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.
- % make
+4. Build dependencies:
- If all goes well, the system will build as configured. If not,
- return to step 4 after reviewing the enable/with options settings.
-
- 7. install the binaries and man pages. You may need to be superuser to
- do this (depending on where you are installing things):
+ % make depend
- % su
- # make install
+5. Build the system:
- 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:
+ % make
- 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
+ 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.
- There are section 5 man pages for all of these files.
+6. Test the standalone system:
+ This step requires the standalone LDAP server, slapd(8), with
+ BDB or HDB support.
-Building LDAP For More Than One Platform
+ % make test
-It is now possible to build LDAP for more than one platform from the same
-source tree. This is accomplished by using make(1) VPATH support. If
-your make(1) program is old and doesn't have VPATH support, install GNU
-Make.
+ 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.
-Follow these steps for each different platform:
+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):
- 1. Create a directory for the platform object files.
+ % su root -c 'make install'
- % mkdir obj-platform
+8. That's it. Enjoy!
- 2. Change your working directory to the platform object directory.
+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).
- % cd obj-platform
+ ldap.conf client defaults
+ slapd.conf Standalone LDAP daemon
+ schema/*.schema Schema Definitions
- 3. Configure the build system
+---
+$OpenLDAP: pkg/openldap-guide/release/install.sdf,v 1.16 2002/02/18
+17:09:26 kurt Exp $
- % [env settings] ../configure --src-dir=.. [options]
+This work is part of OpenLDAP Software .
- ( replace ".." with the appropriate path )
+Copyright 1998-2007 The OpenLDAP Foundation.
+All rights reserved.
- 4. Continue as above (starting at step 6).
+Redistribution and use in source and binary forms, with or without
+modification, are permitted only as authorized by the OpenLDAP
+Public License.
- Note: make depend in VPATH environment is not yet supported.
+A copy of this license is available in the file LICENSE in the
+top-level directory of the distribution or, alternatively, at
+.
-End of OpenLDAP INSTALL file.
+OpenLDAP is a registered trademark of the OpenLDAP Foundation.