]> git.sur5r.net Git - openldap/blob - doc/guide/release/install.sdf
Misc updates
[openldap] / doc / guide / release / install.sdf
1 # $OpenLDAP$
2 # Copyright 1999-2001, 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}}) system.  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 OpenLDAP Administrator's Guide}}
19 ({{URL:http://www.openldap.org/doc/admin/}}),
20 the {{Frequently Asked Questions}} ({{URL:http://www.openldap.org/faq/}})
21 pages, in particular the
22 {{Installation section}} ({{URL:http://www.openldap.org/faq/index.cgi?file=8}})
23 and
24 {{Platform Hints}} ({{URL:http://www.openldap.org/faq/index.cgi?file=9}})
25 should be examined.
26
27
28 P2: Making and Installing the OpenLDAP Distribution
29
30 ^ Unpack the distribution and change directory:
31
32 E:      % tar xfz openldap-VERSION.tgz
33 E:      % cd openldap-VERSION
34
35 .(replacing {{EX:VERSION}} with the appropriate version string).  If
36 you are reading this file, you probably have already done this!
37
38
39 + Type:
40
41 E:      % ./configure --help
42
43 .to list available configuration options.   A description of
44 these options is provided in the 'CONFIGURE OPTIONS' section
45 below.
46
47 .The {{EX:configure}} script uses environmental variables for
48 determining compiler/linker options including:
49
50 >       Variable        Description     Example
51 >       CC              C compiler      gcc
52 >       CFLAGS          C flags         -O -g
53 >       CPPFLAGS        cpp flags       -I/path/include -Ddef
54 >       LDFLAGS         ld flags        -L/usr/local/lib
55 >       LIBS            libraries       -llib
56 >       PATH            command path    /usr/local/bin:/usr/bin:/bin
57
58 + Configure the build system
59
60 E:      % [env settings] ./configure [options]
61
62 .If all goes well, the {{EX:configure}} script with automatically
63 detect the appropriate settings.  However, you may need to
64 specify options and/or environment variables to obtain desired
65 results.
66
67 + Build dependencies
68
69 E:      % make depend
70
71 + Build the system
72
73 E:      % make
74
75 .If all goes well, the system will build as configured.  If not,
76 return to step 3 after reviewing the configuration settings.  You
77 may want to consult the {{Platform Hints}} subsection of the {{FAQ}}
78 if you have not done so already.
79
80 + Test the standalone system
81
82 .This step requires the standalone LDAP server, {{slapd}}(8),
83 with {{LDBM}} support.
84
85 E:      % make test
86
87 .If all goes well, the system has been built as configured.  If not,
88 return to step 4 after reviewing your configuration settings.  You
89 may want to consult the {{Installation}} section of the {{FAQ}}
90 if you have not done so already.
91
92 + install the binaries and man pages.  You may need to be come the
93 {{super-user}} (e.g. {{EX:root}}) to do this (depending on where you
94 are installing things):
95
96 E:      % su root -c 'make install'
97
98 + That's it!
99
100 See the {{OpenLDAP Administrator's Guide}} and the manual pages
101 for the individual applications for configuration and use information.
102 You may also want to edit the configuration files used by the
103 various components.  These configuration files are located in
104 the OpenLDAP configuration directory (normally
105 {{F:/usr/local/etc/openldap}}).
106
107 >       ldap.conf               client defaults
108 >       ldapfilter.conf         search filter configuration
109 >       ldapsearchprefs.conf    search object definitions
110 >       ldaptemplates.conf      display template definitions
111 >       slapd.conf              Standalone LDAP daemon
112 >       schema/*.schema         Schema Definitions
113
114
115 End of OpenLDAP INSTALL file.
116
117 {{S:$OpenLDAP$}}