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 including the testing of the Angular web client components,
91 additional packages may be required. As the *root* Linux account:
93 * To install packages needed for retrieving and managing web dependencies,
94 use the <osname>-developer Makefile.install target. Currently,
95 this is only needed for building and installing the web
99 ------------------------------------------------------------------------------
100 make -f Open-ILS/src/extras/Makefile.install <osname>-developer
101 ------------------------------------------------------------------------------
103 * To install packages required for building Evergreen translations, use
104 the <osname>-translator Makefile.install target.
107 ------------------------------------------------------------------------------
108 make -f Open-ILS/src/extras/Makefile.install <osname>-translator
109 ------------------------------------------------------------------------------
111 * To install packages required for building Evergreen release bundles, use
112 the <osname>-packager Makefile.install target.
115 ------------------------------------------------------------------------------
116 make -f Open-ILS/src/extras/Makefile.install <osname>-packager
117 ------------------------------------------------------------------------------
119 Extra steps for web staff client
120 --------------------------------
123 Skip this entire section if you are using an official release tarball downloaded
124 from http://evergreen-ils.org/downloads. Otherwise, ensure you have installed the
125 <<optional_developer_additions,optional developer additions>> before proceeding.
127 [[install_files_for_web_staff_client]]
128 Install AngularJS files for web staff client
129 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
131 1. Building, Testing, Minification: The remaining steps all take place within
132 the staff JS web root:
135 ------------------------------------------------------------------------------
136 cd $EVERGREEN_ROOT/Open-ILS/web/js/ui/default/staff/
137 ------------------------------------------------------------------------------
139 2. Install Project-local Dependencies. npm inspects the 'package.json' file
140 for dependencies and fetches them from the Node package network.
143 ------------------------------------------------------------------------------
144 npm install # fetch JS dependencies
145 ------------------------------------------------------------------------------
147 3. Run the build script.
150 ------------------------------------------------------------------------------
151 # build, concat+minify
153 ------------------------------------------------------------------------------
155 4. OPTIONAL: Test web client code if the <osname>-developer packages were installed.
156 CHROME_BIN should be set to the path to chrome or chromimum, e.g.,
160 ------------------------------------------------------------------------------
161 CHROME_BIN=/path/to/chrome npm run test
162 ------------------------------------------------------------------------------
164 [[install_files_for_angular_web_staff_client]]
165 Install Angular files for web staff client
166 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
168 1. Building, Testing, Minification: The remaining steps all take place within
169 the Angular staff root:
172 ------------------------------------------------------------------------------
173 cd $EVERGREEN_ROOT/Open-ILS/src/eg2/
174 ------------------------------------------------------------------------------
176 2. Install Project-local Dependencies. npm inspects the 'package.json' file
177 for dependencies and fetches them from the Node package network.
180 ------------------------------------------------------------------------------
181 npm install # fetch JS dependencies
182 ------------------------------------------------------------------------------
184 3. Run the build script.
187 ------------------------------------------------------------------------------
188 # build and run tests
190 ------------------------------------------------------------------------------
192 4. OPTIONAL: Test eg2 web client code if the <osname>-developer packages were installed:
193 CHROME_BIN should be set to the path to chrome or chromimum, e.g.,
197 ------------------------------------------------------------------------------
198 CHROME_BIN=/path/to/chrome npm run test
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 / Buster, 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-buster
434 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-stretch
435 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-jessie
436 make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-xenial
437 make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-bionic
438 ------------------------------------------------------------------------------
440 For a standalone PostgreSQL server, install the following Perl modules for your
441 distribution as the *root* Linux account:
444 No extra modules required for these distributions.
446 You need to create a PostgreSQL superuser to create and access the database.
447 Issue the following command as the *postgres* Linux account to create a new
448 PostgreSQL superuser named `evergreen`. When prompted, enter the new user's
452 ------------------------------------------------------------------------------
453 createuser -s -P evergreen
454 ------------------------------------------------------------------------------
456 .Enabling connections to the PostgreSQL database
458 Your PostgreSQL database may be configured by default to prevent connections,
459 for example, it might reject attempts to connect via TCP/IP or from other
460 servers. To enable TCP/IP connections from localhost, check your `pg_hba.conf`
461 file, found in the `/etc/postgresql/` directory on Debian and Ubuntu.
462 A simple way to enable TCP/IP
463 connections from localhost to all databases with password authentication, which
464 would be suitable for a test install of Evergreen on a single server, is to
465 ensure the file contains the following entries _before_ any "host ... ident"
468 ------------------------------------------------------------------------------
469 host all all ::1/128 md5
470 host all all 127.0.0.1/32 md5
471 ------------------------------------------------------------------------------
473 When you change the `pg_hba.conf` file, you will need to reload PostgreSQL to
474 make the changes take effect. For more information on configuring connectivity
476 http://www.postgresql.org/docs/devel/static/auth-pg-hba-conf.html
478 Creating the Evergreen database and schema
479 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
481 Once you have created the *evergreen* PostgreSQL account, you also need to
482 create the database and schema, and configure your configuration files to point
483 at the database server. Issue the following command as the *root* Linux account
484 from inside the Evergreen source directory, replacing <user>, <password>,
485 <hostname>, <port>, and <dbname> with the appropriate values for your
486 PostgreSQL database (where <user> and <password> are for the *evergreen*
487 PostgreSQL account you just created), and replace <admin-user> and <admin-pass>
488 with the values you want for the *egadmin* Evergreen administrator account:
491 ------------------------------------------------------------------------------
492 perl Open-ILS/src/support-scripts/eg_db_config --update-config \
493 --service all --create-database --create-schema --create-offline \
494 --user <user> --password <password> --hostname <hostname> --port <port> \
495 --database <dbname> --admin-user <admin-user> --admin-pass <admin-pass>
496 ------------------------------------------------------------------------------
498 This creates the database and schema and configures all of the services in
499 your `/openils/conf/opensrf.xml` configuration file to point to that database.
500 It also creates the configuration files required by the Evergreen `cgi-bin`
501 administration scripts, and sets the user name and password for the *egadmin*
502 Evergreen administrator account to your requested values.
504 You can get a complete set of options for `eg_db_config` by passing the
509 If you add the `--load-all-sample` parameter to the `eg_db_config` command,
510 a set of authority and bibliographic records, call numbers, copies, staff
511 and regular users, and transactions will be loaded into your target
512 database. This sample dataset is commonly referred to as the _concerto_
513 sample data, and can be useful for testing out Evergreen functionality and
514 for creating problem reports that developers can easily recreate with their
515 own copy of the _concerto_ sample data.
517 Creating the database on a remote server
518 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
519 In a production instance of Evergreen, your PostgreSQL server should be
520 installed on a dedicated server.
522 PostgreSQL 9.6 and later
523 ^^^^^^^^^^^^^^^^^^^^^^^^
524 To create the database instance on a remote database server running PostgreSQL
525 9.6 or later, simply use the `--create-database` flag on `eg_db_config`.
529 1. As the *root* Linux account, start the `memcached` and `ejabberd` services
530 (if they aren't already running):
533 ------------------------------------------------------------------------------
534 /etc/init.d/ejabberd start
535 /etc/init.d/memcached start
536 ------------------------------------------------------------------------------
538 2. As the *opensrf* Linux account, start Evergreen. The `-l` flag in the
539 following command is only necessary if you want to force Evergreen to treat the
540 hostname as `localhost`; if you configured `opensrf.xml` using the real
541 hostname of your machine as returned by `perl -ENet::Domain 'print
542 Net::Domain::hostfqdn() . "\n";'`, you should not use the `-l` flag.
545 ------------------------------------------------------------------------------
546 osrf_control -l --start-all
547 ------------------------------------------------------------------------------
549 ** If you receive the error message `bash: osrf_control: command not found`,
550 then your environment variable `PATH` does not include the `/openils/bin`
551 directory; this should have been set in the *opensrf* Linux account's
552 `.bashrc` configuration file. To manually set the `PATH` variable, edit the
553 configuration file `~/.bashrc` as the *opensrf* Linux account and add the
557 ------------------------------------------------------------------------------
558 export PATH=$PATH:/openils/bin
559 ------------------------------------------------------------------------------
561 3. As the *opensrf* Linux account, generate the Web files needed by the web staff
562 client and catalogue and update the organization unit proximity (you need to do
563 this the first time you start Evergreen, and after that each time you change the library org unit configuration.
567 ------------------------------------------------------------------------------
569 ------------------------------------------------------------------------------
571 4. As the *root* Linux account, restart the Apache Web server:
574 ------------------------------------------------------------------------------
575 /etc/init.d/apache2 restart
576 ------------------------------------------------------------------------------
578 If the Apache Web server was running when you started the OpenSRF services, you
579 might not be able to successfully log in to the OPAC or web staff client until the
580 Apache Web server is restarted.
582 Testing connections to Evergreen
583 --------------------------------
585 Once you have installed and started Evergreen, test your connection to
586 Evergreen via `srfsh`. As the *opensrf* Linux account, issue the following
587 commands to start `srfsh` and try to log onto the Evergreen server using the
588 *egadmin* Evergreen administrator user name and password that you set using the
589 `eg_db_config` command:
592 ------------------------------------------------------------------------------
594 srfsh% login <admin-user> <admin-pass>
595 ------------------------------------------------------------------------------
597 You should see a result like:
599 Received Data: "250bf1518c7527a03249858687714376"
600 ------------------------------------
601 Request Completed Successfully
602 Request Time in seconds: 0.045286
603 ------------------------------------
607 "textcode":"SUCCESS",
610 "stacktrace":"oils_auth.c:304",
612 "authtoken":"e5f9827cc0f93b503a1cc66bee6bdd1a",
618 ------------------------------------
619 Request Completed Successfully
620 Request Time in seconds: 1.336568
621 ------------------------------------
622 [[install-troubleshooting-1]]
623 If this does not work, it's time to do some troubleshooting.
625 * As the *opensrf* Linux account, run the `settings-tester.pl` script to see
626 if it finds any system configuration problems. The script is found at
627 `Open-ILS/src/support-scripts/settings-tester.pl` in the Evergreen source
629 * Follow the steps in the http://evergreen-ils.org/dokuwiki/doku.php?id=troubleshooting:checking_for_errors[troubleshooting guide].
630 * If you have faithfully followed the entire set of installation steps
631 listed here, you are probably extremely close to a working system.
632 Gather your configuration files and log files and contact the
633 http://evergreen-ils.org/communicate/mailing-lists/[Evergreen development
634 mailing list] for assistance before making any drastic changes to your system
640 Need help installing or using Evergreen? Join the mailing lists at
641 http://evergreen-ils.org/communicate/mailing-lists/ or contact us on the Freenode
642 IRC network on the #evergreen channel.
646 This work is licensed under the Creative Commons Attribution-ShareAlike 3.0
647 Unported License. To view a copy of this license, visit
648 http://creativecommons.org/licenses/by-sa/3.0/ or send a letter to Creative
649 Commons, 444 Castro Street, Suite 900, Mountain View, California, 94041, USA.