Installing the Evergreen server

Begin by installing the most recent version of OpenSRF (3.0.0 or later). You can download OpenSRF releases from http://evergreen-ils.org/opensrf-downloads/

On some distributions, it is necessary to install PostgreSQL 9.4+ from external repositories.

Issue the following commands as the root Linux account to install prerequisites using the Makefile.install prerequisite installer, substituting debian-stretch, debian-jessie, debian-wheezy, ubuntu-xenial, or ubuntu-trusty for <osname> below:

make -f Open-ILS/src/extras/Makefile.install <osname>

Add the libdbi-libdbd libraries to the system dynamic library path by issuing the following commands as the root Linux account:

echo "/usr/local/lib/dbd" > /etc/ld.so.conf.d/eg.conf
ldconfig

OPTIONAL: Developer additions

Once you have configured and compiled Evergreen, issue the following command as the root Linux account to install Evergreen, build the server portion of the staff client, and copy example configuration files to /openils/conf. Change the value of the STAFF_CLIENT_STAMP_ID variable to match the version of the staff client that you will use to connect to the Evergreen server.

make STAFF_CLIENT_STAMP_ID=rel_3_0_5 install

The server portion of the staff client expects http://hostname/xul/server to resolve. Issue the following commands as the root Linux account to create a symbolic link pointing to the server subdirectory of the server portion of the staff client that we just built using the staff client ID rel_name:

cd /openils/var/web/xul
ln -sf rel_name/server server

Use the example configuration files in Open-ILS/examples/apache/ (for Apache versions below 2.4) or Open-ILS/examples/apache_24/ (for Apache versions 2.4 or greater) to configure your Web server for the Evergreen catalog, staff client, Web services, and administration interfaces. Issue the following commands as the root Linux account:

cp Open-ILS/examples/apache/eg.conf       /etc/apache2/sites-available/
cp Open-ILS/examples/apache/eg_vhost.conf /etc/apache2/
cp Open-ILS/examples/apache/eg_startup    /etc/apache2/
# Now set up SSL
mkdir /etc/apache2/ssl
cd /etc/apache2/ssl

cp Open-ILS/examples/apache_24/eg_24.conf       /etc/apache2/sites-available/eg.conf
cp Open-ILS/examples/apache_24/eg_vhost_24.conf /etc/apache2/eg_vhost.conf
cp Open-ILS/examples/apache/eg_startup          /etc/apache2/
# Now set up SSL
mkdir /etc/apache2/ssl
cd /etc/apache2/ssl

The openssl command cuts a new SSL key for your Apache server. For a production server, you should purchase a signed SSL certificate, but you can just use a self-signed certificate and accept the warnings in the staff client and browser during testing and development. Create an SSL key for the Apache server by issuing the following command as the root Linux account:

openssl req -new -x509 -days 365 -nodes -out server.crt -keyout server.key

As the root Linux account, edit the eg.conf file that you copied into place.

Change the user for the Apache server.

As the root Linux account, configure Apache with KeepAlive settings appropriate for Evergreen. Higher values can improve the performance of a single client by allowing multiple requests to be sent over the same TCP connection, but increase the risk of using up all available Apache child processes and memory.

As the root Linux account, configure the prefork module to start and keep enough Apache servers available to provide quick responses to clients without running out of memory. The following settings are a good starting point for a site that exposes the default Evergreen catalogue to the web:

<IfModule mpm_prefork_module>
   StartServers         15
   MinSpareServers       5
   MaxSpareServers      15
   MaxClients           75
   MaxRequestsPerChild 500
</IfModule>

<IfModule mpm_prefork_module>
   StartServers            15
   MinSpareServers          5
   MaxSpareServers         15
   MaxRequestWorkers       75
   MaxConnectionsPerChild 500
</IfModule>

(Ubuntu Trusty/Xenial, Debian Jessie/Stretch) As the root user, enable the mpm_prefork module:

a2dismod mpm_event
a2enmod mpm_prefork

(Debian Wheezy): As the root Linux account, enable the Evergreen site:

a2dissite default  # OPTIONAL: disable the default site (the "It Works" page)
a2ensite eg.conf

a2dissite 000-default  # OPTIONAL: disable the default site (the "It Works" page)
a2ensite eg.conf

(Debian and Ubuntu): As the root Linux account, enable Apache to write to the lock directory; this is currently necessary because Apache is running as the opensrf user:

chown opensrf /var/lock/apache2

As the root Linux account, start the memcached and ejabberd services (if they aren’t already running):

/etc/init.d/ejabberd start
/etc/init.d/memcached start

As the opensrf Linux account, start Evergreen. The -l flag in the following command is only necessary if you want to force Evergreen to treat the hostname as localhost; if you configured opensrf.xml using the real hostname of your machine as returned by perl -ENet::Domain 'print Net::Domain::hostfqdn() . "\n";', you should not use the -l flag.

osrf_control -l --start-all

As the opensrf Linux account, generate the Web files needed by the staff client and catalogue and update the organization unit proximity (you need to do this the first time you start Evergreen, and after that each time you change the library org unit configuration. ):

autogen.sh

As the root Linux account, restart the Apache Web server:

/etc/init.d/apache2 restart