====== Installation ======

This installation documentation is designed for installation of VuFind 0.8 on a Linux server.




===== Requirements =====
These are the requirements that VuFind was built with and tested under.
You may use other versions at your own risk
  * Apache HTTP Server 2.2 or later
  * PHP 5.2.0 or later
  * MySQL 4.1 or later
  * Java J2SE JDK 1.4 or later
  * GNU Aspell Library


===== 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 **vufind/web** directory as an accessible directory by the web server.
  * The **vufind/web/interface/cache** and **vufind/web/interface/compile** directories will also need to be owned by the web server.

**a sample http config might include:**

<code>
<Directory "/usr/local/vufind/web/">
  AllowOverride all
</Directory>

Alias /vufind /usr/local/vufind/web
</code>

==== 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:
<code>
http://mysql.org/downloads/mysql/5.0.html#downloads
</code>
==== 3. Install PHP with following requirements: ====
<code>
--with-pear
--with-ldap
--with-mysql
--with-xsl
--with-pspell
--with-pdo-oci=instantclient,/path/to/oci,10.2.0.2 *
</code>
  * The --with-pdo-oci is at this point only used for Voyager libraries.
((Steps to install PHP with PDO-OCI support:
  - Download the Basic.zip and SDK.zip from the Oracle Instant Client web site
  - Unzip the 2 zip files in the same directory
  - Move the instantclient directory to somewhere on your server (/usr/local/lib is generally the place to put it)
  - 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..
  - 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))
  * 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 ====
<code>
http://java.sun.com/javase/downloads/
</code>

==== 5. Run the install script ====
The install script will attempt to setup the mysql database and install necessary libraries.
<code>
%> ./install
</code>
==== 6. 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.
==== 7. Start the VuFind Server ====
You can run the VuFind server by 2 methods. You can either start the server by running the startup script:
<code>
    %> ./vufind.sh start
</code>
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       



==== 8. Import BIB records into SOLR using the MARC Import Tool ====
Copy the MARC file that is exported from your ILS into the import directory with the name **catalog.mrc**.  Then simply run the MARC Import Tool form the command line:
<code>
%> ./import.sh
</code>

==== Installation is Complete ====
While the Import Tool loads the MARC records, you can begin to use your VuFind system.  You will get an email notification from the Import Tool once the import process has finished.
For more information on customizing the UI of VuFind - visit the [[Customization]] Page.