xref: /netbsd-src/external/bsd/openldap/dist/INSTALL (revision b7b7574d3bf8eeb51a1fa3977b59142ec6434a55)
1Making and Installing the OpenLDAP Distribution
2===============================================
3
4This file provides brief instructions on how to build and install
5OpenLDAP on UNIX (and UNIX-like) systems.  More detailed information
6and instructions can be found in The OpenLDAP Administrator's Guide
7(available from http://www.openldap.org/doc/).
8
9It is recommended that you read, or at least skim through, ALL of the
10instructions in this file before attempting to build the software.
11
12It is also recommended you review the Frequently Asked Questions
13(http://www.openldap.org/faq/) pages, in particular the Installation
14section (http://www.openldap.org/faq/index.cgi?file=8) and Platform
15Hints (http://www.openldap.org/faq/index.cgi?file=9) should be
16examined.
17
18Making and Installing the OpenLDAP Distribution
19-----------------------------------------------
20
211.   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
292.   Type:
30
31        % ./configure --help
32
33     to list available configuration options.
34
35     The configure script also looks for compiler/linker options on
36     the command line and in the environment.  These include:
37
38        Variable        Description     Example
39        CC              C compiler      gcc
40        CFLAGS          C flags         -O -g
41        CPPFLAGS        cpp flags       -I/path/include -D__FOO__=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
483.   Configure the build system:
49
50        % ./configure [options] [var=value ...]
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
56     specify additional options and/or variables besides those listed
57     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
614.   Build dependencies:
62
63        % make depend
64
655.   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
746.   Test the standalone system:
75
76     This step requires the standalone LDAP server, slapd(8), with HDB
77     and/or BDB 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
867.   Install the software.  You may need to become 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
928.   That's it.  Enjoy!
93
94See the OpenLDAP Administrator's Guide and the manual pages for the
95individual applications for configuration and use information. You may
96also want to edit the configuration files used by the various
97components.  These configuration files are located in the OpenLDAP
98configuration 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
10617:09:26 kurt Exp $
107
108This work is part of OpenLDAP Software <http://www.openldap.org/>.
109
110Copyright 1998-2014 The OpenLDAP Foundation.
111All rights reserved.
112
113Redistribution and use in source and binary forms, with or without
114modification, are permitted only as authorized by the OpenLDAP
115Public License.
116
117A copy of this license is available in the file LICENSE in the
118top-level directory of the distribution or, alternatively, at
119<http://www.OpenLDAP.org/license.html>.
120
121OpenLDAP is a registered trademark of the OpenLDAP Foundation.
122