X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=INSTALL;h=a6cbf4288625e0017a8a880ac4ee0dffc6068890;hb=fc9b1b7aca945e71af0b8e9cd1b84ce8730b1574;hp=6753e3c6bfc47cd8794156211551532a1365ddc5;hpb=37b4b3f6cc4bf34e1d3dec61e69914b9819d8894;p=openldap diff --git a/INSTALL b/INSTALL index 6753e3c6bf..a6cbf42886 100644 --- a/INSTALL +++ b/INSTALL @@ -1,144 +1,121 @@ -Making and Installing the Net Boolean OpenLDAP Distribution +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. If you are planning to run slapd, -you should read the "SLAPD and SLURPD Administrator's Guide", found in -the doc/guides/ directory at: - http://www.boolean.net/technology/ldap.html +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: +Making and Installing the OpenLDAP Distribution +----------------------------------------------- - % tar xfz ldap-stable.tgz - % cd ldap +1. Unpack the distribution and change directory: - If you are reading this file, you probably have already done this! + % tar xfz openldap-VERSION.tgz + % cd openldap-VERSION + (replacing VERSION with the appropriate version string). If you + are reading this file, you probably have already done this! - 2. Type: - % make Make-common +2. Type: - to copy Make-common.dist to Make.common. + % ./configure --help - 3. edit the files Make-common and include/ldapconfig.h.edit to configure - the software for your site (the files are well-commented): + to list available configuration options. - % vi Make-common - % vi include/ldapconfig.h.edit + Note also that the configure script uses environmental variables + for determining compiler/linker options including: - Note that you should NOT need to edit the Makefile located at the - top of the distribution. + 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 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. + See doc/install/configure for generic configure documentation. - 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. +3. Configure the build system: - 3. make the software: + % [env settings] ./configure [options] - % 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 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. +4. Build dependencies: - 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: + % make depend - % sh - $ make +5. Build the system: - 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: + % make - % make platform - % vi .make-platform - % make + 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. - 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: +6. Test the standalone system: - % cd build/platforms/sunos4-cc - % make + This step requires the standalone LDAP server, slapd(8), with + BDB, HDB, and/or LDBM support. - If you want to run some simple tests after the build is complete, you - can do this: + % make test - % make test + 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. - 4. install the binaries and man pages. You may need to be superuser to - do this (depending on where you are installing things): +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): - % su - # make install + % su root -c 'make install' - 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: +8. That's it. Enjoy! - 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 +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). - There are section 5 man pages for all of these files. + 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 $ -Building LDAP For More Than One Platform +This work is part of OpenLDAP Software . -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. +Copyright 1998-2004 The OpenLDAP Foundation. +All rights reserved. -Follow these steps for each different platform: +Redistribution and use in source and binary forms, with or without +modification, are permitted only as authorized by the OpenLDAP +Public License. - 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: +A copy of this license is available in the file LICENSE in the +top-level directory of the distribution or, alternatively, at +. - % cd build/platforms/sunos4-cc - % make links - - This will create a linked source area. - - - 2. move to the new directory and make as for a single platform. Follow steps - 1-4 above to accomplish this. For example: - - % cd obj-sunos4-cc - % make - - 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. - - -End of OpenLDAP INSTALL file. +OpenLDAP is a registered trademark of the OpenLDAP Foundation.