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

This installation documentation is designed as a general guide to installation of VuFind 1.0RC1 or later on a Linux server.  For more detailed step-by-step instructions on building a Linux VuFind server from scratch, you may also want to read the [[installation_fedora|VuFind on Fedora]] and [[installation_ubuntu|VuFind on Ubuntu]] pages (Fedora and Ubuntu are two different flavors of Linux; you can do some research to decide which is best for your needs).







===== Requirements =====
To satisfy VuFind's dependencies, make sure you install the software versions recommended on the [[requirements]] page.  You may use other versions at your own risk.

===== 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
  * VuFind contains a file called **vufind-httpd.conf** be sure to copy or link this into your apache conf.d directory.  You may need to edit this file to change directory paths, etc.
  * The **vufind/web/interface/cache**, **vufind/web/interface/compile** and **vufind/web/images/covers** directories and subdirectories will also need to be owned by the web server user.

==== 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 *
--enable-mbstring
</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 not used at all but might feature in future spelling-related enhancements; you can exclude it if you like.
  * The --with-ldap is used for ldap authentication. If you do not use LDAP, this can be ignored.
  * --enable-mbstring is used for improved support for multi-byte characters.  It is not necessary prior to VuFind 1.1 but may gain heavier use in future releases, so its inclusion is strongly recommended.

==== 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.

Just load the VuFind code onto your server (default location: /usr/local/vufind).  For details on obtaining VuFind, see the [[http://vufind.org/downloads.php|download page]].

Once the software is loaded, switch to the installation directory and run:

<code>
%> ./install
</code>

==== 6. Edit configuration files ====
The web/conf/config.ini should be modified to match your system settings.
The httpd-vufind.conf only requires the change of the RewriteBase field (if you're not using the default of /vufind).


==== 7. Start the VuFind Server ====
Be sure that VUFIND_HOME and JAVA_HOME are set in the profile of the user that will be running VuFind-related scripts.  VUFIND_HOME should be set to the root directory of the VuFind installation.

Once everything is configured, you can start the server as described on the [[Starting and Stopping VuFind]] page.

==== 8. Import BIB records into SOLR using the MARC Import Tool ====
See the [[Importing Records]] page for details on this process.



==== Installation is Complete ====
While the Import Tool loads the MARC records, you can begin to use your VuFind system.  For more information on customizing VuFind's many options, visit the [[Configuration and Customization]] Page.