Installation::Abbreviated

From ReservesDirect: Open Source EReserves System

Home :: Features :: Screenshots :: Demo (http://www.reservesdirect.org/demo/index.html) :: Documentation :: Downloads :: Support :: Blog (http://www.reservesdirect.org/blog) :: Join Us!
ReservesDirect Documentation:   Contents | Library staff handbook | System administrator handbook | Developer handbook

For more experienced system administrators, here's the quick lowdown:

Table of contents

Required Prerequisites

  1. ReservesDirect is a [LAMP (http://en.wikipedia.org/wiki/LAMP_%28software_bundle%29)] installation: Linux (http://www.linux.org/), Apache (http://httpd.apache.org/) >= 2.0, MySQL (http://www.mysql.com/) >= 4.0, PHP (http://www.php.net/) >= 5.0):
    1. Apache should have mod_alias, mod_perl, libphp5 (of course) and be SSL capable
    2. PHP should have xml, pear, and magic-quotes configured
    3. PHP extension PEAR Db (http://pear.php.net/package/DB) -- `pear install db`

Optional Prerequisites

  1. For Z39.50 connectivity with your ILS (currently only Sirsi Unicorn is implemented):
    1. Perl >= 5.8
    2. Yaz (yaz, libyaz, & libyaz-devel) from http://www.indexdata.dk/yaz/
    3. PHP extension PECL PHP/Yaz (http://pecl.php.net/package/yaz) -- `pear install yaz`
  2. For Fax ingest capability:
    1. Hylafax (http://www.hylafax.org/)
    2. A compatible fax modem (http://www.hylafax.org/howto/install.html)
    3. Fax2pdf and GNU Ghostscript (http://www.gnu.org/software/ghostscript/ghostscript.html)
  3. Authentication:
    1. Authentication to ReservesDirect is largely a matter of local implementation preferences. Any mechanism that issues a valid authentication session key to secure/session.inc.php can be used. If the authenticated user has not used ReservesDirect previously, they will be directed to create a user profile upon logging in.
    2. Standalone (MySQL based) authentication -- this is the default mechanism.
    3. Apache::AuthCookie (http://www.cpan.org/modules/by-authors/id/BARTLEY/)-- a perl module that intercepts a user's first access to a protected document or directory. Requires that one construct an AuthCookieHandler to process authentication (an example is supplied with the module).
    4. To target your existing LDAP directory *securely* (via ldaps): NOT YET IMPLEMENTED
      1. mod_authz_ldap (http://authzldap.othello.ch/) (Note: comes bundled with RedHat ES 3-4, and Fedora Core 3-4)
      2. stunnel (http://www.stunnel.org/) (Note: comes bundled with RedHat ES 3-4, and Fedora Core 3-4)
    5. To target a Kerberos server: NOT YET IMPLEMENTED
      1. mod_auth_kerb (http://modauthkerb.sourceforge.net/)
      2. A complete krb5 implementation, including development libraries (e.g. krb5-libs, krb5-workstation, krb5-devel for RedHat)

Installation

Download the ReservesDirect source code

Prepare Environment

  1. Install PHP5, MySQL (Client & Server), Pear::DB
  2. phpMyAdmin is STRONGLY recommended

(to install using APT)

apt-get install libapache2-mod-php5 php5-cli apache2 phpmyadmin php5-mysql php-pear mysql-server-5.0 mysql-client-5.0
pear install db

Uncompress the code on your server

Copy the tarball to your web server document root and untar it there. Program files will be placed in a /path/to/your/webroot/reservesdirect subdirectory.

Set write permissions

Give write permissions for HTTPd user to your config.xml and the config_loc.php files

chmod 666 config.xml.example config_loc.php

Run Auto Installer

  1. give write access on your config file to HTTPd (apache) user (Recommended: place this file outside the webroot)
  2. point your browser to http://your_host/reservesdirect/scripts/installer.php
  3. There is an error in the installer caused by a missing semicolon in line 495. We will patch this; until then, add a semicolon to the following line of code when installing.

INSERT INTO `skins` (`id`, `skin_name`, `skin_stylesheet`, `default_selected`) VALUES (1,'default','css/ReservesStyles.css','yes')

Change folder/file permissions

All files in the ReservesDirect source code must be readable by the Apache user, and the area where ereserves files are to be deposited must also be writeable by the Apache user, so that ReservesDirect can upload your ereserves materials. You should remove write permissions for the HTTPd user from the config_loc.inc.php file and your config.xml file.

Next Steps

Proceed to the Configuration section.