]> git.sur5r.net Git - openldap/blob - README
Sync 2.4 guide with HEAD for 2.4.5
[openldap] / README
1 OpenLDAP 2.4 README
2     For a description of what this distribution contains, see the
3     ANNOUNCEMENT file in this directory.  For a description of
4     changes from previous releases, see the CHANGES file in this
5     directory.
6
7     This is 2.4 release, it includes significant changes from prior
8     releases.
9
10 REQUIRED SOFTWARE
11     Building OpenLDAP Software requires a number of software packages
12     to be preinstalled.  Additional information regarding prerequisite
13     software can be found in the OpenLDAP Administrator's Guide.
14
15     Base system (libraries and tools):
16         Standard C compiler (required)
17         Cyrus SASL 2.1.21+ (recommended)
18         OpenSSL 0.9.7+ (recommended)
19         POSIX REGEX software (required)
20
21     SLAPD:
22         BDB and HDB backends require Sleepycat Berkeley DB 4.2 or later
23
24     CLIENTS/CONTRIB ware:
25         Depends on package.  See per package README.
26
27
28 MAKING AND INSTALLING THE DISTRIBUTION
29     Please see the INSTALL file for basic instructions.  More
30     detailed instructions can be found in the OpenLDAP Admnistrator's
31     Guide (see DOCUMENTATION section).
32
33
34 DOCUMENTATION
35     The OpenLDAP Administrator's Guide is available in the
36     guide.html file in the doc/guide/admin directory.  The
37     guide and a number of other documents are available at
38     <http://www.openldap.org/doc/admin/guide.html>.
39
40     The distribution also includes manual pages for most programs
41     and library APIs.  See ldap(3) for details.
42
43     The OpenLDAP website is available and contains the latest LDAP
44     news, releases announcements, pointers to other LDAP resources,
45     etc..  It is located at <http://www.OpenLDAP.org/>.
46
47     The OpenLDAP Software FAQ is available at
48     <http://www.openldap.org/faq/>.
49
50
51 SUPPORT / FEEDBACK / PROBLEM REPORTS / DISCUSSIONS
52     OpenLDAP Software is user supported.  If you have problems, please
53     review the OpenLDAP FAQ <http://www.openldap.org/faq/> and
54     archives of the OpenLDAP-software and OpenLDAP-bugs mailing lists
55     <http://www.openldap.org/lists/>.  If you cannot find the answer,
56     please enquire on the OpenLDAP-software list.
57
58     Issues, such as bug reports, should be reported using our our
59     Issue Tracking System <http://www.OpenLDAP.org/its/>.  Do not
60     use this system for software enquiries.  Please direct these
61     to an appropriate mailing list.
62
63
64 CONTRIBUTING
65     See <http://www.openldap.org/devel/contributing.html> for
66     information regarding how to contribute code or documentation
67     to the OpenLDAP Project for inclusion in OpenLDAP Software.
68     While you are encouraged to coordinate and discuss the development
69     activities on the <openldap-devel@openldap.org> mailing list
70     prior to submission, it is noted that contributions must be
71     submitted using the Issue Tracking System
72     <http://www.openldap.org/its/> to be considered.
73
74 ---
75 $OpenLDAP$
76
77 This work is part of OpenLDAP Software <http://www.openldap.org/>.
78
79 Copyright 1998-2007 The OpenLDAP Foundation.
80 All rights reserved.
81
82 Redistribution and use in source and binary forms, with or without
83 modification, are permitted only as authorized by the OpenLDAP
84 Public License.
85
86 A copy of this license is available in the file LICENSE in the
87 top-level directory of the distribution or, alternatively, at
88 <http://www.OpenLDAP.org/license.html>.
89
90 OpenLDAP is a registered trademark of the OpenLDAP Foundation.