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 4. OPTIONAL: Developer additions
94 To perform certain developer tasks from a Git source code checkout,
95 additional packages may be required. As the *root* Linux account:
97 * To install packages needed for retrieving and managing web dependencies,
98 use the <osname>-developer Makefile.install target. Currently,
99 this is only needed for building and installing the web
103 ------------------------------------------------------------------------------
104 make -f Open-ILS/src/extras/Makefile.install <osname>-developer
105 ------------------------------------------------------------------------------
107 * To install packages required for building Evergreen translations, use
108 the <osname>-translator Makefile.install target.
111 ------------------------------------------------------------------------------
112 make -f Open-ILS/src/extras/Makefile.install <osname>-translator
113 ------------------------------------------------------------------------------
115 * To install packages required for building Evergreen release bundles, use
116 the <osname>-packager Makefile.install target.
119 ------------------------------------------------------------------------------
120 make -f Open-ILS/src/extras/Makefile.install <osname>-packager
121 ------------------------------------------------------------------------------
123 Extra steps for web staff client
124 --------------------------------
127 Skip this entire section if you are using an official release tarball downloaded
128 from http://evergreen-ils.org/downloads
130 Install dependencies for AngularJS web staff client
131 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
134 You may skip this section if you have installed the
135 <<optional_developer_additions,optional developer additions>>. You will still need to do the following
136 steps in <<install_files_for_web_staff_client,Install files for web staff client>>.
138 1. Install the long-term stability (LTS) release of
139 https://nodejs.org[Node.js]. Add the Node.js `/bin` directory to your
140 environment variable `PATH`.
142 [[install_files_for_web_staff_client]]
143 Install files for web staff client
144 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
146 1. Building, Testing, Minification: The remaining steps all take place within
147 the staff JS web root:
150 ------------------------------------------------------------------------------
151 cd $EVERGREEN_ROOT/Open-ILS/web/js/ui/default/staff/
152 ------------------------------------------------------------------------------
154 2. Install Project-local Dependencies. npm inspects the 'package.json' file
155 for dependencies and fetches them from the Node package network.
158 ------------------------------------------------------------------------------
159 npm install # fetch JS dependencies
160 ------------------------------------------------------------------------------
162 3. Run the build script.
165 ------------------------------------------------------------------------------
166 # build, run tests, concat+minify
169 ------------------------------------------------------------------------------
171 Install dependencies for Angular web staff client
172 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
175 You may skip this section if you have installed the
176 <<optional_developer_additions,optional developer additions>>. You will still need to do the following
177 steps in <<install_files_for_angular_web_staff_client,Install files for web staff client>>.
179 1. Install the long-term stability (LTS) release of
180 https://nodejs.org[Node.js]. Add the Node.js `/bin` directory to your
181 environment variable `PATH`.
183 [[install_files_for_angular_web_staff_client]]
184 Install files for web staff client
185 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
187 1. Building, Testing, Minification: The remaining steps all take place within
188 the Angalar staff root:
191 ------------------------------------------------------------------------------
192 cd $EVERGREEN_ROOT/Open-ILS/src/eg2/
193 ------------------------------------------------------------------------------
195 2. Install Project-local Dependencies. npm inspects the 'package.json' file
196 for dependencies and fetches them from the Node package network.
199 ------------------------------------------------------------------------------
200 npm install # fetch JS dependencies
201 ------------------------------------------------------------------------------
203 3. Run the build script.
206 ------------------------------------------------------------------------------
207 # build and run tests
210 ------------------------------------------------------------------------------
212 Configuration and compilation instructions
213 ------------------------------------------
215 For the time being, we are still installing everything in the `/openils/`
216 directory. From the Evergreen source directory, issue the following commands as
217 the *user* Linux account to configure and build Evergreen:
220 ------------------------------------------------------------------------------
221 PATH=/openils/bin:$PATH ./configure --prefix=/openils --sysconfdir=/openils/conf
223 ------------------------------------------------------------------------------
225 These instructions assume that you have also installed OpenSRF under `/openils/`.
226 If not, please adjust PATH as needed so that the Evergreen `configure` script
227 can find `osrf_config`.
229 Installation instructions
230 -------------------------
232 1. Once you have configured and compiled Evergreen, issue the following
233 command as the *root* Linux account to install Evergreen and copy
234 example configuration files to `/openils/conf`.
237 ------------------------------------------------------------------------------
239 ------------------------------------------------------------------------------
241 Change ownership of the Evergreen files
242 ---------------------------------------
244 All files in the `/openils/` directory and subdirectories must be owned by the
245 `opensrf` user. Issue the following command as the *root* Linux account to
246 change the ownership on the files:
249 ------------------------------------------------------------------------------
250 chown -R opensrf:opensrf /openils
251 ------------------------------------------------------------------------------
256 On Debian Stretch, run the following command as the root user:
259 ------------------------------------------------------------------------------
261 ------------------------------------------------------------------------------
263 Additional Instructions for Developers
264 --------------------------------------
267 Skip this section if you are using an official release tarball downloaded
268 from http://evergreen-ils.org/egdownloads
270 Developers working directly with the source code from the Git repository,
271 rather than an official release tarball, need to install the Dojo Toolkit
272 set of JavaScript libraries. The appropriate version of Dojo is included in
273 Evergreen release tarballs. Developers should install the Dojo 1.3.3 version
274 of Dojo by issuing the following commands as the *opensrf* Linux account:
277 ------------------------------------------------------------------------------
278 wget http://download.dojotoolkit.org/release-1.3.3/dojo-release-1.3.3.tar.gz
279 tar -C /openils/var/web/js -xzf dojo-release-1.3.3.tar.gz
280 cp -r /openils/var/web/js/dojo-release-1.3.3/* /openils/var/web/js/dojo/.
281 ------------------------------------------------------------------------------
284 Configure the Apache Web server
285 -------------------------------
287 . Use the example configuration files to configure your Web server for
288 the Evergreen catalog, web staff client, Web services, and administration
289 interfaces. Issue the following commands as the *root* Linux account:
292 ------------------------------------------------------------------------------------
293 cp Open-ILS/examples/apache_24/eg_24.conf /etc/apache2/sites-available/eg.conf
294 cp Open-ILS/examples/apache_24/eg_vhost_24.conf /etc/apache2/eg_vhost.conf
295 cp Open-ILS/examples/apache_24/eg_startup /etc/apache2/
297 mkdir /etc/apache2/ssl
299 ------------------------------------------------------------------------------------
301 . The `openssl` command cuts a new SSL key for your Apache server. For a
302 production server, you should purchase a signed SSL certificate, but you can
303 just use a self-signed certificate and accept the warnings in the
304 and browser during testing and development. Create an SSL key for the Apache
305 server by issuing the following command as the *root* Linux account:
308 ------------------------------------------------------------------------------
309 openssl req -new -x509 -days 365 -nodes -out server.crt -keyout server.key
310 ------------------------------------------------------------------------------
312 . As the *root* Linux account, edit the `eg.conf` file that you copied into
314 a. To enable access to the offline upload / execute interface from any
315 workstation on any network, make the following change (and note that
316 you *must* secure this for a production instance):
317 * Replace `Require host 10.0.0.0/8` with `Require all granted`
318 . Change the user for the Apache server.
319 * As the *root* Linux account, edit
320 `/etc/apache2/envvars`. Change `export APACHE_RUN_USER=www-data` to
321 `export APACHE_RUN_USER=opensrf`.
322 . As the *root* Linux account, configure Apache with KeepAlive settings
323 appropriate for Evergreen. Higher values can improve the performance of a
324 single client by allowing multiple requests to be sent over the same TCP
325 connection, but increase the risk of using up all available Apache child
326 processes and memory.
327 * Edit `/etc/apache2/apache2.conf`.
328 a. Change `KeepAliveTimeout` to `1`.
329 b. Change `MaxKeepAliveRequests` to `100`.
330 . As the *root* Linux account, configure the prefork module to start and keep
331 enough Apache servers available to provide quick responses to clients without
332 running out of memory. The following settings are a good starting point for a
333 site that exposes the default Evergreen catalogue to the web:
335 .`/etc/apache2/mods-available/mpm_prefork.conf`
337 ------------------------------------------------------------------------------
338 <IfModule mpm_prefork_module>
343 MaxConnectionsPerChild 500
345 ------------------------------------------------------------------------------
347 . As the *root* user, enable the mpm_prefork module:
350 ------------------------------------------------------------------------------
353 ------------------------------------------------------------------------------
355 . As the *root* Linux account, enable the Evergreen site:
358 ------------------------------------------------------------------------------
359 a2dissite 000-default # OPTIONAL: disable the default site (the "It Works" page)
361 ------------------------------------------------------------------------------
363 . As the *root* Linux account, enable Apache to write
364 to the lock directory; this is currently necessary because Apache
365 is running as the `opensrf` user:
368 ------------------------------------------------------------------------------
369 chown opensrf /var/lock/apache2
370 ------------------------------------------------------------------------------
372 Learn more about additional Apache options in the following sections:
374 * <<_apache_rewrite_tricks,Apache Rewrite Tricks>>
375 * <<_apache_access_handler_perl_module,Apache Access Handler Perl Module>>
377 Configure OpenSRF for the Evergreen application
378 -----------------------------------------------
379 There are a number of example OpenSRF configuration files in `/openils/conf/`
380 that you can use as a template for your Evergreen installation. Issue the
381 following commands as the *opensrf* Linux account:
384 ------------------------------------------------------------------------------
385 cp -b /openils/conf/opensrf_core.xml.example /openils/conf/opensrf_core.xml
386 cp -b /openils/conf/opensrf.xml.example /openils/conf/opensrf.xml
387 ------------------------------------------------------------------------------
389 When you installed OpenSRF, you created four Jabber users on two
390 separate domains and edited the `opensrf_core.xml` file accordingly. Please
391 refer back to the OpenSRF README and, as the *opensrf* Linux account, edit the
392 Evergreen version of the `opensrf_core.xml` file using the same Jabber users
393 and domains as you used while installing and testing OpenSRF.
396 The `-b` flag tells the `cp` command to create a backup version of the
397 destination file. The backup version of the destination file has a tilde (`~`)
398 appended to the file name, so if you have forgotten the Jabber users and
399 domains, you can retrieve the settings from the backup version of the files.
401 `eg_db_config`, described in <<_creating_the_evergreen_database,Creating the Evergreen
402 database>>, sets the database connection information in `opensrf.xml` for you.
404 Configure action triggers for the Evergreen application
405 -------------------------------------------------------
406 _Action Triggers_ provide hooks for the system to perform actions when a given
407 event occurs; for example, to generate reminder or overdue notices, the
408 `checkout.due` hook is processed and events are triggered for potential actions
409 if there is no checkin time.
411 To enable the default set of hooks, issue the following command as the
412 *opensrf* Linux account:
415 ------------------------------------------------------------------------------
416 cp -b /openils/conf/action_trigger_filters.json.example /openils/conf/action_trigger_filters.json
417 ------------------------------------------------------------------------------
419 For more information about configuring and running action triggers, see
420 <<_processing_action_triggers,Notifications / Action Triggers>>.
422 Creating the Evergreen database
423 -------------------------------
425 Setting up the PostgreSQL server
426 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
428 For production use, most libraries install the PostgreSQL database server on a
429 dedicated machine. Therefore, by default, the `Makefile.install` prerequisite
430 installer does *not* install the PostgreSQL 9 database server that is required
431 by every Evergreen system. You can install the packages required by Debian or
432 Ubuntu on the machine of your choice using the following commands as the
433 *root* Linux account:
435 . Installing PostgreSQL server packages
437 Each OS build target provides the postgres server installation packages
438 required for each operating system. To install Postgres server packages,
439 use the make target 'postgres-server-<OSTYPE>'. Choose the most appropriate
440 command below based on your operating system.
443 ------------------------------------------------------------------------------
444 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-stretch
445 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-jessie
446 make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-trusty
447 make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-xenial
448 ------------------------------------------------------------------------------
450 For a standalone PostgreSQL server, install the following Perl modules for your
451 distribution as the *root* Linux account:
454 No extra modules required for these distributions.
456 You need to create a PostgreSQL superuser to create and access the database.
457 Issue the following command as the *postgres* Linux account to create a new
458 PostgreSQL superuser named `evergreen`. When prompted, enter the new user's
462 ------------------------------------------------------------------------------
463 createuser -s -P evergreen
464 ------------------------------------------------------------------------------
466 .Enabling connections to the PostgreSQL database
468 Your PostgreSQL database may be configured by default to prevent connections,
469 for example, it might reject attempts to connect via TCP/IP or from other
470 servers. To enable TCP/IP connections from localhost, check your `pg_hba.conf`
471 file, found in the `/etc/postgresql/` directory on Debian and Ubuntu.
472 A simple way to enable TCP/IP
473 connections from localhost to all databases with password authentication, which
474 would be suitable for a test install of Evergreen on a single server, is to
475 ensure the file contains the following entries _before_ any "host ... ident"
478 ------------------------------------------------------------------------------
479 host all all ::1/128 md5
480 host all all 127.0.0.1/32 md5
481 ------------------------------------------------------------------------------
483 When you change the `pg_hba.conf` file, you will need to reload PostgreSQL to
484 make the changes take effect. For more information on configuring connectivity
486 http://www.postgresql.org/docs/devel/static/auth-pg-hba-conf.html
488 Creating the Evergreen database and schema
489 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
491 Once you have created the *evergreen* PostgreSQL account, you also need to
492 create the database and schema, and configure your configuration files to point
493 at the database server. Issue the following command as the *root* Linux account
494 from inside the Evergreen source directory, replacing <user>, <password>,
495 <hostname>, <port>, and <dbname> with the appropriate values for your
496 PostgreSQL database (where <user> and <password> are for the *evergreen*
497 PostgreSQL account you just created), and replace <admin-user> and <admin-pass>
498 with the values you want for the *egadmin* Evergreen administrator account:
501 ------------------------------------------------------------------------------
502 perl Open-ILS/src/support-scripts/eg_db_config --update-config \
503 --service all --create-database --create-schema --create-offline \
504 --user <user> --password <password> --hostname <hostname> --port <port> \
505 --database <dbname> --admin-user <admin-user> --admin-pass <admin-pass>
506 ------------------------------------------------------------------------------
508 This creates the database and schema and configures all of the services in
509 your `/openils/conf/opensrf.xml` configuration file to point to that database.
510 It also creates the configuration files required by the Evergreen `cgi-bin`
511 administration scripts, and sets the user name and password for the *egadmin*
512 Evergreen administrator account to your requested values.
514 You can get a complete set of options for `eg_db_config` by passing the
519 If you add the `--load-all-sample` parameter to the `eg_db_config` command,
520 a set of authority and bibliographic records, call numbers, copies, staff
521 and regular users, and transactions will be loaded into your target
522 database. This sample dataset is commonly referred to as the _concerto_
523 sample data, and can be useful for testing out Evergreen functionality and
524 for creating problem reports that developers can easily recreate with their
525 own copy of the _concerto_ sample data.
527 Creating the database on a remote server
528 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
529 In a production instance of Evergreen, your PostgreSQL server should be
530 installed on a dedicated server.
532 PostgreSQL 9.4 and later
533 ^^^^^^^^^^^^^^^^^^^^^^^^
534 To create the database instance on a remote database server running PostgreSQL
535 9.4 or later, simply use the `--create-database` flag on `eg_db_config`.
539 1. As the *root* Linux account, start the `memcached` and `ejabberd` services
540 (if they aren't already running):
543 ------------------------------------------------------------------------------
544 /etc/init.d/ejabberd start
545 /etc/init.d/memcached start
546 ------------------------------------------------------------------------------
548 2. As the *opensrf* Linux account, start Evergreen. The `-l` flag in the
549 following command is only necessary if you want to force Evergreen to treat the
550 hostname as `localhost`; if you configured `opensrf.xml` using the real
551 hostname of your machine as returned by `perl -ENet::Domain 'print
552 Net::Domain::hostfqdn() . "\n";'`, you should not use the `-l` flag.
555 ------------------------------------------------------------------------------
556 osrf_control -l --start-all
557 ------------------------------------------------------------------------------
559 ** If you receive the error message `bash: osrf_control: command not found`,
560 then your environment variable `PATH` does not include the `/openils/bin`
561 directory; this should have been set in the *opensrf* Linux account's
562 `.bashrc` configuration file. To manually set the `PATH` variable, edit the
563 configuration file `~/.bashrc` as the *opensrf* Linux account and add the
567 ------------------------------------------------------------------------------
568 export PATH=$PATH:/openils/bin
569 ------------------------------------------------------------------------------
571 3. As the *opensrf* Linux account, generate the Web files needed by the web staff
572 client and catalogue and update the organization unit proximity (you need to do
573 this the first time you start Evergreen, and after that each time you change the library org unit configuration.
577 ------------------------------------------------------------------------------
579 ------------------------------------------------------------------------------
581 4. As the *root* Linux account, restart the Apache Web server:
584 ------------------------------------------------------------------------------
585 /etc/init.d/apache2 restart
586 ------------------------------------------------------------------------------
588 If the Apache Web server was running when you started the OpenSRF services, you
589 might not be able to successfully log in to the OPAC or web staff client until the
590 Apache Web server is restarted.
592 Testing connections to Evergreen
593 --------------------------------
595 Once you have installed and started Evergreen, test your connection to
596 Evergreen via `srfsh`. As the *opensrf* Linux account, issue the following
597 commands to start `srfsh` and try to log onto the Evergreen server using the
598 *egadmin* Evergreen administrator user name and password that you set using the
599 `eg_db_config` command:
602 ------------------------------------------------------------------------------
604 srfsh% login <admin-user> <admin-pass>
605 ------------------------------------------------------------------------------
607 You should see a result like:
609 Received Data: "250bf1518c7527a03249858687714376"
610 ------------------------------------
611 Request Completed Successfully
612 Request Time in seconds: 0.045286
613 ------------------------------------
617 "textcode":"SUCCESS",
620 "stacktrace":"oils_auth.c:304",
622 "authtoken":"e5f9827cc0f93b503a1cc66bee6bdd1a",
628 ------------------------------------
629 Request Completed Successfully
630 Request Time in seconds: 1.336568
631 ------------------------------------
632 [[install-troubleshooting-1]]
633 If this does not work, it's time to do some troubleshooting.
635 * As the *opensrf* Linux account, run the `settings-tester.pl` script to see
636 if it finds any system configuration problems. The script is found at
637 `Open-ILS/src/support-scripts/settings-tester.pl` in the Evergreen source
639 * Follow the steps in the http://evergreen-ils.org/dokuwiki/doku.php?id=troubleshooting:checking_for_errors[troubleshooting guide].
640 * If you have faithfully followed the entire set of installation steps
641 listed here, you are probably extremely close to a working system.
642 Gather your configuration files and log files and contact the
643 http://evergreen-ils.org/communicate/mailing-lists/[Evergreen development
644 mailing list] for assistance before making any drastic changes to your system
650 Need help installing or using Evergreen? Join the mailing lists at
651 http://evergreen-ils.org/communicate/mailing-lists/ or contact us on the Freenode
652 IRC network on the #evergreen channel.
656 This work is licensed under the Creative Commons Attribution-ShareAlike 3.0
657 Unported License. To view a copy of this license, visit
658 http://creativecommons.org/licenses/by-sa/3.0/ or send a letter to Creative
659 Commons, 444 Castro Street, Suite 900, Mountain View, California, 94041, USA.