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 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**: The minimum supported version is 9.4.
58 * **Linux**: Evergreen has been tested on Debian Stretch (9),
59 Debian Jessie (8), Ubuntu Xenial Xerus (16.04), and Ubuntu
61 If you are running an older version of these distributions, you may want
62 to upgrade before upgrading Evergreen. For instructions on upgrading these
63 distributions, visit the Debian or Ubuntu websites.
64 * **OpenSRF**: The minimum supported version of OpenSRF is 3.0.0.
67 Evergreen has a number of prerequisite packages that must be installed
68 before you can successfully configure, compile, and install Evergreen.
70 1. Begin by installing the most recent version of OpenSRF (3.0.0 or later).
71 You can download OpenSRF releases from http://evergreen-ils.org/opensrf-downloads/
72 2. On some distributions, it is necessary to install PostgreSQL 9.4+ from external
75 * Ubuntu (Trusty) comes with an older version of PostgreSQL, so
76 steps are taken to automatically utilize the PostgreSQL
77 community's apt sources.
78 (For complete details, see: https://wiki.postgresql.org/wiki/Apt)
79 * Debian (Jessie/Stretch) and Ubuntu (Xenial) comes with PostgreSQL 9.4+,
80 so no additional steps are required.
82 3. Issue the following commands as the *root* Linux account to install
83 prerequisites using the `Makefile.install` prerequisite installer,
84 substituting `debian-stretch`, `debian-jessie`,`ubuntu-xenial`,
85 or `ubuntu-trusty` for <osname> below:
88 ------------------------------------------------------------------------------
89 make -f Open-ILS/src/extras/Makefile.install <osname>
90 ------------------------------------------------------------------------------
92 [[optional_developer_additions]]
93 4. OPTIONAL: Developer additions
95 To perform certain developer tasks from a Git source code checkout,
96 additional packages may be required. As the *root* Linux account:
98 * To install packages needed for retrieving and managing web dependencies,
99 use the <osname>-developer Makefile.install target. Currently,
100 this is only needed for building and installing the web
104 ------------------------------------------------------------------------------
105 make -f Open-ILS/src/extras/Makefile.install <osname>-developer
106 ------------------------------------------------------------------------------
108 * To install packages required for building Evergreen translations, use
109 the <osname>-translator Makefile.install target.
112 ------------------------------------------------------------------------------
113 make -f Open-ILS/src/extras/Makefile.install <osname>-translator
114 ------------------------------------------------------------------------------
116 * To install packages required for building Evergreen release bundles, use
117 the <osname>-packager Makefile.install target.
120 ------------------------------------------------------------------------------
121 make -f Open-ILS/src/extras/Makefile.install <osname>-packager
122 ------------------------------------------------------------------------------
124 Extra steps for web staff client
125 --------------------------------
128 Skip this entire section if you are using an official release tarball downloaded
129 from http://evergreen-ils.org/downloads
131 Install dependencies for web staff client
132 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
135 You may skip this section if you have installed the
136 <<optional_developer_additions,optional developer additions>>. You will still need to do the following
137 steps in <<install_files_for_web_staff_client,Install files for web staff client>>.
139 1. Install the long-term stability (LTS) release of
140 https://nodejs.org[Node.js]. Add the Node.js `/bin` directory to your
141 environment variable `PATH`.
143 [[install_files_for_web_staff_client]]
144 Install AngularJS files for web staff client
145 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
147 1. Building, Testing, Minification: The remaining steps all take place within
148 the staff JS web root:
151 ------------------------------------------------------------------------------
152 cd $EVERGREEN_ROOT/Open-ILS/web/js/ui/default/staff/
153 ------------------------------------------------------------------------------
155 2. Install Project-local Dependencies. npm inspects the 'package.json' file
156 for dependencies and fetches them from the Node package network.
159 ------------------------------------------------------------------------------
160 npm install # fetch JS dependencies
161 ------------------------------------------------------------------------------
163 3. Run the build script.
166 ------------------------------------------------------------------------------
167 # build, run tests, concat+minify
170 ------------------------------------------------------------------------------
172 [[install_files_for_angular_web_staff_client]]
173 Install Angular files for web staff client
174 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
176 1. Building, Testing, Minification: The remaining steps all take place within
177 the Angular staff root:
180 ------------------------------------------------------------------------------
181 cd $EVERGREEN_ROOT/Open-ILS/src/eg2/
182 ------------------------------------------------------------------------------
184 2. Install Project-local Dependencies. npm inspects the 'package.json' file
185 for dependencies and fetches them from the Node package network.
188 ------------------------------------------------------------------------------
189 npm install # fetch JS dependencies
190 ------------------------------------------------------------------------------
192 3. Run the build script.
195 ------------------------------------------------------------------------------
196 # build and run tests
199 ------------------------------------------------------------------------------
201 Configuration and compilation instructions
202 ------------------------------------------
204 For the time being, we are still installing everything in the `/openils/`
205 directory. From the Evergreen source directory, issue the following commands as
206 the *user* Linux account to configure and build Evergreen:
209 ------------------------------------------------------------------------------
210 PATH=/openils/bin:$PATH ./configure --prefix=/openils --sysconfdir=/openils/conf
212 ------------------------------------------------------------------------------
214 These instructions assume that you have also installed OpenSRF under `/openils/`.
215 If not, please adjust PATH as needed so that the Evergreen `configure` script
216 can find `osrf_config`.
218 Installation instructions
219 -------------------------
221 1. Once you have configured and compiled Evergreen, issue the following
222 command as the *root* Linux account to install Evergreen and copy
223 example configuration files to `/openils/conf`.
226 ------------------------------------------------------------------------------
228 ------------------------------------------------------------------------------
230 Change ownership of the Evergreen files
231 ---------------------------------------
233 All files in the `/openils/` directory and subdirectories must be owned by the
234 `opensrf` user. Issue the following command as the *root* Linux account to
235 change the ownership on the files:
238 ------------------------------------------------------------------------------
239 chown -R opensrf:opensrf /openils
240 ------------------------------------------------------------------------------
245 On Debian Stretch, run the following command as the root user:
248 ------------------------------------------------------------------------------
250 ------------------------------------------------------------------------------
252 Additional Instructions for Developers
253 --------------------------------------
256 Skip this section if you are using an official release tarball downloaded
257 from http://evergreen-ils.org/egdownloads
259 Developers working directly with the source code from the Git repository,
260 rather than an official release tarball, need to install the Dojo Toolkit
261 set of JavaScript libraries. The appropriate version of Dojo is included in
262 Evergreen release tarballs. Developers should install the Dojo 1.3.3 version
263 of Dojo by issuing the following commands as the *opensrf* Linux account:
266 ------------------------------------------------------------------------------
267 wget http://download.dojotoolkit.org/release-1.3.3/dojo-release-1.3.3.tar.gz
268 tar -C /openils/var/web/js -xzf dojo-release-1.3.3.tar.gz
269 cp -r /openils/var/web/js/dojo-release-1.3.3/* /openils/var/web/js/dojo/.
270 ------------------------------------------------------------------------------
273 Configure the Apache Web server
274 -------------------------------
276 . Use the example configuration files to configure your Web server for
277 the Evergreen catalog, web staff client, Web services, and administration
278 interfaces. Issue the following commands as the *root* Linux account:
281 ------------------------------------------------------------------------------------
282 cp Open-ILS/examples/apache_24/eg_24.conf /etc/apache2/sites-available/eg.conf
283 cp Open-ILS/examples/apache_24/eg_vhost_24.conf /etc/apache2/eg_vhost.conf
284 cp Open-ILS/examples/apache_24/eg_startup /etc/apache2/
286 mkdir /etc/apache2/ssl
288 ------------------------------------------------------------------------------------
290 . The `openssl` command cuts a new SSL key for your Apache server. For a
291 production server, you should purchase a signed SSL certificate, but you can
292 just use a self-signed certificate and accept the warnings in the
293 and browser during testing and development. Create an SSL key for the Apache
294 server by issuing the following command as the *root* Linux account:
297 ------------------------------------------------------------------------------
298 openssl req -new -x509 -days 365 -nodes -out server.crt -keyout server.key
299 ------------------------------------------------------------------------------
301 . As the *root* Linux account, edit the `eg.conf` file that you copied into
303 a. To enable access to the offline upload / execute interface from any
304 workstation on any network, make the following change (and note that
305 you *must* secure this for a production instance):
306 * Replace `Require host 10.0.0.0/8` with `Require all granted`
307 . Change the user for the Apache server.
308 * As the *root* Linux account, edit
309 `/etc/apache2/envvars`. Change `export APACHE_RUN_USER=www-data` to
310 `export APACHE_RUN_USER=opensrf`.
311 . As the *root* Linux account, configure Apache with KeepAlive settings
312 appropriate for Evergreen. Higher values can improve the performance of a
313 single client by allowing multiple requests to be sent over the same TCP
314 connection, but increase the risk of using up all available Apache child
315 processes and memory.
316 * Edit `/etc/apache2/apache2.conf`.
317 a. Change `KeepAliveTimeout` to `1`.
318 b. Change `MaxKeepAliveRequests` to `100`.
319 . As the *root* Linux account, configure the prefork module to start and keep
320 enough Apache servers available to provide quick responses to clients without
321 running out of memory. The following settings are a good starting point for a
322 site that exposes the default Evergreen catalogue to the web:
324 .`/etc/apache2/mods-available/mpm_prefork.conf`
326 ------------------------------------------------------------------------------
327 <IfModule mpm_prefork_module>
332 MaxConnectionsPerChild 500
334 ------------------------------------------------------------------------------
336 . As the *root* user, enable the mpm_prefork module:
339 ------------------------------------------------------------------------------
342 ------------------------------------------------------------------------------
344 . As the *root* Linux account, enable the Evergreen site:
347 ------------------------------------------------------------------------------
348 a2dissite 000-default # OPTIONAL: disable the default site (the "It Works" page)
350 ------------------------------------------------------------------------------
352 . As the *root* Linux account, enable Apache to write
353 to the lock directory; this is currently necessary because Apache
354 is running as the `opensrf` user:
357 ------------------------------------------------------------------------------
358 chown opensrf /var/lock/apache2
359 ------------------------------------------------------------------------------
361 Learn more about additional Apache options in the following sections:
363 * <<_apache_rewrite_tricks,Apache Rewrite Tricks>>
364 * <<_apache_access_handler_perl_module,Apache Access Handler Perl Module>>
366 Configure OpenSRF for the Evergreen application
367 -----------------------------------------------
368 There are a number of example OpenSRF configuration files in `/openils/conf/`
369 that you can use as a template for your Evergreen installation. Issue the
370 following commands as the *opensrf* Linux account:
373 ------------------------------------------------------------------------------
374 cp -b /openils/conf/opensrf_core.xml.example /openils/conf/opensrf_core.xml
375 cp -b /openils/conf/opensrf.xml.example /openils/conf/opensrf.xml
376 ------------------------------------------------------------------------------
378 When you installed OpenSRF, you created four Jabber users on two
379 separate domains and edited the `opensrf_core.xml` file accordingly. Please
380 refer back to the OpenSRF README and, as the *opensrf* Linux account, edit the
381 Evergreen version of the `opensrf_core.xml` file using the same Jabber users
382 and domains as you used while installing and testing OpenSRF.
385 The `-b` flag tells the `cp` command to create a backup version of the
386 destination file. The backup version of the destination file has a tilde (`~`)
387 appended to the file name, so if you have forgotten the Jabber users and
388 domains, you can retrieve the settings from the backup version of the files.
390 `eg_db_config`, described in <<_creating_the_evergreen_database,Creating the Evergreen
391 database>>, sets the database connection information in `opensrf.xml` for you.
393 Configure action triggers for the Evergreen application
394 -------------------------------------------------------
395 _Action Triggers_ provide hooks for the system to perform actions when a given
396 event occurs; for example, to generate reminder or overdue notices, the
397 `checkout.due` hook is processed and events are triggered for potential actions
398 if there is no checkin time.
400 To enable the default set of hooks, issue the following command as the
401 *opensrf* Linux account:
404 ------------------------------------------------------------------------------
405 cp -b /openils/conf/action_trigger_filters.json.example /openils/conf/action_trigger_filters.json
406 ------------------------------------------------------------------------------
408 For more information about configuring and running action triggers, see
409 <<_processing_action_triggers,Notifications / Action Triggers>>.
411 Creating the Evergreen database
412 -------------------------------
414 Setting up the PostgreSQL server
415 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
417 For production use, most libraries install the PostgreSQL database server on a
418 dedicated machine. Therefore, by default, the `Makefile.install` prerequisite
419 installer does *not* install the PostgreSQL 9 database server that is required
420 by every Evergreen system. You can install the packages required by Debian or
421 Ubuntu on the machine of your choice using the following commands as the
422 *root* Linux account:
424 . Installing PostgreSQL server packages
426 Each OS build target provides the postgres server installation packages
427 required for each operating system. To install Postgres server packages,
428 use the make target 'postgres-server-<OSTYPE>'. Choose the most appropriate
429 command below based on your operating system.
432 ------------------------------------------------------------------------------
433 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-stretch
434 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-jessie
435 make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-trusty
436 make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-xenial
437 ------------------------------------------------------------------------------
439 For a standalone PostgreSQL server, install the following Perl modules for your
440 distribution as the *root* Linux account:
443 No extra modules required for these distributions.
445 You need to create a PostgreSQL superuser to create and access the database.
446 Issue the following command as the *postgres* Linux account to create a new
447 PostgreSQL superuser named `evergreen`. When prompted, enter the new user's
451 ------------------------------------------------------------------------------
452 createuser -s -P evergreen
453 ------------------------------------------------------------------------------
455 .Enabling connections to the PostgreSQL database
457 Your PostgreSQL database may be configured by default to prevent connections,
458 for example, it might reject attempts to connect via TCP/IP or from other
459 servers. To enable TCP/IP connections from localhost, check your `pg_hba.conf`
460 file, found in the `/etc/postgresql/` directory on Debian and Ubuntu.
461 A simple way to enable TCP/IP
462 connections from localhost to all databases with password authentication, which
463 would be suitable for a test install of Evergreen on a single server, is to
464 ensure the file contains the following entries _before_ any "host ... ident"
467 ------------------------------------------------------------------------------
468 host all all ::1/128 md5
469 host all all 127.0.0.1/32 md5
470 ------------------------------------------------------------------------------
472 When you change the `pg_hba.conf` file, you will need to reload PostgreSQL to
473 make the changes take effect. For more information on configuring connectivity
475 http://www.postgresql.org/docs/devel/static/auth-pg-hba-conf.html
477 Creating the Evergreen database and schema
478 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
480 Once you have created the *evergreen* PostgreSQL account, you also need to
481 create the database and schema, and configure your configuration files to point
482 at the database server. Issue the following command as the *root* Linux account
483 from inside the Evergreen source directory, replacing <user>, <password>,
484 <hostname>, <port>, and <dbname> with the appropriate values for your
485 PostgreSQL database (where <user> and <password> are for the *evergreen*
486 PostgreSQL account you just created), and replace <admin-user> and <admin-pass>
487 with the values you want for the *egadmin* Evergreen administrator account:
490 ------------------------------------------------------------------------------
491 perl Open-ILS/src/support-scripts/eg_db_config --update-config \
492 --service all --create-database --create-schema --create-offline \
493 --user <user> --password <password> --hostname <hostname> --port <port> \
494 --database <dbname> --admin-user <admin-user> --admin-pass <admin-pass>
495 ------------------------------------------------------------------------------
497 This creates the database and schema and configures all of the services in
498 your `/openils/conf/opensrf.xml` configuration file to point to that database.
499 It also creates the configuration files required by the Evergreen `cgi-bin`
500 administration scripts, and sets the user name and password for the *egadmin*
501 Evergreen administrator account to your requested values.
503 You can get a complete set of options for `eg_db_config` by passing the
508 If you add the `--load-all-sample` parameter to the `eg_db_config` command,
509 a set of authority and bibliographic records, call numbers, copies, staff
510 and regular users, and transactions will be loaded into your target
511 database. This sample dataset is commonly referred to as the _concerto_
512 sample data, and can be useful for testing out Evergreen functionality and
513 for creating problem reports that developers can easily recreate with their
514 own copy of the _concerto_ sample data.
516 Creating the database on a remote server
517 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
518 In a production instance of Evergreen, your PostgreSQL server should be
519 installed on a dedicated server.
521 PostgreSQL 9.4 and later
522 ^^^^^^^^^^^^^^^^^^^^^^^^
523 To create the database instance on a remote database server running PostgreSQL
524 9.4 or later, simply use the `--create-database` flag on `eg_db_config`.
528 1. As the *root* Linux account, start the `memcached` and `ejabberd` services
529 (if they aren't already running):
532 ------------------------------------------------------------------------------
533 /etc/init.d/ejabberd start
534 /etc/init.d/memcached start
535 ------------------------------------------------------------------------------
537 2. As the *opensrf* Linux account, start Evergreen. The `-l` flag in the
538 following command is only necessary if you want to force Evergreen to treat the
539 hostname as `localhost`; if you configured `opensrf.xml` using the real
540 hostname of your machine as returned by `perl -ENet::Domain 'print
541 Net::Domain::hostfqdn() . "\n";'`, you should not use the `-l` flag.
544 ------------------------------------------------------------------------------
545 osrf_control -l --start-all
546 ------------------------------------------------------------------------------
548 ** If you receive the error message `bash: osrf_control: command not found`,
549 then your environment variable `PATH` does not include the `/openils/bin`
550 directory; this should have been set in the *opensrf* Linux account's
551 `.bashrc` configuration file. To manually set the `PATH` variable, edit the
552 configuration file `~/.bashrc` as the *opensrf* Linux account and add the
556 ------------------------------------------------------------------------------
557 export PATH=$PATH:/openils/bin
558 ------------------------------------------------------------------------------
560 3. As the *opensrf* Linux account, generate the Web files needed by the web staff
561 client and catalogue and update the organization unit proximity (you need to do
562 this the first time you start Evergreen, and after that each time you change the library org unit configuration.
566 ------------------------------------------------------------------------------
568 ------------------------------------------------------------------------------
570 4. As the *root* Linux account, restart the Apache Web server:
573 ------------------------------------------------------------------------------
574 /etc/init.d/apache2 restart
575 ------------------------------------------------------------------------------
577 If the Apache Web server was running when you started the OpenSRF services, you
578 might not be able to successfully log in to the OPAC or web staff client until the
579 Apache Web server is restarted.
581 Testing connections to Evergreen
582 --------------------------------
584 Once you have installed and started Evergreen, test your connection to
585 Evergreen via `srfsh`. As the *opensrf* Linux account, issue the following
586 commands to start `srfsh` and try to log onto the Evergreen server using the
587 *egadmin* Evergreen administrator user name and password that you set using the
588 `eg_db_config` command:
591 ------------------------------------------------------------------------------
593 srfsh% login <admin-user> <admin-pass>
594 ------------------------------------------------------------------------------
596 You should see a result like:
598 Received Data: "250bf1518c7527a03249858687714376"
599 ------------------------------------
600 Request Completed Successfully
601 Request Time in seconds: 0.045286
602 ------------------------------------
606 "textcode":"SUCCESS",
609 "stacktrace":"oils_auth.c:304",
611 "authtoken":"e5f9827cc0f93b503a1cc66bee6bdd1a",
617 ------------------------------------
618 Request Completed Successfully
619 Request Time in seconds: 1.336568
620 ------------------------------------
621 [[install-troubleshooting-1]]
622 If this does not work, it's time to do some troubleshooting.
624 * As the *opensrf* Linux account, run the `settings-tester.pl` script to see
625 if it finds any system configuration problems. The script is found at
626 `Open-ILS/src/support-scripts/settings-tester.pl` in the Evergreen source
628 * Follow the steps in the http://evergreen-ils.org/dokuwiki/doku.php?id=troubleshooting:checking_for_errors[troubleshooting guide].
629 * If you have faithfully followed the entire set of installation steps
630 listed here, you are probably extremely close to a working system.
631 Gather your configuration files and log files and contact the
632 http://evergreen-ils.org/communicate/mailing-lists/[Evergreen development
633 mailing list] for assistance before making any drastic changes to your system
639 Need help installing or using Evergreen? Join the mailing lists at
640 http://evergreen-ils.org/communicate/mailing-lists/ or contact us on the Freenode
641 IRC network on the #evergreen channel.
645 This work is licensed under the Creative Commons Attribution-ShareAlike 3.0
646 Unported License. To view a copy of this license, visit
647 http://creativecommons.org/licenses/by-sa/3.0/ or send a letter to Creative
648 Commons, 444 Castro Street, Suite 900, Mountain View, California, 94041, USA.