INSTALL 4.22 KB
Newer Older
1
Making and Installing the OpenLDAP Distribution
Kurt Zeilenga's avatar
Kurt Zeilenga committed
2
===============================================
Kurt Zeilenga's avatar
Kurt Zeilenga committed
3

Kurt Zeilenga's avatar
Kurt Zeilenga committed
4
This file provides brief instructions on how to build and install
5
OpenLDAP on UNIX (and UNIX-like) systems.  More detailed information
6
and instructions can be found in The OpenLDAP Administrator's Guide
Kurt Zeilenga's avatar
Kurt Zeilenga committed
7
(available from http://www.openldap.org/doc/).
Kurt Zeilenga's avatar
Kurt Zeilenga committed
8

Kurt Zeilenga's avatar
Kurt Zeilenga committed
9
10
It is recommended that you read, or at least skim through, ALL of the
instructions in this file before attempting to build the software.
Kurt Zeilenga's avatar
Kurt Zeilenga committed
11

Kurt Zeilenga's avatar
Kurt Zeilenga committed
12
It is also recommended you review the Frequently Asked Questions
13
14
15
16
(http://www.openldap.org/faq/) pages, in particular the Installation
section (http://www.openldap.org/faq/index.cgi?file=8) and Platform
Hints (http://www.openldap.org/faq/index.cgi?file=9) should be
examined.
Kurt Zeilenga's avatar
Kurt Zeilenga committed
17

Kurt Zeilenga's avatar
Kurt Zeilenga committed
18
19
Making and Installing the OpenLDAP Distribution
-----------------------------------------------
Kurt Zeilenga's avatar
Kurt Zeilenga committed
20

Kurt Zeilenga's avatar
Kurt Zeilenga committed
21
1.   Unpack the distribution and change directory:
Kurt Zeilenga's avatar
Kurt Zeilenga committed
22

Kurt Zeilenga's avatar
Kurt Zeilenga committed
23
24
        % tar xfz openldap-VERSION.tgz
        % cd openldap-VERSION
25

Kurt Zeilenga's avatar
Kurt Zeilenga committed
26
27
     (replacing VERSION with the appropriate version string).  If you
     are reading this file, you probably have already done this!
Kurt Zeilenga's avatar
Kurt Zeilenga committed
28

Kurt Zeilenga's avatar
Kurt Zeilenga committed
29
2.   Type:
Kurt Zeilenga's avatar
Kurt Zeilenga committed
30

Kurt Zeilenga's avatar
Kurt Zeilenga committed
31
        % ./configure --help
Kurt Zeilenga's avatar
Kurt Zeilenga committed
32

33
     to list available configuration options.
Kurt Zeilenga's avatar
Kurt Zeilenga committed
34

35
36
     The configure script also looks for compiler/linker options on
     the command line and in the environment.  These include:
Kurt Zeilenga's avatar
Kurt Zeilenga committed
37

38
        Variable        Description     Example
Kurt Zeilenga's avatar
Kurt Zeilenga committed
39
40
        CC              C compiler      gcc
        CFLAGS          C flags         -O -g
41
        CPPFLAGS        cpp flags       -I/path/include -D__FOO__=42
Kurt Zeilenga's avatar
Kurt Zeilenga committed
42
43
44
        LDFLAGS         ld flags        -L/usr/local/lib
        LIBS            libraries       -llib
        PATH            command path    /usr/local/bin:/usr/bin:/bin
Kurt Zeilenga's avatar
Kurt Zeilenga committed
45

46
47
     See doc/install/configure for generic configure documentation.

Kurt Zeilenga's avatar
Kurt Zeilenga committed
48
3.   Configure the build system:
Kurt Zeilenga's avatar
Kurt Zeilenga committed
49

50
        % ./configure [options] [var=value ...]
Kurt Zeilenga's avatar
Kurt Zeilenga committed
51

Howard Chu's avatar
Howard Chu committed
52
53
54
     If all goes well, the configure script will automatically detect
     the appropriate settings.  If the configure script fails, you
     should read the config.log file that it generated to see what it
55
56
57
     was trying to do and exactly what failed.  You may need to
     specify additional options and/or variables besides those listed
     above to obtain desired results, depending on your operating
Howard Chu's avatar
Howard Chu committed
58
59
     system. The Platform Hints section of the FAQ provides help for
     operating system related problems.
Kurt Zeilenga's avatar
Kurt Zeilenga committed
60

Kurt Zeilenga's avatar
Kurt Zeilenga committed
61
4.   Build dependencies:
62

Kurt Zeilenga's avatar
Kurt Zeilenga committed
63
        % make depend
64

Kurt Zeilenga's avatar
Kurt Zeilenga committed
65
5.   Build the system:
66

Kurt Zeilenga's avatar
Kurt Zeilenga committed
67
        % make
68

Kurt Zeilenga's avatar
Kurt Zeilenga committed
69
70
71
72
     If all goes well, the system will build as configured.  If not,
     return to step 3 after reviewing the configuration settings.  You
     may want to consult the Platform Hints subsection of the FAQ if
     you have not done so already.
73

Kurt Zeilenga's avatar
Kurt Zeilenga committed
74
6.   Test the standalone system:
75

Kurt Zeilenga's avatar
Kurt Zeilenga committed
76
        % make test
Kurt Zeilenga's avatar
Kurt Zeilenga committed
77

Kurt Zeilenga's avatar
Kurt Zeilenga committed
78
     If all goes well, the system has been built as configured.  If
Kurt Zeilenga's avatar
Kurt Zeilenga committed
79
     not, return to step 2 after reviewing your configuration
Kurt Zeilenga's avatar
Kurt Zeilenga committed
80
81
     settings.  You may want to consult the Installation section of
     the FAQ if you have not done so already.
Kurt Zeilenga's avatar
Kurt Zeilenga committed
82

83
7.   Install the software.  You may need to become the super-user
Kurt Zeilenga's avatar
Kurt Zeilenga committed
84
85
     (e.g. root) to do this (depending on where you are installing
     things):
Kurt Zeilenga's avatar
Kurt Zeilenga committed
86

Kurt Zeilenga's avatar
Kurt Zeilenga committed
87
        % su root -c 'make install'
88

Kurt Zeilenga's avatar
Kurt Zeilenga committed
89
8.   That's it.  Enjoy!
Kurt Zeilenga's avatar
Kurt Zeilenga committed
90

91
92
93
94
95
See the OpenLDAP Administrator's Guide and the manual pages for the
individual applications for configuration and use information. You may
also want to edit the configuration files used by the various
components.  These configuration files are located in the OpenLDAP
configuration directory (normally /usr/local/etc/openldap).
96

Kurt Zeilenga's avatar
Kurt Zeilenga committed
97
98
99
        ldap.conf               client defaults
        slapd.conf              Standalone LDAP daemon
        schema/*.schema         Schema Definitions
100

Kurt Zeilenga's avatar
Kurt Zeilenga committed
101
---
Kurt Zeilenga's avatar
Kurt Zeilenga committed
102
103
$OpenLDAP: pkg/openldap-guide/release/install.sdf,v 1.16 2002/02/18
17:09:26 kurt Exp $
104

Kurt Zeilenga's avatar
Kurt Zeilenga committed
105
106
This work is part of OpenLDAP Software <http://www.openldap.org/>.

Quanah Gibson-Mount's avatar
Quanah Gibson-Mount committed
107
Copyright 1998-2021 The OpenLDAP Foundation.
Kurt Zeilenga's avatar
Kurt Zeilenga committed
108
All rights reserved.
Kurt Zeilenga's avatar
Kurt Zeilenga committed
109
110
111
112
113
114
115
116
117
118

Redistribution and use in source and binary forms, with or without
modification, are permitted only as authorized by the OpenLDAP
Public License.

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.