]> git.sur5r.net Git - openldap/blob - doc/guide/release/install.sdf
Misc. updates
[openldap] / doc / guide / release / install.sdf
1 # $OpenLDAP$
2 # Copyright 1999-2003, 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 uses environment variables for
44 determining 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
56 E:      % [env settings] ./configure [options]
57
58 .If all goes well, the {{EX:configure}} script will automatically
59 detect the appropriate settings.  However, you may need to
60 specify options and/or environment variables to obtain desired
61 results.
62
63 + Build dependencies
64
65 E:      % make depend
66
67 + Build the system
68
69 E:      % make
70
71 .If all goes well, the system will build as configured.  If not,
72 return to step 3 after reviewing the configuration settings.  You
73 may want to consult the {{Platform Hints}} subsection of the {{FAQ}}
74 if you have not done so already.
75
76 + Test the standalone system
77
78 .This step requires the standalone LDAP server, {{slapd}}(8),
79 with {{BDB}} or {{LDBM}} support.
80
81 E:      % make test
82
83 .If all goes well, the system has been built as configured.  If not,
84 return to step 4 after reviewing your configuration settings.  You
85 may want to consult the {{Installation}} section of the {{FAQ}}
86 if you have not done so already.
87
88 + Install the binaries and man pages.  You may need to become the
89 {{super-user}} (e.g. {{EX:root}}) to do this (depending on where you
90 are installing things):
91
92 E:      % su root -c 'make install'
93
94 + That's it!
95
96 See the {{OpenLDAP Administrator's Guide}} and the manual pages
97 for the individual applications for configuration and use information.
98 You may also want to edit the configuration files used by the
99 various components.  These configuration files are located in
100 the OpenLDAP configuration directory (normally
101 {{F:/usr/local/etc/openldap}}).
102
103 >       ldap.conf               client defaults
104 >       slapd.conf              Standalone LDAP daemon
105 >       schema/*.schema         Schema Definitions
106
107
108 End of OpenLDAP INSTALL file.
109
110 {{S:$OpenLDAP$}}