From: Kurt Zeilenga Date: Mon, 18 Feb 2002 18:11:16 +0000 (+0000) Subject: Update release documents for alpha X-Git-Tag: OPENLDAP_REL_ENG_2_1_ALPHA0~13 X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=172958eefa0c92e3ca152d768dc3d3edc98d12bb;p=openldap Update release documents for alpha --- diff --git a/INSTALL b/INSTALL index 958d72e704..2a88697926 100644 --- a/INSTALL +++ b/INSTALL @@ -1,136 +1,101 @@ -Making and Installing the U-M LDAP 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 within the 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. -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 +----------------------------------------------- - % zcat ldap-3.3.tar.Z | tar xf - - % cd ldap-3.3 +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. edit the files Make-common and include/ldapconfig.h.edit to configure - the software for your site (the files are well-commented): +2. Type: - % vi Make-common - % vi include/ldapconfig.h.edit + % ./configure --help - Note that you should NOT need to edit the Makefile located at the - top of the distribution. + to list available configuration options. - If you just want to see if things will build, you can leave the - configuration alone and change it later. + The configure script uses environmental variables for determining + compiler/linker options including: - 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. + Variable Description Example + CC C compiler gcc + CFLAGS C flags -O -g + CPPFLAGS cpp flags -I/path/include -Ddef + LDFLAGS ld flags -L/usr/local/lib + LIBS libraries -llib + PATH command path /usr/local/bin:/usr/bin:/bin - 3. make the software: +3. Configure the build system - % make + % [env settings] ./configure [options] - 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. + If all goes well, the configure script with automatically detect + the appropriate settings. However, you may need to specify + options and/or environment variables to obtain desired results. - 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: +4. Build dependencies - % sh - $ make + % make depend - 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: +5. Build the system - % make platform - % vi .make-platform - % make + % make - 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: + 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. - % cd build/platforms/sunos4-cc - % make +6. Test the standalone system - If you want to run some simple tests after the build is complete, you - can do this: + This step requires the standalone LDAP server, slapd(8), with + LDBM support. - % make test + % make test - 4. install the binaries and man pages. You may need to be superuser to - do this (depending on where you are installing things): + If all goes well, the system has been built as configured. If + not, return to step 4 after reviewing your configuration + settings. You may want to consult the Installation section of + the FAQ if you have not done so already. - % su - # make install +7. install the binaries and man pages. You may need to be come the + super-user (e.g. root) to do this (depending on where you are + installing things): - 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: + % su root -c 'make install' - 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 +8. That's it! - There are section 5 man pages for all of these files. +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). + ldap.conf client defaults + slapd.conf Standalone LDAP daemon + schema/*.schema Schema Definitions -Building LDAP For More Than One Platform +End of OpenLDAP INSTALL file. -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. +$OpenLDAP: pkg/openldap-guide/release/install.sdf,v 1.16 2002/02/18 +17:09:26 kurt Exp $ -Follow these steps for each different platform: - - 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: - - % 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 LDAP INSTALL file. diff --git a/README b/README index fb8dd8ab36..22004a802f 100644 --- a/README +++ b/README @@ -1,59 +1,70 @@ -UM-LDAP 3.3 README file +OpenLDAP 2.1 ALPHA README + + For a description of what this distribution contains, see the + ANNOUNCEMENT file in this directory. - This is the UM-LDAP version 3.3 distribution. For a description of - what this distribution contains, see the ANNOUNCEMENT file in this - directory. For a description of changes from previous releases, - see the CHANGES file in this directory. For a more detailed - description of how to make and install the distribution, see the - INSTALL file in this directory. For more information on making and - installing slapd, see the "SLAPD and SLURPD Administrator's Guide" - in the doc/guides/ directory. + This is a 2.1 alpha release. + It is NOT intended for general use. -MAKING AND INSTALLING THE DISTRIBUTION - You should be able to make and install the distribution with a pretty - standard default configuration by typing the following commands +REQUIRED SOFTWARE + Build OpenLDAP requires a number of software packages to be + preinstalled. Additional information regarding prerequisite + software can be found in the OpenLDAP Administrator's Guide. + + Base system (libraries and tools): + Standard C compiler (required) + Cyrus SASL 1.5 (recommended) + OpenSSL 0.9 (recommended) + POSIX REGEX software (required) - % make - % su - # make install + SLAPD: + LDBM compatible datastore (required) + [Sleepycat Berkeley DB 3.2 (recommended) or GDBM] - in this directory. This should produce something that basically - works. + SLURPD: + LTHREAD compatible thread package + [POSIX threads, Mach Cthreads, select others] - You will probably want to do a little configuration to suit your - site, though. There are two files you might want to edit: + CLIENTS/CONTRIB ware: + Depends on package. See per package README. - Make-common This file contains definitions for - where things will be installed, where - to find various things, etc. If you - want to build an ldap server, you'll - definitely need to edit this file - include/ldapconfig.h.edit This file contains #defines used - by many parts of the distribution. - You'll at least want to change - DEFAULT_BASE. +MAKING AND INSTALLING THE DISTRIBUTION + Please see the INSTALL file for basic instructions. More + detailed instructions can be found in the OpenLDAP + Admnistrator's Guide (see DOCUMENTATION section). - See the INSTALL file in this directory for more information. DOCUMENTATION + There are man pages for most programs in the distribution and + routines in the various libraries. See ldap(3) for details. - There are man pages for most programs in the distribution and - routines in the various libraries. See ldap(3) for details. + The OpenLDAP website is available and contains the latest LDAP + news, releases announcements, pointers to other LDAP resources, + etc.. It is located at: + http://www.OpenLDAP.org/ - There is a postscript version of an administrator's guide for - slapd in doc/guides/slapd.ps. + The OpenLDAP Administrator's Guide and other documentation + is available at: + http://www.openldap.org/doc/ - There is an LDAP homepage available that contains the latest - LDAP news, releases announcements, pointers to other LDAP resources, - etc. You can access it at this URL: + The OpenLDAP Software FAQ is available at: + http://www.openldap.org/faq/index.cgi - http://www.umich.edu/~rsug/ldap/ -FEEDBACK / PROBLEM REPORTS +SUPPORT / FEEDBACK / PROBLEM REPORTS / DISCUSSIONS + OpenLDAP is user supported. If you have problems, please + review the OpenLDAP FAQ and + archives of the OpenLDAP-software and OpenLDAP-bugs mailing + lists . If you cannot find + the answer, please enquire on the OpenLDAP-software list. - We would appreciate any feedback you can provide. If you have - problems, report them to this address: + Issues, such as bug reports, should be reported using our + our Issue Tracking System or + by sending mail to OpenLDAP-its@OpenLDAP.org. Do not use + this system for software enquiries. Please direct these + to an appropriate mailing list. - ldap-support@umich.edu +--- +$OpenLDAP$