X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;ds=sidebyside;f=README;h=7ea871ebfe7ebb5e02d47198343d8ebaed9d1ff5;hb=0619caa5fb3b396814c284ac7d9a2714d84cd607;hp=02dc5def9a153c1b0b5809bc39fca6cce9cb7cba;hpb=806557a5ad59804ef3a44d5abfbe91d706b0791f;p=openldap diff --git a/README b/README index 02dc5def9a..7ea871ebfe 100644 --- a/README +++ b/README @@ -1,66 +1,92 @@ -OpenLDAP 1.0 README +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. - This is the OpenLDAP version 1.0 distribution. + This is 2.4 release, it includes significant changes from prior + releases. - 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. +REQUIRED SOFTWARE + 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 (required) + Cyrus SASL 2.1.21+ (recommended) + OpenSSL 0.9.7+ (recommended) + Reentrant POSIX REGEX software (required) + + 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. + + CLIENTS/CONTRIB ware: + Depends on package. See per package README. - For more information: - http://www.OpenLDAP.org/ 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 pretty - standard default configuration by typing the following commands - % make - this will copy Make-common.dist to Make-common. - Edit Make-common as desired. - % make - this will build the system - % su - # make install +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 + . - in this directory. This should produce something that basically - works. + The distribution also includes manual pages for most programs + and library APIs. See ldap(3) for details. - You will probably want to do a little configuration to suit your - site, though. There are two files you might want to edit: + The OpenLDAP website is available and contains the latest LDAP + news, releases announcements, pointers to other LDAP resources, + etc.. It is located at . - Make-common - contains default definitions for where things will be - installed, where to find various things, etc. These defaults - are used in absense of platform-specific defaults. You may - hardcode settings in Make-common if you desire. You will - need to edit this file to enable optional features. + The OpenLDAP Software FAQ is available at + . - build/*/Make-platform - contains platform-specific defaults. - 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 and + archives of the OpenLDAP-software and OpenLDAP-bugs mailing 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 . 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 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 mailing list + prior to submission, it is noted that contributions must be + submitted using the Issue Tracking System + 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 . -FEEDBACK / PROBLEM REPORTS / DISCUSSIONS +Copyright 1998-2011 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 +. +OpenLDAP is a registered trademark of the OpenLDAP Foundation.