doc/INSTALL.txt

   1 3/15/04
   2 Version 1.2
   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 --- MySQL (optional)
  34
  35 The distribution now includes a session cache plugin using embedded MySQL.
  36 This plugin will be included in the build by default if the embedded MySQL
  37 library (libmysqld.a) can be found, or if the --with-mysql option is passed
  38 to configure. You can force exclude the plugin with the --disable-mysql option.
  39
  40 Many default installs of MySQL will not include the embedded library, so don't
  41 be surprised if it's not there. Also, just as with PHP and certain other packages
  42 that include C++, you'll need to build it with the same compiler used to build
  43 Shibboleth unless g++ 3.2 or higher was used.
  44
  45 The MySQL 4.0.x build is currently not clean on either platform. There are errors
  46 in several Makefile.in files that have to corrected to get the build to work.
  47 The patch for the pre-configure Makefile.in files in version 4.0.12 is included
  48 in this directory as the file "mysql-4.0.12.diff", which can be applied from the
  49 mysql-4.0.12 directory.
  50
  51 After patching, to get it to build, the --with-embedded-server option is used
  52 with MySQL. An example build is below:
  53
  54 $ cd mysql-4.0.12
  55 $ env CFLAGS="-fPIC -DPIC" CXXFLAGS="-fPIC -DPIC"
  56 $ ./configure --prefix=/opt/mysql \
  57     --libexecdir='${exec_prefix}/sbin' \
  58     --enable-thread-safe-client --enable-assembler --enable-local-infile \
  59     --with-extra-charsets=complex --with-embedded-server \
  60     --with-berkeley-db --with-innodb --with-raid
  61 $ make all
  62 $ make install
  63
  64 MySQL has a lot of options, so some local customization may be needed. The
  65 command to set the compiler flags is critical on Solaris, because the flags
  66 are needed to get a correct build of the library to link against.
  67
  68 --- Shibboleth
  69
  70 Building the Shibboleth target libraries, shar, test programs, and Apache
  71 modules is more or less like building OpenSAML. You can get the code from
  72 CVS and run the bootstrap script if you want, or just use a source tarball.
  73 With the source distribution or the results of your bootstrap:
  74
  75 $ ./configure --prefix=/opt/shibboleth --with-log4cpp=/opt/shibboleth \
  76     --enable-apache-13 --with-apxs --enable-apache-20 --with-apxs2 -C
  77 $ make
  78 $ make install
  79
  80 This will build the Apache 1.x and 2.x modules by extracting build settings
  81 from apxs. The configure script will look in normal spots for the script
  82 (/usr/bin/apxs, /usr/local/apache/bin/apxs) but you can point to it so that
  83 both modules can be built at once.
  84
  85 If you want to build the modules but not use apxs, you can use the
  86 --without-apxs option, and provide flags using the APXS_PREFIX, APXS_CFLAGS,
  87 APXS_INCLUDE, APXS_LIBEXEC, and APXS_SYSCONFDIR variables (see the apxs docs
  88 for some guidance on what these should be).
  89
  90 To test your installation, you can try this:
  91
  92 $ set LD_LIBRARY_PATH=/opt/shibboleth/lib; export LD_LIBRARY_PATH
  93 $ cd /opt/shibboleth
  94 $ bin/shibtest -d etc/shibboleth/ -h foo -q urn:mace:inqueue:example.edu -r http://www.foo.edu/
  95
  96 You should get some reasonably structured output back that lists some simple
  97 attributes. An error here is a pretty good sign there's trouble.