1# $OpenLDAP$
2# Copyright 1999-2011 The OpenLDAP Foundation, All Rights Reserved.
3# COPYING RESTRICTIONS APPLY, see COPYRIGHT.
4
5P1: Making and Installing the OpenLDAP Distribution
6
7This file provides brief instructions on how to build and install
8OpenLDAP on UNIX (and UNIX-{{like}}) systems.  More detailed
9information and instructions can be found in
10{{The OpenLDAP Administrator's Guide}}
11(available from {{URL:http://www.openldap.org/doc/}}).
12
13It is recommended that you read, or at least skim through, ALL of
14the instructions in this file before attempting to build the
15software.
16
17It is also recommended you review
18the {{Frequently Asked Questions}} ({{URL:http://www.openldap.org/faq/}})
19pages, in particular the
20{{Installation section}} ({{URL:http://www.openldap.org/faq/index.cgi?file=8}})
21and
22{{Platform Hints}} ({{URL:http://www.openldap.org/faq/index.cgi?file=9}})
23should be examined.
24
25
26P2: Making and Installing the OpenLDAP Distribution
27
28^ Unpack the distribution and change directory:
29
30E:	% tar xfz openldap-VERSION.tgz
31E:	% cd openldap-VERSION
32
33.(replacing {{EX:VERSION}} with the appropriate version string).  If
34you are reading this file, you probably have already done this!
35
36
37+ Type:
38
39E:	% ./configure --help
40
41.to list available configuration options.
42
43.The {{EX:configure}} script uses environment variables for
44determining compiler/linker options including:
45
46>	Variable	Description	Example
47>	CC		C compiler	gcc
48>	CFLAGS		C flags		-O -g
49>	CPPFLAGS	cpp flags	-I/path/include -D__FOO__=42
50>	LDFLAGS		ld flags	-L/usr/local/lib
51>	LIBS		libraries	-llib
52>	PATH		command path	/usr/local/bin:/usr/bin:/bin
53
54+ Configure the build system
55
56E:	% [env settings] ./configure [options]
57
58.If all goes well, the {{EX:configure}} script will automatically detect
59the appropriate settings.  If the {{EX:configure}} script fails, you should
60read the {{FILE:config.log}} file that it generated to see what it was trying
61to do and exactly what failed.  You may need to specify additional
62options and/or environment variables besides those listed above to
63obtain desired results, depending on your operating system. The
64{{Platform Hints}} section of the {{FAQ}} provides help for operating system
65related problems.
66
67+ Build dependencies
68
69E:	% make depend
70
71+ Build the system
72
73E:	% make
74
75.If all goes well, the system will build as configured.  If not,
76return to step 3 after reviewing the configuration settings.  You
77may want to consult the {{Platform Hints}} subsection of the {{FAQ}}
78if you have not done so already.
79
80+ Test the standalone system
81
82.This step requires the standalone LDAP server, {{slapd}}(8),
83with {{HDB}} and/or {{BDB}} support.
84
85E:	% make test
86
87.If all goes well, the system has been built as configured.  If not,
88return to step 4 after reviewing your configuration settings.  You
89may want to consult the {{Installation}} section of the {{FAQ}}
90if you have not done so already.
91
92+ Install the binaries and man pages.  You may need to become the
93{{super-user}} (e.g. {{EX:root}}) to do this (depending on where you
94are installing things):
95
96E:	% su root -c 'make install'
97
98+ That's it!
99
100See the {{OpenLDAP Administrator's Guide}} and the manual pages
101for the individual applications for configuration and use information.
102You may also want to edit the configuration files used by the
103various components.  These configuration files are located in
104the OpenLDAP configuration directory (normally
105{{FILE:/usr/local/etc/openldap}}).
106
107>	ldap.conf		client defaults
108>	slapd.conf		Standalone LDAP daemon
109>	schema/*.schema		Schema Definitions
110
111