-OpenLDAP Devel README
- OpenLDAP -devel is for the development of OpenLDAP. As such,
- it changes often. These changes include changes in functionality
- and unproven bug fixes. Many of these changes will cause
- previous working programs to fail.
+OpenLDAP 2.4 README
+ 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.
- Client developers seeking a stable development platform
- should use -stable.
-
-OpenLDAP 1.0 README
-
- This is the OpenLDAP version 1.0 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 an
- install the distribution, see the INSTALL file in this directory.
-
- For more information:
- http://www.OpenLDAP.org/
+ This is 2.4 release, it includes significant changes from prior
+ releases.
REQUIRED SOFTWARE
- Build OpenLDAP requires the following software components:
+ Building OpenLDAP Software 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, headers, and libraries
- POSIX REGEX headers and libraries
+ Base system (libraries and tools):
+ Standard C compiler (required)
+ Cyrus SASL 2.1.21+ (recommended)
+ OpenSSL 0.9.7+ (recommended)
+ Reentrant POSIX REGEX software (required)
- SLAPD:
- LDBM compatible datastore
- (Berkeley DB, Sleepycat DB2, or GDBM)
- SLURPD:
- LTHREAD compatible thread package
- (POSIX pthreads, MIT pthreads, Mach Cthreads or Sun LWP)
+ SLAPD:
+ BDB and HDB backends require Oracle Berkeley DB 4.4 - 4.8,
+ or 5.0 - 5.1. It is highly recommended to apply the
+ patches from Oracle for a given release.
- LDAPD:
- ISODE compatible ldap distribution
+ CLIENTS/CONTRIB ware:
+ Depends on package. See per package README.
- CLIENTS/CONTRIBware:
- Depends on package. See per package READMEs.
-
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).
- You should be able to make and install the distribution with a
- default configuration by typing the following commands:
- % ./configure --help
- This will list the available options.
- The configure script will also use your environmental
- variables for determining compiler/linker options.
- These environment variables are used:
- CC C compiler (cc, ecgs)
- CFLAGS C Flags (-ansi)
- CPPFLAGS CPP Flags (-I -D)
- LDFLAGS LDFLAGS (-L -l)
-
- % [env settings] ./configure [options]
- this will configure the build system
-
- % make depend
- this will create dependency information
+DOCUMENTATION
+ The OpenLDAP Administrator's Guide is available in the
+ guide.html file in the doc/guide/admin directory. The
+ guide and a number of other documents are available at
+ <http://www.openldap.org/doc/admin/guide.html>.
- % make
- this will build the system
+ The distribution also includes manual pages for most programs
+ and library APIs. See ldap(3) for details.
- % su
- # make install
+ 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/>.
- in this directory. This should produce something that basically
- works. You can "cd tests; make" to verify the build.
+ The OpenLDAP Software FAQ is available at
+ <http://www.openldap.org/faq/>.
- You will probably want to do a little configuration to suit your
- site, though. There are one file you might want to edit:
- include/ldapconfig.h.edit
- This file contains #defines used by many parts of the
- distribution. You'll at least want to change DEFAULT_BASE.
+SUPPORT / FEEDBACK / PROBLEM REPORTS / DISCUSSIONS
+ OpenLDAP Software is user supported. If you have problems, please
+ review the OpenLDAP FAQ <http://www.openldap.org/faq/> and
+ archives of the OpenLDAP-software and OpenLDAP-bugs mailing lists
+ <http://www.openldap.org/lists/>. If you cannot find the answer,
+ please enquire on the OpenLDAP-software list.
- See the INSTALL file in this directory for more information.
+ Issues, such as bug reports, should be reported using our
+ Issue Tracking System <http://www.OpenLDAP.org/its/>. Do not
+ use this system for software enquiries. Please direct these
+ to an appropriate mailing list.
-DOCUMENTATION
- There are man pages for most programs in the distribution and
- routines in the various libraries. See ldap(3) for details.
+CONTRIBUTING
+ See <http://www.openldap.org/devel/contributing.html> for
+ information regarding how to contribute code or documentation
+ to the OpenLDAP Project for inclusion in OpenLDAP Software.
+ While you are encouraged to coordinate and discuss the development
+ activities on the <openldap-devel@openldap.org> mailing list
+ prior to submission, it is noted that contributions must be
+ submitted using the Issue Tracking System
+ <http://www.openldap.org/its/> to be considered.
- There is an OpenLDAP homepage available that contains the latest
- LDAP news, releases announcements, pointers to other LDAP resources,
- etc. You can access it at this URL:
+---
+$OpenLDAP$
- http://www.OpenLDAP.org/
+This work is part of OpenLDAP Software <http://www.openldap.org/>.
-FEEDBACK / PROBLEM REPORTS / DISCUSSIONS
+Copyright 1998-2016 The OpenLDAP Foundation.
+All rights reserved.
- We would appreciate any feedback you can provide. If you have
- problems, report them to this address:
+Redistribution and use in source and binary forms, with or without
+modification, are permitted only as authorized by the OpenLDAP
+Public License.
- OpenLDAP-bugs@OpenLDAP.org
+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>.
+OpenLDAP is a registered trademark of the OpenLDAP Foundation.