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