doc/INSTALL.txt

   1 6/1/03
   2 Version 1.0
   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 You'll next need to get an Apache in place. If you're building from source,
  20 you don't have to use the "real" Apache code, or use mod_ssl. You will
  21 however need to provide the necessary build flags during configure, or
  22 ideally, let our configure script use your Apache's apxs script to extract
  23 the necessary information.
  24
  25 Once Apache is in place, you'll also need to build the libapreq library.
  26 Adjust the include path as needed.
  27
  28 http://www.apache.org/dist/httpd/libapreq/libapreq-1.1.tar.gz
  29
  30 $ tar xvzf libapreq-1.1.tar.gz
  31 $ cd libapreq-1.1
  32 $ ./configure --prefix=/opt/shibboleth --enable-static=no \
  33     --with-apache-includes=/usr/local/apache/include
  34 $ make
  35 $ make install
  36
  37
  38 Building the Shibboleth target libraries, shar, test programs, and Apache
  39 modules is more or less like building OpenSAML. You can get the code from
  40 CVS and run the bootstrap script if you want (remember to get new versions
  41 of autoconf/autoheader if you're running old pre-1.5 autoconf stuff):
  42
  43 $ cvs -d:pserver:anoncvs@cvs.internet2.edu:/home/cvs/shibboleth login
  44 $ cvs -d:pserver:anoncvs@cvs.internet2.edu:/home/cvs/shibboleth co -r Rel_1_0 shibboleth
  45 $ cd shibboleth/c
  46 $ ./bootstrap
  47
  48 With the source distribution or the results of your bootstrap:
  49
  50 $ ./configure --prefix=/opt/shibboleth --with-xmlsec=/opt/shibboleth --with-apxs -C
  51 $ make
  52 $ make install
  53
  54 This will build the Apache modules by extracting build settings from apxs.
  55 The configure script will look in normal spots for the script
  56 (/usr/bin/apxs, /usr/local/apache/bin/apxs) but you can point it if you need
  57 to.
  58
  59 If you want to build the modules but not use apxs, you can use the
  60 --without-apxs option, and provide flags using the APXS_PREFIX, APXS_CFLAGS,
  61 APXS_INCLUDE, APXS_LIBEXEC, and APXS_SYSCONFDIR variables (see the apxs docs
  62 for some guidance on what these should be).
  63
  64 To test your installation, you can try this:
  65
  66 $ set LD_LIBRARY_PATH=/opt/shibboleth/lib; export LD_LIBRARY_PATH
  67 $ cd /opt/shibboleth
  68 $ bin/shibtest -d etc/shibboleth/ -h foo -q urn:mace:inqueue:example.edu \
  69     -r http://www.foo.edu/ -a http://wayf.internet2.edu/InQueue/AA
  70
  71 You should get some reasonably structured output back that lists some simple
  72 attributes. An error here is a pretty good sign there's trouble.