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.6.
58 * **Linux**: Evergreen has been tested on
62 Ubuntu Bionic Beaver (18.04),
63 and Ubuntu Xenial Xerus (16.04).
64 If you are running an older version of these distributions, you may want
65 to upgrade before upgrading Evergreen. For instructions on upgrading these
66 distributions, visit the Debian or Ubuntu websites.
67 * **OpenSRF**: The minimum supported version of OpenSRF is 3.2.0.
70 Evergreen has a number of prerequisite packages that must be installed
71 before you can successfully configure, compile, and install Evergreen.
73 1. Begin by installing the most recent version of OpenSRF (3.2.0 or later).
74 You can download OpenSRF releases from http://evergreen-ils.org/opensrf-downloads/
76 2. Issue the following commands as the *root* Linux account to install
77 prerequisites using the `Makefile.install` prerequisite installer,
78 substituting `debian-buster`,`debian-stretch`,`debian-jessie`,`ubuntu-bionic`, or
79 `ubuntu-xenial` for <osname> below:
82 ------------------------------------------------------------------------------
83 make -f Open-ILS/src/extras/Makefile.install <osname>
84 ------------------------------------------------------------------------------
86 [[optional_developer_additions]]
87 3. OPTIONAL: Developer additions
89 To perform certain developer tasks from a Git source code checkout,
90 additional packages may be required. As the *root* Linux account:
92 * To install packages needed for retrieving and managing web dependencies,
93 use the <osname>-developer Makefile.install target. Currently,
94 this is only needed for building and installing the web
98 ------------------------------------------------------------------------------
99 make -f Open-ILS/src/extras/Makefile.install <osname>-developer
100 ------------------------------------------------------------------------------
102 * To install packages required for building Evergreen translations, use
103 the <osname>-translator Makefile.install target.
106 ------------------------------------------------------------------------------
107 make -f Open-ILS/src/extras/Makefile.install <osname>-translator
108 ------------------------------------------------------------------------------
110 * To install packages required for building Evergreen release bundles, use
111 the <osname>-packager Makefile.install target.
114 ------------------------------------------------------------------------------
115 make -f Open-ILS/src/extras/Makefile.install <osname>-packager
116 ------------------------------------------------------------------------------
118 Extra steps for web staff client
119 --------------------------------
122 Skip this entire section if you are using an official release tarball downloaded
123 from http://evergreen-ils.org/downloads
125 Install dependencies for web staff client
126 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
129 You may skip this section if you have installed the
130 <<optional_developer_additions,optional developer additions>>. You will still need to do the following
131 steps in <<install_files_for_web_staff_client,Install files for web staff client>>.
133 1. Install the long-term stability (LTS) release of
134 https://nodejs.org[Node.js]. Add the Node.js `/bin` directory to your
135 environment variable `PATH`.
137 [[install_files_for_web_staff_client]]
138 Install AngularJS files for web staff client
139 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
141 1. Building, Testing, Minification: The remaining steps all take place within
142 the staff JS web root:
145 ------------------------------------------------------------------------------
146 cd $EVERGREEN_ROOT/Open-ILS/web/js/ui/default/staff/
147 ------------------------------------------------------------------------------
149 2. Install Project-local Dependencies. npm inspects the 'package.json' file
150 for dependencies and fetches them from the Node package network.
153 ------------------------------------------------------------------------------
154 npm install # fetch JS dependencies
155 ------------------------------------------------------------------------------
157 3. Run the build script.
160 ------------------------------------------------------------------------------
161 # build, run tests, concat+minify
164 ------------------------------------------------------------------------------
166 [[install_files_for_angular_web_staff_client]]
167 Install Angular files for web staff client
168 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
170 1. Building, Testing, Minification: The remaining steps all take place within
171 the Angular staff root:
174 ------------------------------------------------------------------------------
175 cd $EVERGREEN_ROOT/Open-ILS/src/eg2/
176 ------------------------------------------------------------------------------
178 2. Install Project-local Dependencies. npm inspects the 'package.json' file
179 for dependencies and fetches them from the Node package network.
182 ------------------------------------------------------------------------------
183 npm install # fetch JS dependencies
184 ------------------------------------------------------------------------------
186 3. Run the build script.
189 ------------------------------------------------------------------------------
190 # build and run tests
193 ------------------------------------------------------------------------------
195 Configuration and compilation instructions
196 ------------------------------------------
198 For the time being, we are still installing everything in the `/openils/`
199 directory. From the Evergreen source directory, issue the following commands as
200 the *user* Linux account to configure and build Evergreen:
203 ------------------------------------------------------------------------------
204 PATH=/openils/bin:$PATH ./configure --prefix=/openils --sysconfdir=/openils/conf
206 ------------------------------------------------------------------------------
208 These instructions assume that you have also installed OpenSRF under `/openils/`.
209 If not, please adjust PATH as needed so that the Evergreen `configure` script
210 can find `osrf_config`.
212 Installation instructions
213 -------------------------
215 1. Once you have configured and compiled Evergreen, issue the following
216 command as the *root* Linux account to install Evergreen and copy
217 example configuration files to `/openils/conf`.
220 ------------------------------------------------------------------------------
222 ------------------------------------------------------------------------------
224 Change ownership of the Evergreen files
225 ---------------------------------------
227 All files in the `/openils/` directory and subdirectories must be owned by the
228 `opensrf` user. Issue the following command as the *root* Linux account to
229 change the ownership on the files:
232 ------------------------------------------------------------------------------
233 chown -R opensrf:opensrf /openils
234 ------------------------------------------------------------------------------
239 On Debian Stretch / Buster, run the following command as the root user:
242 ------------------------------------------------------------------------------
244 ------------------------------------------------------------------------------
246 Additional Instructions for Developers
247 --------------------------------------
250 Skip this section if you are using an official release tarball downloaded
251 from http://evergreen-ils.org/egdownloads
253 Developers working directly with the source code from the Git repository,
254 rather than an official release tarball, need to install the Dojo Toolkit
255 set of JavaScript libraries. The appropriate version of Dojo is included in
256 Evergreen release tarballs. Developers should install the Dojo 1.3.3 version
257 of Dojo by issuing the following commands as the *opensrf* Linux account:
260 ------------------------------------------------------------------------------
261 wget http://download.dojotoolkit.org/release-1.3.3/dojo-release-1.3.3.tar.gz
262 tar -C /openils/var/web/js -xzf dojo-release-1.3.3.tar.gz
263 cp -r /openils/var/web/js/dojo-release-1.3.3/* /openils/var/web/js/dojo/.
264 ------------------------------------------------------------------------------
267 Configure the Apache Web server
268 -------------------------------
270 . Use the example configuration files to configure your Web server for
271 the Evergreen catalog, web staff client, Web services, and administration
272 interfaces. Issue the following commands as the *root* Linux account:
275 ------------------------------------------------------------------------------------
276 cp Open-ILS/examples/apache_24/eg_24.conf /etc/apache2/sites-available/eg.conf
277 cp Open-ILS/examples/apache_24/eg_vhost_24.conf /etc/apache2/eg_vhost.conf
278 cp Open-ILS/examples/apache_24/eg_startup /etc/apache2/
280 mkdir /etc/apache2/ssl
282 ------------------------------------------------------------------------------------
284 . The `openssl` command cuts a new SSL key for your Apache server. For a
285 production server, you should purchase a signed SSL certificate, but you can
286 just use a self-signed certificate and accept the warnings in the
287 and browser during testing and development. Create an SSL key for the Apache
288 server by issuing the following command as the *root* Linux account:
291 ------------------------------------------------------------------------------
292 openssl req -new -x509 -days 365 -nodes -out server.crt -keyout server.key
293 ------------------------------------------------------------------------------
295 . As the *root* Linux account, edit the `eg.conf` file that you copied into
297 a. To enable access to the offline upload / execute interface from any
298 workstation on any network, make the following change (and note that
299 you *must* secure this for a production instance):
300 * Replace `Require host 10.0.0.0/8` with `Require all granted`
301 . Change the user for the Apache server.
302 * As the *root* Linux account, edit
303 `/etc/apache2/envvars`. Change `export APACHE_RUN_USER=www-data` to
304 `export APACHE_RUN_USER=opensrf`.
305 . As the *root* Linux account, configure Apache with KeepAlive settings
306 appropriate for Evergreen. Higher values can improve the performance of a
307 single client by allowing multiple requests to be sent over the same TCP
308 connection, but increase the risk of using up all available Apache child
309 processes and memory.
310 * Edit `/etc/apache2/apache2.conf`.
311 a. Change `KeepAliveTimeout` to `1`.
312 b. Change `MaxKeepAliveRequests` to `100`.
313 . As the *root* Linux account, configure the prefork module to start and keep
314 enough Apache servers available to provide quick responses to clients without
315 running out of memory. The following settings are a good starting point for a
316 site that exposes the default Evergreen catalogue to the web:
318 .`/etc/apache2/mods-available/mpm_prefork.conf`
320 ------------------------------------------------------------------------------
321 <IfModule mpm_prefork_module>
326 MaxConnectionsPerChild 500
328 ------------------------------------------------------------------------------
330 . As the *root* user, enable the mpm_prefork module:
333 ------------------------------------------------------------------------------
336 ------------------------------------------------------------------------------
338 . As the *root* Linux account, enable the Evergreen site:
341 ------------------------------------------------------------------------------
342 a2dissite 000-default # OPTIONAL: disable the default site (the "It Works" page)
344 ------------------------------------------------------------------------------
346 . As the *root* Linux account, enable Apache to write
347 to the lock directory; this is currently necessary because Apache
348 is running as the `opensrf` user:
351 ------------------------------------------------------------------------------
352 chown opensrf /var/lock/apache2
353 ------------------------------------------------------------------------------
355 Learn more about additional Apache options in the following sections:
357 * <<_apache_rewrite_tricks,Apache Rewrite Tricks>>
358 * <<_apache_access_handler_perl_module,Apache Access Handler Perl Module>>
360 Configure OpenSRF for the Evergreen application
361 -----------------------------------------------
362 There are a number of example OpenSRF configuration files in `/openils/conf/`
363 that you can use as a template for your Evergreen installation. Issue the
364 following commands as the *opensrf* Linux account:
367 ------------------------------------------------------------------------------
368 cp -b /openils/conf/opensrf_core.xml.example /openils/conf/opensrf_core.xml
369 cp -b /openils/conf/opensrf.xml.example /openils/conf/opensrf.xml
370 ------------------------------------------------------------------------------
372 When you installed OpenSRF, you created four Jabber users on two
373 separate domains and edited the `opensrf_core.xml` file accordingly. Please
374 refer back to the OpenSRF README and, as the *opensrf* Linux account, edit the
375 Evergreen version of the `opensrf_core.xml` file using the same Jabber users
376 and domains as you used while installing and testing OpenSRF.
379 The `-b` flag tells the `cp` command to create a backup version of the
380 destination file. The backup version of the destination file has a tilde (`~`)
381 appended to the file name, so if you have forgotten the Jabber users and
382 domains, you can retrieve the settings from the backup version of the files.
384 `eg_db_config`, described in <<_creating_the_evergreen_database,Creating the Evergreen
385 database>>, sets the database connection information in `opensrf.xml` for you.
387 Configure action triggers for the Evergreen application
388 -------------------------------------------------------
389 _Action Triggers_ provide hooks for the system to perform actions when a given
390 event occurs; for example, to generate reminder or overdue notices, the
391 `checkout.due` hook is processed and events are triggered for potential actions
392 if there is no checkin time.
394 To enable the default set of hooks, issue the following command as the
395 *opensrf* Linux account:
398 ------------------------------------------------------------------------------
399 cp -b /openils/conf/action_trigger_filters.json.example /openils/conf/action_trigger_filters.json
400 ------------------------------------------------------------------------------
402 For more information about configuring and running action triggers, see
403 <<_processing_action_triggers,Notifications / Action Triggers>>.
405 Creating the Evergreen database
406 -------------------------------
408 Setting up the PostgreSQL server
409 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
411 For production use, most libraries install the PostgreSQL database server on a
412 dedicated machine. Therefore, by default, the `Makefile.install` prerequisite
413 installer does *not* install the PostgreSQL 9 database server that is required
414 by every Evergreen system. You can install the packages required by Debian or
415 Ubuntu on the machine of your choice using the following commands as the
416 *root* Linux account:
418 . Installing PostgreSQL server packages
420 Each OS build target provides the postgres server installation packages
421 required for each operating system. To install Postgres server packages,
422 use the make target 'postgres-server-<OSTYPE>'. Choose the most appropriate
423 command below based on your operating system.
426 ------------------------------------------------------------------------------
427 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-buster
428 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-stretch
429 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-jessie
430 make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-xenial
431 make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-bionic
432 ------------------------------------------------------------------------------
434 For a standalone PostgreSQL server, install the following Perl modules for your
435 distribution as the *root* Linux account:
438 No extra modules required for these distributions.
440 You need to create a PostgreSQL superuser to create and access the database.
441 Issue the following command as the *postgres* Linux account to create a new
442 PostgreSQL superuser named `evergreen`. When prompted, enter the new user's
446 ------------------------------------------------------------------------------
447 createuser -s -P evergreen
448 ------------------------------------------------------------------------------
450 .Enabling connections to the PostgreSQL database
452 Your PostgreSQL database may be configured by default to prevent connections,
453 for example, it might reject attempts to connect via TCP/IP or from other
454 servers. To enable TCP/IP connections from localhost, check your `pg_hba.conf`
455 file, found in the `/etc/postgresql/` directory on Debian and Ubuntu.
456 A simple way to enable TCP/IP
457 connections from localhost to all databases with password authentication, which
458 would be suitable for a test install of Evergreen on a single server, is to
459 ensure the file contains the following entries _before_ any "host ... ident"
462 ------------------------------------------------------------------------------
463 host all all ::1/128 md5
464 host all all 127.0.0.1/32 md5
465 ------------------------------------------------------------------------------
467 When you change the `pg_hba.conf` file, you will need to reload PostgreSQL to
468 make the changes take effect. For more information on configuring connectivity
470 http://www.postgresql.org/docs/devel/static/auth-pg-hba-conf.html
472 Creating the Evergreen database and schema
473 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
475 Once you have created the *evergreen* PostgreSQL account, you also need to
476 create the database and schema, and configure your configuration files to point
477 at the database server. Issue the following command as the *root* Linux account
478 from inside the Evergreen source directory, replacing <user>, <password>,
479 <hostname>, <port>, and <dbname> with the appropriate values for your
480 PostgreSQL database (where <user> and <password> are for the *evergreen*
481 PostgreSQL account you just created), and replace <admin-user> and <admin-pass>
482 with the values you want for the *egadmin* Evergreen administrator account:
485 ------------------------------------------------------------------------------
486 perl Open-ILS/src/support-scripts/eg_db_config --update-config \
487 --service all --create-database --create-schema --create-offline \
488 --user <user> --password <password> --hostname <hostname> --port <port> \
489 --database <dbname> --admin-user <admin-user> --admin-pass <admin-pass>
490 ------------------------------------------------------------------------------
492 This creates the database and schema and configures all of the services in
493 your `/openils/conf/opensrf.xml` configuration file to point to that database.
494 It also creates the configuration files required by the Evergreen `cgi-bin`
495 administration scripts, and sets the user name and password for the *egadmin*
496 Evergreen administrator account to your requested values.
498 You can get a complete set of options for `eg_db_config` by passing the
503 If you add the `--load-all-sample` parameter to the `eg_db_config` command,
504 a set of authority and bibliographic records, call numbers, copies, staff
505 and regular users, and transactions will be loaded into your target
506 database. This sample dataset is commonly referred to as the _concerto_
507 sample data, and can be useful for testing out Evergreen functionality and
508 for creating problem reports that developers can easily recreate with their
509 own copy of the _concerto_ sample data.
511 Creating the database on a remote server
512 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
513 In a production instance of Evergreen, your PostgreSQL server should be
514 installed on a dedicated server.
516 PostgreSQL 9.6 and later
517 ^^^^^^^^^^^^^^^^^^^^^^^^
518 To create the database instance on a remote database server running PostgreSQL
519 9.6 or later, simply use the `--create-database` flag on `eg_db_config`.
523 1. As the *root* Linux account, start the `memcached` and `ejabberd` services
524 (if they aren't already running):
527 ------------------------------------------------------------------------------
528 /etc/init.d/ejabberd start
529 /etc/init.d/memcached start
530 ------------------------------------------------------------------------------
532 2. As the *opensrf* Linux account, start Evergreen. The `-l` flag in the
533 following command is only necessary if you want to force Evergreen to treat the
534 hostname as `localhost`; if you configured `opensrf.xml` using the real
535 hostname of your machine as returned by `perl -ENet::Domain 'print
536 Net::Domain::hostfqdn() . "\n";'`, you should not use the `-l` flag.
539 ------------------------------------------------------------------------------
540 osrf_control -l --start-all
541 ------------------------------------------------------------------------------
543 ** If you receive the error message `bash: osrf_control: command not found`,
544 then your environment variable `PATH` does not include the `/openils/bin`
545 directory; this should have been set in the *opensrf* Linux account's
546 `.bashrc` configuration file. To manually set the `PATH` variable, edit the
547 configuration file `~/.bashrc` as the *opensrf* Linux account and add the
551 ------------------------------------------------------------------------------
552 export PATH=$PATH:/openils/bin
553 ------------------------------------------------------------------------------
555 3. As the *opensrf* Linux account, generate the Web files needed by the web staff
556 client and catalogue and update the organization unit proximity (you need to do
557 this the first time you start Evergreen, and after that each time you change the library org unit configuration.
561 ------------------------------------------------------------------------------
563 ------------------------------------------------------------------------------
565 4. As the *root* Linux account, restart the Apache Web server:
568 ------------------------------------------------------------------------------
569 /etc/init.d/apache2 restart
570 ------------------------------------------------------------------------------
572 If the Apache Web server was running when you started the OpenSRF services, you
573 might not be able to successfully log in to the OPAC or web staff client until the
574 Apache Web server is restarted.
576 Testing connections to Evergreen
577 --------------------------------
579 Once you have installed and started Evergreen, test your connection to
580 Evergreen via `srfsh`. As the *opensrf* Linux account, issue the following
581 commands to start `srfsh` and try to log onto the Evergreen server using the
582 *egadmin* Evergreen administrator user name and password that you set using the
583 `eg_db_config` command:
586 ------------------------------------------------------------------------------
588 srfsh% login <admin-user> <admin-pass>
589 ------------------------------------------------------------------------------
591 You should see a result like:
593 Received Data: "250bf1518c7527a03249858687714376"
594 ------------------------------------
595 Request Completed Successfully
596 Request Time in seconds: 0.045286
597 ------------------------------------
601 "textcode":"SUCCESS",
604 "stacktrace":"oils_auth.c:304",
606 "authtoken":"e5f9827cc0f93b503a1cc66bee6bdd1a",
612 ------------------------------------
613 Request Completed Successfully
614 Request Time in seconds: 1.336568
615 ------------------------------------
616 [[install-troubleshooting-1]]
617 If this does not work, it's time to do some troubleshooting.
619 * As the *opensrf* Linux account, run the `settings-tester.pl` script to see
620 if it finds any system configuration problems. The script is found at
621 `Open-ILS/src/support-scripts/settings-tester.pl` in the Evergreen source
623 * Follow the steps in the http://evergreen-ils.org/dokuwiki/doku.php?id=troubleshooting:checking_for_errors[troubleshooting guide].
624 * If you have faithfully followed the entire set of installation steps
625 listed here, you are probably extremely close to a working system.
626 Gather your configuration files and log files and contact the
627 http://evergreen-ils.org/communicate/mailing-lists/[Evergreen development
628 mailing list] for assistance before making any drastic changes to your system
634 Need help installing or using Evergreen? Join the mailing lists at
635 http://evergreen-ils.org/communicate/mailing-lists/ or contact us on the Freenode
636 IRC network on the #evergreen channel.
640 This work is licensed under the Creative Commons Attribution-ShareAlike 3.0
641 Unported License. To view a copy of this license, visit
642 http://creativecommons.org/licenses/by-sa/3.0/ or send a letter to Creative
643 Commons, 444 Castro Street, Suite 900, Mountain View, California, 94041, USA.