1 Installing the Evergreen server
2 ===============================
6 Preamble: referenced user accounts
7 ----------------------------------
9 In subsequent sections, we will refer to a number of different accounts, as
12 * Linux user accounts:
13 ** The *user* Linux account is the account that you use to log onto the
14 Linux system as a regular user.
15 ** The *root* Linux account is an account that has system administrator
16 privileges. On Debian and Fedora you can switch to this account from
17 your *user* account by issuing the `su -` command and entering the
18 password for the *root* account when prompted. On Ubuntu you can switch
19 to this account from your *user* account using the `sudo su -` command
20 and entering the password for your *user* account when prompted.
21 ** The *opensrf* Linux account is an account that you create when installing
22 OpenSRF. You can switch to this account from the *root* account by
23 issuing the `su - opensrf` command.
24 ** The *postgres* Linux account is created automatically when you install
25 the PostgreSQL database server. You can switch to this account from the
26 *root* account by issuing the `su - postgres` command.
27 * PostgreSQL user accounts:
28 ** The *evergreen* PostgreSQL account is a superuser account that you will
29 create to connect to the PostgreSQL database server.
30 * Evergreen administrator account:
31 ** The *egadmin* Evergreen account is an administrator account for
32 Evergreen that you will use to test connectivity and configure your
35 Preamble: developer instructions
36 --------------------------------
39 Skip this section if you are using an official release tarball downloaded
40 from http://evergreen-ils.org/egdownloads
42 Developers working directly with the source code from the Git repository,
43 rather than an official release tarball, must perform one step before they
44 can proceed with the `./configure` step.
46 As the *user* Linux account, issue the following command in the Evergreen
47 source directory to generate the configure script and Makefiles:
50 ------------------------------------------------------------------------------
52 ------------------------------------------------------------------------------
54 Installing prerequisites
55 ------------------------
57 * **PostgreSQL**: Version 9.3 is recommended. The minimum supported version
59 * **Linux**: Evergreen 2.7 has been tested on Debian Jessie (8.0),
60 Debian Wheezy (7.0), Debian Squeeze(6.0), Ubuntu Trusty Tahr (14.04),
61 Ubuntu Precise Pangolin (12.04), and Fedora.
62 If you are running an older version of these distributions, you may want
63 to upgrade before upgrading Evergreen. For instructions on upgrading these
64 distributions, visit the Debian, Ubuntu or Fedora websites.
65 * **OpenSRF**: The minimum supported version of OpenSRF is 2.4.0.
68 Evergreen has a number of prerequisite packages that must be installed
69 before you can successfully configure, compile, and install Evergreen.
71 1. Begin by installing the most recent version of OpenSRF (2.4.0 or later).
72 You can download OpenSRF releases from http://evergreen-ils.org/opensrf-downloads/
73 2. On many distributions, it is necessary to install PostgreSQL 9.1+ from external
76 * On Debian Squeeze, open `/etc/apt/sources.list` in a text editor as the
77 *root* Linux account and add the following line:
80 ------------------------------------------------------------------------------
81 deb http://backports.debian.org/debian-backports squeeze-backports main contrib
82 ------------------------------------------------------------------------------
84 * Ubuntu Precise and Trusty comes with PostgreSQL 9.1+, so no additional steps are required.
85 * Fedora 19 and 20 come with PostgreSQL 9.2+, so no additional steps are required.
87 3. On Debian and Ubuntu, run `aptitude update` as the *root* Linux account to
88 retrieve the new packages from the backports repository.
89 4. Issue the following commands as the *root* Linux account to install
90 prerequisites using the `Makefile.install` prerequisite installer,
91 substituting `debian-jessie`, `debian-wheezy`, `debian-squeeze`, `fedora`,
92 `ubuntu-trusty`, or `ubuntu-precise` for <osname> below:
95 ------------------------------------------------------------------------------
96 make -f Open-ILS/src/extras/Makefile.install <osname>
97 ------------------------------------------------------------------------------
99 5. Add the libdbi-libdbd libraries to the system dynamic library path by
100 issuing the following commands as the *root* Linux account:
103 You should skip this step if installing on Ubuntu Precise or Trusty. The ubuntu
104 targets use libdbd-pgsql from packages.
108 ------------------------------------------------------------------------------
109 echo "/usr/local/lib/dbd" > /etc/ld.so.conf.d/eg.conf
111 ------------------------------------------------------------------------------
115 ------------------------------------------------------------------------------
116 echo "/usr/lib64/dbd" > /etc/ld.so.conf.d/eg.conf
118 ------------------------------------------------------------------------------
120 6. OPTIONAL: Developer additions
122 To perform certain developer tasks from a Git source code checkout,
123 additional packages may be required. As the *root* Linux account:
125 * To install packages needed for retriving and managing web dependencies,
126 use the <osname>-developer Makefile.install target. Currently,
127 this is only needed for building and installing the (preview) browser
131 ------------------------------------------------------------------------------
132 make -f Open-ILS/src/extras/Makefile.install <osname>-developer
133 ------------------------------------------------------------------------------
135 * To install packages required for building Evergreen release bundles, use
136 the <osname>-packager Makefile.install target.
139 ------------------------------------------------------------------------------
140 make -f Open-ILS/src/extras/Makefile.install <osname>-packager
141 ------------------------------------------------------------------------------
143 Configuration and compilation instructions
144 ------------------------------------------
146 For the time being, we are still installing everything in the `/openils/`
147 directory. From the Evergreen source directory, issue the following commands as
148 the *user* Linux account to configure and build Evergreen:
151 ------------------------------------------------------------------------------
152 PATH=/openils/bin:$PATH ./configure --prefix=/openils --sysconfdir=/openils/conf
154 ------------------------------------------------------------------------------
156 These instructions assume that you have also installed OpenSRF under `/openils/`.
157 If not, please adjust PATH as needed so that the Evergreen `configure` script
158 can find `osrf_config`.
160 Installation instructions
161 -------------------------
163 1. Once you have configured and compiled Evergreen, issue the following
164 command as the *root* Linux account to install Evergreen, build the server
165 portion of the staff client, and copy example configuration files to
167 Change the value of the `STAFF_CLIENT_STAMP_ID` variable to match the version
168 of the staff client that you will use to connect to the Evergreen server.
171 ------------------------------------------------------------------------------
172 make STAFF_CLIENT_STAMP_ID=rel_name install
173 ------------------------------------------------------------------------------
175 2. The server portion of the staff client expects `http://hostname/xul/server`
176 to resolve. Issue the following commands as the *root* Linux account to
177 create a symbolic link pointing to the `server` subdirectory of the server
178 portion of the staff client that we just built using the staff client ID
182 ------------------------------------------------------------------------------
183 cd /openils/var/web/xul
184 ln -sf rel_name/server server
185 ------------------------------------------------------------------------------
187 Change ownership of the Evergreen files
188 ---------------------------------------
190 All files in the `/openils/` directory and subdirectories must be owned by the
191 `opensrf` user. Issue the following command as the *root* Linux account to
192 change the ownership on the files:
195 ------------------------------------------------------------------------------
196 chown -R opensrf:opensrf /openils
197 ------------------------------------------------------------------------------
199 Additional Instructions for Developers
200 --------------------------------------
203 Skip this section if you are using an official release tarball downloaded
204 from http://evergreen-ils.org/egdownloads
206 Developers working directly with the source code from the Git repository,
207 rather than an official release tarball, need to install the Dojo Toolkit
208 set of JavaScript libraries. The appropriate version of Dojo is included in
209 Evergreen release tarballs. Developers should install the Dojo 1.3.3 version
210 of Dojo by issuing the following commands as the *opensrf* Linux account:
213 ------------------------------------------------------------------------------
214 wget http://download.dojotoolkit.org/release-1.3.3/dojo-release-1.3.3.tar.gz
215 tar -C /openils/var/web/js -xzf dojo-release-1.3.3.tar.gz
216 cp -r /openils/var/web/js/dojo-release-1.3.3/* /openils/var/web/js/dojo/.
217 ------------------------------------------------------------------------------
220 Configure the Apache Web server
221 -------------------------------
223 1. Use the example configuration files in `Open-ILS/examples/apache/` (for
224 Apache versions below 2.4) or `Open-ILS/examples/apache_24/` (for Apache
225 versions 2.4 or greater) to configure your Web server for the Evergreen
226 catalog, staff client, Web services, and administration interfaces. Issue the
227 following commands as the *root* Linux account:
229 .Debian and Ubuntu Precise
231 ------------------------------------------------------------------------------
232 cp Open-ILS/examples/apache/eg.conf /etc/apache2/sites-available/
233 cp Open-ILS/examples/apache/eg_vhost.conf /etc/apache2/
234 cp Open-ILS/examples/apache/eg_startup /etc/apache2/
236 mkdir /etc/apache2/ssl
238 ------------------------------------------------------------------------------
242 ------------------------------------------------------------------------------------
243 cp Open-ILS/examples/apache_24/eg_24.conf /etc/apache2/sites-available/eg.conf
244 cp Open-ILS/examples/apache_24/eg_vhost_24.conf /etc/apache2/eg_vhost.conf
245 cp Open-ILS/examples/apache/eg_startup /etc/apache2/
247 mkdir /etc/apache2/ssl
249 ------------------------------------------------------------------------------------
253 ------------------------------------------------------------------------------
254 cp Open-ILS/examples/apache_24/eg_24.conf /etc/httpd/conf.d/
255 cp Open-ILS/examples/apache_24/eg_vhost_24.conf /etc/httpd/eg_vhost.conf
256 cp Open-ILS/examples/apache/eg_startup /etc/httpd/
260 ------------------------------------------------------------------------------
262 2. The `openssl` command cuts a new SSL key for your Apache server. For a
263 production server, you should purchase a signed SSL certificate, but you can
264 just use a self-signed certificate and accept the warnings in the staff client
265 and browser during testing and development. Create an SSL key for the Apache
266 server by issuing the following command as the *root* Linux account:
269 ------------------------------------------------------------------------------
270 openssl req -new -x509 -days 365 -nodes -out server.crt -keyout server.key
271 ------------------------------------------------------------------------------
273 3. As the *root* Linux account, edit the `eg.conf` file that you copied into
275 a. To enable access to the offline upload / execute interface from any
276 workstation on any network, make the following change (and note that
277 you *must* secure this for a production instance):
278 * (Apache 2.2): Replace `Allow from 10.0.0.0/8` with `Allow from all`
279 * (Apache 2.4): Replace `Require host 10.0.0.0/8` with `Require all granted`
280 b. (Fedora): Change references from the non-existent `/etc/apache2/` directory
282 4. Change the user for the Apache server.
283 * (Debian and Ubuntu): As the *root* Linux account, edit
284 `/etc/apache2/envvars`. Change `export APACHE_RUN_USER=www-data` to
285 `export APACHE_RUN_USER=opensrf`.
286 * (Fedora): As the *root* Linux account , edit `/etc/httpd/conf/httpd.conf`.
287 Change `User apache` to `User opensrf`.
288 5. Configure Apache with performance settings appropriate for Evergreen:
289 * (Debian and Ubuntu): As the *root* Linux account, edit
290 `/etc/apache2/apache2.conf`:
291 * (Fedora): As the *root* Linux account, edit `/etc/httpd/conf/httpd.conf`:
292 a. Change `KeepAliveTimeout` to `1`. Higher values reduce the chance of
293 a request timing out unexpectedly, but increase the risk of using up
294 all available Apache child processes.
295 b. 'Optional': Change `MaxKeepAliveRequests` to `100`
296 c. (Debian, Ubuntu Precise, and Fedora) Update the prefork configuration
297 section to suit your environment. The following settings apply to a busy
301 ------------------------------------------------------------------------------
302 <IfModule mpm_prefork_module>
307 MaxRequestsPerChild 10000
309 ------------------------------------------------------------------------------
310 d. (Ubuntu Trusty) As the *root* user, edit
311 /etc/apache2/mods-available/mpm_prefork.conf to match the above values.
312 Then, also as the *root* user, enable the mpm_prefork module by doing:
315 ------------------------------------------------------------------------------
318 ------------------------------------------------------------------------------
320 6. (Fedora): As the *root* Linux account, edit the `/etc/httpd/eg_vhost.conf`
321 file to change references from the non-existent `/etc/apache2/` directory
323 7. (Debian and Ubuntu Precise): As the *root* Linux account, enable the Evergreen site:
326 ------------------------------------------------------------------------------
327 a2dissite default # OPTIONAL: disable the default site (the "It Works" page)
329 ------------------------------------------------------------------------------
334 ------------------------------------------------------------------------------
335 a2dissite 000-default # OPTIONAL: disable the default site (the "It Works" page)
337 ------------------------------------------------------------------------------
339 8. (Ubuntu): As the *root* Linux account, enable Apache to write
340 to the lock directory; this is currently necessary because Apache
341 is running as the `opensrf` user:
344 ------------------------------------------------------------------------------
345 chown opensrf /var/lock/apache2
346 ------------------------------------------------------------------------------
348 Configure OpenSRF for the Evergreen application
349 -----------------------------------------------
350 There are a number of example OpenSRF configuration files in `/openils/conf/`
351 that you can use as a template for your Evergreen installation. Issue the
352 following commands as the *opensrf* Linux account:
355 ------------------------------------------------------------------------------
356 cp -b /openils/conf/opensrf_core.xml.example /openils/conf/opensrf_core.xml
357 cp -b /openils/conf/opensrf.xml.example /openils/conf/opensrf.xml
358 ------------------------------------------------------------------------------
360 When you installed OpenSRF, you created four Jabber users on two
361 separate domains and edited the `opensrf_core.xml` file accordingly. Please
362 refer back to the OpenSRF README and, as the *opensrf* Linux account, edit the
363 Evergreen version of the `opensrf_core.xml` file using the same Jabber users
364 and domains as you used while installing and testing OpenSRF.
367 The `-b` flag tells the `cp` command to create a backup version of the
368 destination file. The backup version of the destination file has a tilde (`~`)
369 appended to the file name, so if you have forgotten the Jabber users and
370 domains, you can retrieve the settings from the backup version of the files.
372 `eg_db_config`, described in the following section, sets the database
373 connection information in `opensrf.xml` for you.
375 Creating the Evergreen database
376 -------------------------------
378 Setting up the PostgreSQL server
379 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
381 For production use, most libraries install the PostgreSQL database server on a
382 dedicated machine. Therefore, by default, the `Makefile.install` prerequisite
383 installer does *not* install the PostgreSQL 9 database server that is required
384 by every Evergreen system. You can install the packages required by Debian or
385 Ubuntu on the machine of your choice using the following commands as the
386 *root* Linux account:
388 .(Debian / Ubuntu / Fedora) Installing PostgreSQL server packages
390 Each OS build target provides the postgres server installation packages
391 required for each operating system. To install Postgres server packages,
392 use the make target 'postgres-server-<OSTYPE>'. Choose the most appropriate
393 command below based on your operating system.
396 ------------------------------------------------------------------------------
397 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-wheezy
398 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-squeeze
399 make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-precise
400 make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-trusty
401 make -f Open-ILS/src/extras/Makefile.install postgres-server-fedora
402 ------------------------------------------------------------------------------
404 .(Fedora) Postgres initialization
406 Installing Postgres on Fedora also requires you to initialize the PostgreSQL
407 cluster and start the service. Issue the following commands as the *root* user:
410 ------------------------------------------------------------------------------
411 postgresql-setup initdb
412 systemctl start postgresql
413 ------------------------------------------------------------------------------
415 For a standalone PostgreSQL server, install the following Perl modules for your
416 distribution as the *root* Linux account:
420 ---------------------------------------------------------------------------------
422 ---------------------------------------------------------------------------------
424 .(Debian "wheezy" and Ubuntu Trusty)
425 No extra modules required for these distributions.
429 ------------------------------------------------------------------------------
431 ------------------------------------------------------------------------------
433 You need to create a PostgreSQL superuser to create and access the database.
434 Issue the following command as the *postgres* Linux account to create a new
435 PostgreSQL superuser named `evergreen`. When prompted, enter the new user's
439 ------------------------------------------------------------------------------
440 createuser -s -P evergreen
441 ------------------------------------------------------------------------------
443 .Enabling connections to the PostgreSQL database
445 Your PostgreSQL database may be configured by default to prevent connections,
446 for example, it might reject attempts to connect via TCP/IP or from other
447 servers. To enable TCP/IP connections from localhost, check your `pg_hba.conf`
448 file, found in the `/etc/postgresql/` directory on Debian and Ubuntu, and in
449 the `/var/lib/pgsql/data/` directory on Fedora. A simple way to enable TCP/IP
450 connections from localhost to all databases with password authentication, which
451 would be suitable for a test install of Evergreen on a single server, is to
452 ensure the file contains the following entries _before_ any "host ... ident"
455 ------------------------------------------------------------------------------
456 host all all ::1/128 md5
457 host all all 127.0.0.1/32 md5
458 ------------------------------------------------------------------------------
460 When you change the `pg_hba.conf` file, you will need to reload PostgreSQL to
461 make the changes take effect. For more information on configuring connectivity
463 http://www.postgresql.org/docs/devel/static/auth-pg-hba-conf.html
465 Creating the Evergreen database and schema
466 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
468 Once you have created the *evergreen* PostgreSQL account, you also need to
469 create the database and schema, and configure your configuration files to point
470 at the database server. Issue the following command as the *root* Linux account
471 from inside the Evergreen source directory, replacing <user>, <password>,
472 <hostname>, <port>, and <dbname> with the appropriate values for your
473 PostgreSQL database (where <user> and <password> are for the *evergreen*
474 PostgreSQL account you just created), and replace <admin-user> and <admin-pass>
475 with the values you want for the *egadmin* Evergreen administrator account:
478 ------------------------------------------------------------------------------
479 perl Open-ILS/src/support-scripts/eg_db_config --update-config \
480 --service all --create-database --create-schema --create-offline \
481 --user <user> --password <password> --hostname <hostname> --port <port> \
482 --database <dbname> --admin-user <admin-user> --admin-pass <admin-pass>
483 ------------------------------------------------------------------------------
485 This creates the database and schema and configures all of the services in
486 your `/openils/conf/opensrf.xml` configuration file to point to that database.
487 It also creates the configuration files required by the Evergreen `cgi-bin`
488 administration scripts, and sets the user name and password for the *egadmin*
489 Evergreen administrator account to your requested values.
491 You can get a complete set of options for `eg_db_config` by passing the
496 If you add the `--load-all-sample` parameter to the `eg_db_config` command,
497 a set of authority and bibliographic records, call numbers, copies, staff
498 and regular users, and transactions will be loaded into your target
499 database. This sample dataset is commonly referred to as the _concerto_
500 sample data, and can be useful for testing out Evergreen functionality and
501 for creating problem reports that developers can easily recreate with their
502 own copy of the _concerto_ sample data.
504 Creating the database on a remote server
505 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
506 In a production instance of Evergreen, your PostgreSQL server should be
507 installed on a dedicated server.
509 PostgreSQL 9.1 and later
510 ^^^^^^^^^^^^^^^^^^^^^^^^
511 To create the database instance on a remote database server running PostgreSQL
512 9.1 or later, simply use the `--create-database` flag on `eg_db_config`.
516 1. As the *root* Linux account, start the `memcached` and `ejabberd` services
517 (if they aren't already running):
520 ------------------------------------------------------------------------------
521 /etc/init.d/ejabberd start
522 /etc/init.d/memcached start
523 ------------------------------------------------------------------------------
525 2. As the *opensrf* Linux account, start Evergreen. The `-l` flag in the
526 following command is only necessary if you want to force Evergreen to treat the
527 hostname as `localhost`; if you configured `opensrf.xml` using the real
528 hostname of your machine as returned by `perl -ENet::Domain 'print
529 Net::Domain::hostfqdn() . "\n";'`, you should not use the `-l` flag.
532 ------------------------------------------------------------------------------
533 osrf_control -l --start-all
534 ------------------------------------------------------------------------------
536 ** If you receive the error message `bash: osrf_control: command not found`,
537 then your environment variable `PATH` does not include the `/openils/bin`
538 directory; this should have been set in the *opensrf* Linux account's
539 `.bashrc` configuration file. To manually set the `PATH` variable, edit the
540 configuration file `~/.bashrc` as the *opensrf* Linux account and add the
544 ------------------------------------------------------------------------------
545 export PATH=$PATH:/openils/bin
546 ------------------------------------------------------------------------------
548 3. As the *opensrf* Linux account, generate the Web files needed by the staff
549 client and catalogue and update the organization unit proximity (you need to do
550 this the first time you start Evergreen, and after that each time you change the library org unit configuration.
554 ------------------------------------------------------------------------------
556 ------------------------------------------------------------------------------
558 4. As the *root* Linux account, restart the Apache Web server:
561 ------------------------------------------------------------------------------
562 /etc/init.d/apache2 restart
563 ------------------------------------------------------------------------------
565 If the Apache Web server was running when you started the OpenSRF services, you
566 might not be able to successfully log in to the OPAC or staff client until the
567 Apache Web server is restarted.
569 Testing connections to Evergreen
570 --------------------------------
572 Once you have installed and started Evergreen, test your connection to
573 Evergreen via `srfsh`. As the *opensrf* Linux account, issue the following
574 commands to start `srfsh` and try to log onto the Evergreen server using the
575 *egadmin* Evergreen administrator user name and password that you set using the
576 `eg_db_config` command:
579 ------------------------------------------------------------------------------
581 srfsh% login <admin-user> <admin-pass>
582 ------------------------------------------------------------------------------
584 You should see a result like:
586 Received Data: "250bf1518c7527a03249858687714376"
587 ------------------------------------
588 Request Completed Successfully
589 Request Time in seconds: 0.045286
590 ------------------------------------
594 "textcode":"SUCCESS",
597 "stacktrace":"oils_auth.c:304",
599 "authtoken":"e5f9827cc0f93b503a1cc66bee6bdd1a",
605 ------------------------------------
606 Request Completed Successfully
607 Request Time in seconds: 1.336568
608 ------------------------------------
609 [[install-troubleshooting-1]]
610 If this does not work, it's time to do some troubleshooting.
612 * As the *opensrf* Linux account, run the `settings-tester.pl` script to see
613 if it finds any system configuration problems. The script is found at
614 `Open-ILS/src/support-scripts/settings-tester.pl` in the Evergreen source
616 * Follow the steps in the http://evergreen-ils.org/dokuwiki/doku.php?id=troubleshooting:checking_for_errors[troubleshooting guide].
617 * If you have faithfully followed the entire set of installation steps
618 listed here, you are probably extremely close to a working system.
619 Gather your configuration files and log files and contact the
620 http://evergreen-ils.org/communicate/mailing-lists/[Evergreen development
621 mailing list] for assistance before making any drastic changes to your system
627 Need help installing or using Evergreen? Join the mailing lists at
628 http://evergreen-ils.org/communicate/mailing-lists/ or contact us on the Freenode
629 IRC network on the #evergreen channel.
633 This work is licensed under the Creative Commons Attribution-ShareAlike 3.0
634 Unported License. To view a copy of this license, visit
635 http://creativecommons.org/licenses/by-sa/3.0/ or send a letter to Creative
636 Commons, 444 Castro Street, Suite 900, Mountain View, California, 94041, USA.