external/bsd/openldap/dist/doc/guide/release/install.sdf

   1 # $OpenLDAP: pkg/openldap-guide/release/install.sdf,v 1.23.2.3 2008/02/11 23:26:39 kurt Exp $
   2 # Copyright 1999-2008 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 detect
  59 the appropriate settings.  If the {{EX:configure}} script fails, you should
  60 read the {{FILE:config.log}} file that it generated to see what it was trying
  61 to do and exactly what failed.  You may need to specify additional
  62 options and/or environment variables besides those listed above to
  63 obtain desired results, depending on your operating system. The
  64 {{Platform Hints}} section of the {{FAQ}} provides help for operating system
  65 related problems.
  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 {{HDB}} and/or {{BDB}} 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 become 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 {{FILE:/usr/local/etc/openldap}}).
 106
 107 >       ldap.conf               client defaults
 108 >       slapd.conf              Standalone LDAP daemon
 109 >       schema/*.schema         Schema Definitions
 110