doc/INSTALL.txt

   1 11/15/04
   2 Version 1.2.1
   3
   4 Binary distributions of the Shibboleth code are available.
   5 Information on obtaining and installing binaries can be found at
   6 http://shibboleth.internet2.edu/ and in the deploy guide in this
   7 directory.
   8
   9 This document provides details for those wishing to build from source.
  10
  11 C++ / TARGET
  12
  13 Your first step is going to be the OpenSAML INSTALL.txt file. Please read it
  14 thoroughly to understand the issues. All the requirements in that file
  15 apply, mainly because you need to build OpenSAML, and almost all the
  16 dependencies are the same. Once you reach the end of that build process and
  17 have some confidence it worked, you can come back and continue here.
  18
  19 --- Apache
  20
  21 You'll next need to get an Apache in place. If you're building from source,
  22 you don't have to use the "real" Apache code, or use mod_ssl. You will
  23 however need to provide the necessary build flags during configure, or
  24 ideally, let our configure script use your Apache's apxs script to extract
  25 the necessary information.
  26
  27 Also, at a minimum, Apache needs to be built with mod_so enabled for
  28 dynamically loading modules. If you encounter problems with crashing
  29 or apparent module conflicts, make sure you've built Apache and any
  30 modules with threading support and ideally as much dynamically as
  31 possible.
  32
  33 Apache 1.x does not directly support threads, but you can set the
  34 CFLAGS variable before running configure to include the proper gcc
  35 thread flag (usually -pthread or -pthreads, depends on your platform).
  36
  37 --- MySQL (optional)
  38
  39 The distribution now includes a session cache plugin using embedded MySQL.
  40 This plugin will be included in the build by default if the embedded MySQL
  41 library (libmysqld.a) can be found, or if the --with-mysql option is passed
  42 to configure. You can force exclude the plugin with the --disable-mysql option.
  43
  44 Many default installs of MySQL will not include the embedded library, so don't
  45 be surprised if it's not there. Also, just as with PHP and certain other packages
  46 that include C++, you'll need to build it with the same compiler used to build
  47 Shibboleth.
  48
  49 The MySQL 4.0.x build is currently not clean on either platform. There are errors
  50 in several Makefile.in files that have to corrected to get the build to work.
  51 The patch for the pre-configure Makefile.in files in version 4.0.12 is included
  52 in this directory as the file "mysql-4.0.12.diff", which can be applied from the
  53 mysql-4.0.12 directory.
  54
  55 After patching, to get it to build, the --with-embedded-server option is used
  56 with MySQL. An example build is below:
  57
  58 $ cd mysql-4.0.12
  59 $ env CFLAGS="-fPIC -DPIC" CXXFLAGS="-fPIC -DPIC"
  60 $ ./configure --prefix=/opt/mysql \
  61     --libexecdir='${exec_prefix}/sbin' \
  62     --enable-thread-safe-client --enable-assembler --enable-local-infile \
  63     --with-extra-charsets=complex --with-embedded-server \
  64     --with-berkeley-db --with-innodb --with-raid
  65 $ make all
  66 $ make install
  67
  68 MySQL has a lot of options, so some local customization may be needed. The
  69 command to set the compiler flags is critical on Solaris, because the flags
  70 are needed to get a correct build of the library to link against.
  71
  72 --- Shibboleth
  73
  74 Building the Shibboleth target libraries, shar, test programs, and Apache
  75 modules is more or less like building OpenSAML. You can get the code from
  76 CVS and run the bootstrap script if you want, or just use a source tarball.
  77
  78 On Solaris/OS X, if you're rebuilding into a prefixed location that already
  79 contains a copy of the software and headers, you'll want to remove
  80 some of the headers to prevent extra build work when you run the make
  81 install command. Just do:
  82
  83 $ rm -rf /opt/shibboleth/include/rpc
  84
  85 With the source distribution or the results of your bootstrap:
  86
  87 $ ./configure --prefix=/opt/shibboleth --with-log4cpp=/opt/shibboleth \
  88     --enable-apache-13 --with-apxs --enable-apache-20 --with-apxs2 -C
  89 $ make
  90 $ make install
  91
  92 This will build the Apache 1.x and 2.x modules by extracting build settings
  93 from apxs. The configure script will look in normal spots for the script
  94 (/usr/bin/apxs, /usr/local/apache/bin/apxs) but you can point to it so that
  95 both modules can be built at once.
  96
  97 If you want to build the modules but not use apxs, you can use the
  98 --without-apxs option, and provide flags using the APXS_PREFIX, APXS_CFLAGS,
  99 APXS_INCLUDE, APXS_LIBEXEC, and APXS_SYSCONFDIR variables (see the apxs docs
 100 for some guidance on what these should be).
 101
 102 To test your installation, you can try the shibtest utility, which actually
 103 loads your configuration and attempts to obtain attributes from a Shibboleth
 104 Attribute Authority of your choosing. You indicate to it the "handle" of the
 105 principal to query, and the identifier (providerId) of the origin site,
 106 and it will use your configuration files to locate the proper AA.
 107
 108 $ set LD_LIBRARY_PATH=/opt/shibboleth/lib; export LD_LIBRARY_PATH
 109 $ /opt/shibboleth/bin/shibtest -h test-handle \
 110         -f urn:mace:shibboleth:test:nameIdentifier \
 111         -q urn:mace:inqueue:example.edu
 112
 113 The example shown uses a built-in test principal, and uses the InQueue
 114 example origin, which is known to the target after initial installation.
 115 You should get some reasonably structured output back that lists some simple
 116 attributes. An error here is a pretty good sign there's trouble.