]> git.sur5r.net Git - openldap/blob - INSTALL
ITS #3131 - propagate SSF to syncrepl operation
[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      The configure script uses environmental variables for determining
36      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 3.   Configure the build system:
47
48         % [env settings] ./configure [options]
49
50      If all goes well, the configure script with automatically detect
51      the appropriate settings.  However, you may need to specify
52      options and/or environment variables to obtain desired results.
53
54 4.   Build dependencies:
55
56         % make depend
57
58 5.   Build the system:
59
60         % make
61
62      If all goes well, the system will build as configured.  If not,
63      return to step 3 after reviewing the configuration settings.  You
64      may want to consult the Platform Hints subsection of the FAQ if
65      you have not done so already.
66
67 6.   Test the standalone system:
68
69      This step requires the standalone LDAP server, slapd(8), with
70      BDB, HDB, and/or LDBM support.
71
72         % make test
73
74      If all goes well, the system has been built as configured.  If
75      not, return to step 2 after reviewing your configuration
76      settings.  You may want to consult the Installation section of
77      the FAQ if you have not done so already.
78
79 7.   Install the software.  You may need to be come the super-user
80      (e.g. root) to do this (depending on where you are installing
81      things):
82
83         % su root -c 'make install'
84
85 8.   That's it.  Enjoy!
86
87 See the OpenLDAP Administrator's Guide and the manual pages for the
88 individual applications for configuration and use information. You may
89 also want to edit the configuration files used by the various
90 components.  These configuration files are located in the OpenLDAP
91 configuration directory (normally /usr/local/etc/openldap).
92
93         ldap.conf               client defaults
94         slapd.conf              Standalone LDAP daemon
95         schema/*.schema         Schema Definitions
96
97 ---
98 $OpenLDAP: pkg/openldap-guide/release/install.sdf,v 1.16 2002/02/18
99 17:09:26 kurt Exp $
100
101 This work is part of OpenLDAP Software <http://www.openldap.org/>.
102
103 Copyright 1998-2004 The OpenLDAP Foundation.
104 All rights reserved.
105
106 Redistribution and use in source and binary forms, with or without
107 modification, are permitted only as authorized by the OpenLDAP
108 Public License.
109
110 A copy of this license is available in the file LICENSE in the
111 top-level directory of the distribution or, alternatively, at
112 <http://www.OpenLDAP.org/license.html>.
113
114 OpenLDAP is a registered trademark of the OpenLDAP Foundation.