xref: /netbsd-src/external/bsd/openldap/dist/doc/guide/release/install.sdf (revision e670fd5c413e99c2f6a37901bb21c537fcd322d2)
1# $OpenLDAP$
2# Copyright 1999-2021 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
17P2: Making and Installing the OpenLDAP Distribution
18
19^ Unpack the distribution and change directory:
20
21E:	% tar xfz openldap-VERSION.tgz
22E:	% cd openldap-VERSION
23
24.(replacing {{EX:VERSION}} with the appropriate version string).  If
25you are reading this file, you probably have already done this!
26
27
28+ Type:
29
30E:	% ./configure --help
31
32.to list available configuration options.
33
34.The {{EX:configure}} script also looks for compiler/linker options
35on the command line and in the environment.  These include:
36
37>	Variable	Description	Example
38>	CC		C compiler	gcc
39>	CFLAGS		C flags		-O -g
40>	CPPFLAGS	cpp flags	-I/path/include -D__FOO__=42
41>	LDFLAGS		ld flags	-L/usr/local/lib
42>	LIBS		libraries	-llib
43>	PATH		command path	/usr/local/bin:/usr/bin:/bin
44
45!if $var{'OPT_TARGET'} eq 'txt'
46.See doc/install/configure for generic configure documentation.
47!endif
48
49+ Configure the build system:
50
51E:	% ./configure [options] [var=value ...]
52
53.If all goes well, the {{EX:configure}} script will automatically detect
54the appropriate settings.  If the {{EX:configure}} script fails, you should
55read the {{FILE:config.log}} file that it generated to see what it was trying
56to do and exactly what failed.  You may need to specify additional
57options and/or variables besides those listed above to
58obtain desired results, depending on your operating system.
59
60+ Build dependencies:
61
62E:	% make depend
63
64+ Build the system:
65
66E:	% make
67
68.If all goes well, the system will build as configured.  If not,
69return to step 3 after reviewing the configuration settings.
70
71+ Test the standalone system:
72
73.This step requires the standalone LDAP server, {{slapd}}(8),
74with {{MDB}} support.
75
76E:	% make test
77
78.If all goes well, the system has been built as configured.  If not,
79return to step 2 after reviewing your configuration settings.
80
81+ Install the software.  You may need to become the
82{{super-user}} (e.g. {{EX:root}}) to do this (depending on where you
83are installing things):
84
85E:	% su root -c 'make install'
86
87+ That's it.  Enjoy!
88
89See the {{OpenLDAP Administrator's Guide}} and the manual pages
90for the individual applications for configuration and use information.
91You may also want to edit the configuration files used by the
92various components.  These configuration files are located in
93the OpenLDAP configuration directory (normally
94{{FILE:/usr/local/etc/openldap}}).
95
96>	ldap.conf		client defaults
97>	slapd.conf		Standalone LDAP daemon
98>	lload.conf		LDAP Load Balancer daemon
99>	schema/*.schema		Schema Definitions
100
101