Installation

This will be migrated to the Trac Wiki

This installation document is setup for a Linux server. It has only been tested on Linux but should work on Windows.

I. Requirements

Apache HTTP Server 2.2 or later
PHP 5.1.0 or later
MySQL 4.1 or later
Java J2SE JDK 1.4 or later
YAZ 3.0 or later
GNU Aspell Library (

II. Installation Procedure

1. Install Apache HTTP Server
http://httpd.apache.org/docs/2.2/install.html
Ensure that mod_rewrite is included in the build

  • You will need to add the web directory as an accessible directory by the web server.
  • The web/interface/cache and web/interface/compile directories will also need to be owned by the web server.

2. Install MySQL

Most Linux distributions already have MySQL as a part of the distribution, but if you do not have it installed you can easily download from the following url:


http://mysql.org/downloads/mysql/5.0.html#downloads

3. Install PHP with following requirements:
--with-pear
--with-ldap
--with-mysql
--with-xsl
--with-pspell
--with-pdo-oci=instantclient,/path/to/oci,10.2.0.2 *

The --with-pdo-oci is at this point only used for Voyager libraries.
The --with-pspell is used for spelling correction and can be optional.
The --with-ldap is used for ldap authenitication. If you do not use LDAP, this can be ignored.

4. Install the Java JDK
http://java.sun.com/javase/downloads/

5. Install the YAZ library
http://www.indexdata.dk/yaz/

6. Create a user that will run vufind and define the JAVA_HOME
environment variable for that user.

7. Run the install script

The install script will attempt to setup the mysql database and install necessary libraries.

%> ./install

8. Edit configuration files

The web/conf/config.ini should be modified to match your system settings.
The web/.htaccess only requires the change of the RewriteBase field.

9. Start the VuFind Server

You can run the VuFind server by 2 methods. You can either start the server by running the startup script: 

    %> ./vufind.sh start
You can also run the server as a daemon. To do so just create a symbolic link into your /etc/init.d directory. You will then need to add the script to your init scripts. 
    On Redhat: chkconfig --add vufind
    On Debian: update-rc.d vufind defaults


10. Import BIB records into SOLR using the import script

The data directory defined in the config.ini file should be owned by the user that is running the import script.
The import script will create files in this directory.

By using the YAZ Marcdump utility, create a marcxml file from your bib records:
%> yaz-marcdump -f MARC-8 -t UTF-8 -o marcxml records.marc > catalog.xml

Copy the MarcXML file into the import directory and make sure it is named catalog.xml.
Then simply run the import/import-solr.php script from the command line:
%> php import-solr.php

11. Configure HTML Templates

For more information on customizing the UI of VuFind - visit the Customization Page.

* Steps to install PHP with PDO-OCI support:

  1. Download the Basic.zip and SDK.zip from the Oracle Instant Client web site
  2. Unzip the 2 zip files in the same directory
  3. Move the instantclient directory to somewhere on your server (/usr/local/lib is generally the place to put it)
  4. Create a symbolic link from the libclntsh.so.11.1 (or whatever version you have) to libclntsh.so as well as the same for libocci.so..
  5. Configure PHP with the option '--with-pdo-oci=instantclient,/usr/local/lib/instantclient,11.1.0.1'
    You may need to change the configure option to match the path that you have installed the instantclient to as well as the version that you downloaded

Releases

VuFind 1.0RC1 released (Wed, 15 Oct 2008 20:48:12 GMT)

Released at Wed, 15 Oct 2008 20:48:12 GMT by asnagy
Includes files: vufind-1.0RC1.tgz (30661976 bytes, 1309 downloads to date)
[Download] [Release Notes]
VuFind 0.8.2 released (Mon, 21 Apr 2008 14:02:54 GMT)

Released at Mon, 21 Apr 2008 14:02:54 GMT by asnagy
Includes files: vufind-0.8.2.zip (10651579 bytes, 232 downloads to date), vufind-0.8.2.tar.gz (10497863 bytes, 1973 downloads to date), vufind-0.8.2.tar.bz2 (10508797 bytes, 187 downloads to date)
[Download] [Release Notes]
VuFind 0.8.1 released (Tue, 15 Apr 2008 13:02:57 GMT)

Released at Tue, 15 Apr 2008 13:02:57 GMT by asnagy
Includes files: vufind-0.8.1.tar.bz2 (10507845 bytes, 160 downloads to date), vufind-0.8.1.tar.gz (10496445 bytes, 159 downloads to date), vufind-0.8.1.zip (10649831 bytes, 66 downloads to date)
[Download] [Release Notes]
VuFind 0.8 released (Tue, 18 Mar 2008 20:26:32 GMT)

Released at Tue, 18 Mar 2008 20:26:32 GMT by asnagy
Includes files: vufind-0.8.tar.gz (10559530 bytes, 968 downloads to date)
[Download] [Release Notes]
VuFind 0.7 released (Wed, 12 Dec 2007 19:32:43 GMT)

Released at Wed, 12 Dec 2007 19:32:43 GMT by asnagy
Includes files: VuFind-0.7.tar.gz (15969438 bytes, 1420 downloads to date)
[Download] [Release Notes]
VuFind 0.6.1 released (Wed, 22 Aug 2007 15:59:31 GMT)

Released at Wed, 22 Aug 2007 15:59:31 GMT by asnagy
Includes files: VuFind-0.6.1.tar.gz (7951149 bytes, 801 downloads to date)
[Download] [Release Notes]
VuFind 0.6 released (Thu, 16 Aug 2007 18:03:55 GMT)

Released at Thu, 16 Aug 2007 18:03:55 GMT by asnagy
Includes files: VuFind-0.6.tar.gz (7952238 bytes, 826 downloads to date)
[Download] [Release Notes]
VuFind 0.5 released (Tue, 17 Jul 2007 17:56:51 GMT)

Released at Tue, 17 Jul 2007 17:56:51 GMT by asnagy
Includes files: VUFind-0.5.tgz (7736414 bytes, 1107 downloads to date)
[Download] [Release Notes]
Downloads
The first public release is available in beta status. Visit the download page.
Falvey Memorial Library


VuFind is developed and maintained by Villanova University's Falvey Memorial Library.

News

VuFind wins Mellon Award
December 18, 2008 - On December 8th, Villanova University was amongst 10 other finalist for the 3rd annual Mellon Award for Technology Collaboration award for the development of VuFind. The award was delivered at the annual CNI Taskforce Meeting in Washington DC. Read the press release for more information: http://matc.mellon.org/press-release and here is a photo of the Villanova team with Vint Cerf: http://rit.mellon.org/MATC2008/slides/IMG_2429.html (0 comments)
VuFind 1.0 Release Candidate 1 now available
October 16, 2008 - The first release candidate of the VuFind 1.0 release is now available. This is only a release candidate in preparation of the official 1.0 release. Please take note of the new issue tracking software powered by JIRA http://vufind.org/jira (0 comments)
Villanova University Library goes Live!
August 20, 2008 - Falvey Memorial Library at Villanova Univesity launched their implementation of VuFind.
You can have a look at: http://library.villanova.edu/Find (0 comments)
Podcast Interview with Andrew and Chris
June 24, 2008 - PALINET interviews Andrew and Chris on the development of VuFind. Listen to the podcast at:
http://blog.palinet.org/podcast/?p=47 (0 comments)
National Library of Australia goes Live!
May 27, 2008 - The NLA has gone into production with VuFind and replaced their existing OPAC. Congrats to the NLA Team! Visit their site: http://catalogue.nla.gov.au (0 comments)
Version 0.8 is now available
March 18, 2008 - We are proud to announce the release of VuFind 0.8.
This release is a much anticipated release due to the refactoring of the index structure. We have a new import tool that will import MARC records much faster. See the documentation for details. (0 comments)
Version 0.7 is now available
December 12, 2007 - We are proud to announce the release of VuFind 0.7. This release is chock full of enhancements and new features. There are no major backend changes so an upgrade should be very easy. (0 comments)
ALA Midwinter in Philadelphia
December 11, 2007 - Come see VuFind in action in our home town of Philadelphia at the ALA Midwinter Conference in January. We will be sharing booth #318 with PALINET during the Exhibition. We will also be hosting a session on Saturday, January 12th at 10:30am. We hope you will come and see us! (0 comments)
2 presentations, 2 conferences, 2 days
October 24, 2007 - Chris and Andrew of the VuFind development team will be presenting at 2 conferences in October. The first presentation will be at the Palinet 2007 Conference in Baltimore on October 29. The second presentation will be at the ExLibris User Group Meeting on October 30 at Rider University in Lawrenceville, NJ just outside of Trenton. We hope to see you there! (0 comments)
VuFind Profiled in Smart Libraries Newsletter
September 06, 2007 - Marshall Breeding reports on VuFind in the September 2007 issue of ALA TechSource's Smart Libraries Newsletter. It's great to see Open Source initiatives - especially VuFind - profiled on the front page! (0 comments)