Home | History | Annotate | Line # | Download | only in release 
      1 # $OpenLDAP$
      2 # Copyright 1999-2024 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 P2: Making and Installing the OpenLDAP Distribution
     18 
     19 ^ Unpack the distribution and change directory:
     20 
     21 E:	% tar xfz openldap-VERSION.tgz
     22 E:	% cd openldap-VERSION
     23 
     24 .(replacing {{EX:VERSION}} with the appropriate version string).  If
     25 you are reading this file, you probably have already done this!
     26 
     27 
     28 + Type:
     29 
     30 E:	% ./configure --help
     31 
     32 .to list available configuration options.
     33 
     34 .The {{EX:configure}} script also looks for compiler/linker options
     35 on 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 
     51 E:	% ./configure [options] [var=value ...]
     52 
     53 .If all goes well, the {{EX:configure}} script will automatically detect
     54 the appropriate settings.  If the {{EX:configure}} script fails, you should
     55 read the {{FILE:config.log}} file that it generated to see what it was trying
     56 to do and exactly what failed.  You may need to specify additional
     57 options and/or variables besides those listed above to
     58 obtain desired results, depending on your operating system.
     59 
     60 + Build dependencies:
     61 
     62 E:	% make depend
     63 
     64 + Build the system:
     65 
     66 E:	% make
     67 
     68 .If all goes well, the system will build as configured.  If not,
     69 return 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),
     74 with {{MDB}} support.
     75 
     76 E:	% make test
     77 
     78 .If all goes well, the system has been built as configured.  If not,
     79 return 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
     83 are installing things):
     84 
     85 E:	% su root -c 'make install'
     86 
     87 + That's it.  Enjoy!
     88 
     89 See the {{OpenLDAP Administrator's Guide}} and the manual pages
     90 for the individual applications for configuration and use information.
     91 You may also want to edit the configuration files used by the
     92 various components.  These configuration files are located in
     93 the 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