]> git.sur5r.net Git - openldap/blob - INSTALL
Import latest SDF generated INSTALL. This version is quite lean.
[openldap] / INSTALL
1 Making and Installing the OpenLDAP Distribution
2 ===============================================
3
4 This file provides brief instructions on how to build and install
5 OpenLDAP on UNIX (and UNIX-like) system.  More detailed information
6 and instructions can be found in The OpenLDAP Administrator's Guide
7 (http://www.openldap.org/doc/admin/).
8
9 It is recommended that you read, or at least skim through, ALL of the
10 instructions in this file before attempting to build the software.
11
12 It is also recommended you review The OpenLDAP Administrator's Guide
13 (http://www.openldap.org/doc/admin/), the Frequently Asked Questions
14 (http://www.openldap.org/faq/) pages, in particular the Installation
15 section (http://www.openldap.org/faq/index.cgi?file=8) and Platform
16 Hints (http://www.openldap.org/faq/index.cgi?file=9) should be
17 examined.
18
19 Making and Installing the OpenLDAP Distribution
20 -----------------------------------------------
21
22 1.   Unpack the distribution and change directory:
23
24         % tar xfz openldap-VERSION.tgz
25         % cd openldap-VERSION
26
27      (replacing VERSION with the appropriate version string).  If you
28      are reading this file, you probably have already done this!
29
30 2.   Type:
31
32         % ./configure --help
33
34      to list available configuration options.   A description of these
35      options is provided in the 'CONFIGURE OPTIONS' section below.
36
37      The configure script uses environmental variables for determining
38      compiler/linker options including:
39
40         Variable        Description     Example
41         CC              C compiler      gcc
42         CFLAGS          C flags         -O -g
43         CPPFLAGS        cpp flags       -I/path/include -Ddef
44         LDFLAGS         ld flags        -L/usr/local/lib
45         LIBS            libraries       -llib
46         PATH            command path    /usr/local/bin:/usr/bin:/bin
47
48 3.   Configure the build system
49
50         % [env settings] ./configure [options]
51
52      If all goes well, the configure script with automatically detect
53      the appropriate settings.  However, you may need to specify
54      options and/or environment variables to obtain desired results.
55
56 4.   Build dependencies
57
58         % make depend
59
60 5.   Build the system
61
62         % make
63
64      If all goes well, the system will build as configured.  If not,
65      return to step 3 after reviewing the configuration settings.  You
66      may want to consult the Platform Hints subsection of the FAQ if
67      you have not done so already.
68
69 6.   Test the standalone system
70
71      This step requires the standalone LDAP server, slapd(8), with
72      LDBM support.
73
74         % make test
75
76      If all goes well, the system has been built as configured.  If
77      not, return to step 4 after reviewing your configuration
78      settings.  You may want to consult the Installation section of
79      the FAQ if you have not done so already.
80
81 7.   install the binaries and man pages.  You may need to be come the
82      super-user (e.g. root) to do this (depending on where you are
83      installing things):
84
85         % su root -c 'make install'
86
87 8.   That's it!
88
89 See the OpenLDAP Administrator's Guide and the manual pages for the
90 individual applications for configuration and use information. You may
91 also want to edit the configuration files used by the various
92 components.  These configuration files are located in the OpenLDAP
93 configuration directory (normally /usr/local/etc/openldap).
94
95         ldap.conf               client defaults
96         ldapfilter.conf         search filter configuration
97         ldapsearchprefs.conf    search object definitions
98         ldaptemplates.conf      display template definitions
99         slapd.conf              Standalone LDAP daemon
100         schema/*.schema         Schema Definitions
101
102 End of OpenLDAP INSTALL file.
103
104 $OpenLDAP: pkg/openldap-guide/release/install.sdf,v 1.12 2000/09/09
105 21:16:09 kurt Exp $
106