]> git.sur5r.net Git - openldap/blob - INSTALL
return to releng
[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 (available from http://www.openldap.org/doc/).
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 Frequently Asked Questions
13 (http://www.openldap.org/faq/) pages, in particular the Installation
14 section (http://www.openldap.org/faq/index.cgi?file=8) and Platform
15 Hints (http://www.openldap.org/faq/index.cgi?file=9) should be
16 examined.
17
18 Making and Installing the OpenLDAP Distribution
19 -----------------------------------------------
20
21 1.   Unpack the distribution and change directory:
22
23         % tar xfz openldap-VERSION.tgz
24         % cd openldap-VERSION
25
26      (replacing VERSION with the appropriate version string).  If you
27      are reading this file, you probably have already done this!
28
29 2.   Type:
30
31         % ./configure --help
32
33      to list available configuration options.
34
35      Note also that the configure script uses environmental variables
36      for determining compiler/linker options including:
37
38         Variable        Description     Example
39         CC              C compiler      gcc
40         CFLAGS          C flags         -O -g
41         CPPFLAGS        cpp flags       -I/path/include -DFOO=42
42         LDFLAGS         ld flags        -L/usr/local/lib
43         LIBS            libraries       -llib
44         PATH            command path    /usr/local/bin:/usr/bin:/bin
45
46      See doc/install/configure for generic configure documentation.
47
48 3.   Configure the build system:
49
50         % [env settings] ./configure [options]
51
52      If all goes well, the configure script will automatically detect
53      the appropriate settings.  If the configure script fails, you
54      should read the config.log file that it generated to see what it
55      was trying to do and exactly what failed.  You may need to specify
56      additional options and/or environment variables besides those
57      listed above to obtain desired results, depending on your operating
58      system. The Platform Hints section of the FAQ provides help for
59      operating system related problems.
60
61 4.   Build dependencies:
62
63         % make depend
64
65 5.   Build the system:
66
67         % make
68
69      If all goes well, the system will build as configured.  If not,
70      return to step 3 after reviewing the configuration settings.  You
71      may want to consult the Platform Hints subsection of the FAQ if
72      you have not done so already.
73
74 6.   Test the standalone system:
75
76      This step requires the standalone LDAP server, slapd(8), with
77      BDB, HDB, and/or LDBM support.
78
79         % make test
80
81      If all goes well, the system has been built as configured.  If
82      not, return to step 2 after reviewing your configuration
83      settings.  You may want to consult the Installation section of
84      the FAQ if you have not done so already.
85
86 7.   Install the software.  You may need to be come the super-user
87      (e.g. root) to do this (depending on where you are installing
88      things):
89
90         % su root -c 'make install'
91
92 8.   That's it.  Enjoy!
93
94 See the OpenLDAP Administrator's Guide and the manual pages for the
95 individual applications for configuration and use information. You may
96 also want to edit the configuration files used by the various
97 components.  These configuration files are located in the OpenLDAP
98 configuration directory (normally /usr/local/etc/openldap).
99
100         ldap.conf               client defaults
101         slapd.conf              Standalone LDAP daemon
102         schema/*.schema         Schema Definitions
103
104 ---
105 $OpenLDAP: pkg/openldap-guide/release/install.sdf,v 1.16 2002/02/18
106 17:09:26 kurt Exp $
107
108 This work is part of OpenLDAP Software <http://www.openldap.org/>.
109
110 Copyright 1998-2005 The OpenLDAP Foundation.
111 All rights reserved.
112
113 Redistribution and use in source and binary forms, with or without
114 modification, are permitted only as authorized by the OpenLDAP
115 Public License.
116
117 A copy of this license is available in the file LICENSE in the
118 top-level directory of the distribution or, alternatively, at
119 <http://www.OpenLDAP.org/license.html>.
120
121 OpenLDAP is a registered trademark of the OpenLDAP Foundation.