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
61 Ubuntu Bionic Beaver (18.04),
62 Ubuntu Xenial Xerus (16.04),
63 and Ubuntu Trusty Tahr (14.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.0.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.0.0 or later).
74 You can download OpenSRF releases from http://evergreen-ils.org/opensrf-downloads/
75 2. On some distributions, it is necessary to install PostgreSQL 9.4+ from external
78 * Ubuntu (Trusty) comes with an older version of PostgreSQL
79 and Ubuntu (Bionic) comes with a newer version of PostgreSQL,
80 so steps are taken to automatically utilize the PostgreSQL
81 community's apt sources.
82 (For complete details, see: https://wiki.postgresql.org/wiki/Apt)
83 * Debian (Jessie/Stretch) and Ubuntu (Xenial) comes with PostgreSQL 9.4+,
84 so no additional steps are required.
86 3. Issue the following commands as the *root* Linux account to install
87 prerequisites using the `Makefile.install` prerequisite installer,
88 substituting `debian-stretch`,`debian-jessie`,`ubuntu-bionic`,`ubuntu-xenial`,
89 or `ubuntu-trusty` for <osname> below:
92 ------------------------------------------------------------------------------
93 make -f Open-ILS/src/extras/Makefile.install <osname>
94 ------------------------------------------------------------------------------
96 [[optional_developer_additions]]
97 4. OPTIONAL: Developer additions
99 To perform certain developer tasks from a Git source code checkout,
100 additional packages may be required. As the *root* Linux account:
102 * To install packages needed for retrieving and managing web dependencies,
103 use the <osname>-developer Makefile.install target. Currently,
104 this is only needed for building and installing the web
108 ------------------------------------------------------------------------------
109 make -f Open-ILS/src/extras/Makefile.install <osname>-developer
110 ------------------------------------------------------------------------------
112 * To install packages required for building Evergreen translations, use
113 the <osname>-translator Makefile.install target.
116 ------------------------------------------------------------------------------
117 make -f Open-ILS/src/extras/Makefile.install <osname>-translator
118 ------------------------------------------------------------------------------
120 * To install packages required for building Evergreen release bundles, use
121 the <osname>-packager Makefile.install target.
124 ------------------------------------------------------------------------------
125 make -f Open-ILS/src/extras/Makefile.install <osname>-packager
126 ------------------------------------------------------------------------------
128 Extra steps for web staff client
129 --------------------------------
132 Skip this entire section if you are using an official release tarball downloaded
133 from http://evergreen-ils.org/downloads
135 Install dependencies for web staff client
136 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
139 You may skip this section if you have installed the
140 <<optional_developer_additions,optional developer additions>>. You will still need to do the following
141 steps in <<install_files_for_web_staff_client,Install files for web staff client>>.
143 1. Install the long-term stability (LTS) release of
144 https://nodejs.org[Node.js]. Add the Node.js `/bin` directory to your
145 environment variable `PATH`.
147 [[install_files_for_web_staff_client]]
148 Install AngularJS files for web staff client
149 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
151 1. Building, Testing, Minification: The remaining steps all take place within
152 the staff JS web root:
155 ------------------------------------------------------------------------------
156 cd $EVERGREEN_ROOT/Open-ILS/web/js/ui/default/staff/
157 ------------------------------------------------------------------------------
159 2. Install Project-local Dependencies. npm inspects the 'package.json' file
160 for dependencies and fetches them from the Node package network.
163 ------------------------------------------------------------------------------
164 npm install # fetch JS dependencies
165 ------------------------------------------------------------------------------
167 3. Run the build script.
170 ------------------------------------------------------------------------------
171 # build, run tests, concat+minify
174 ------------------------------------------------------------------------------
176 [[install_files_for_angular_web_staff_client]]
177 Install Angular files for web staff client
178 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
180 1. Building, Testing, Minification: The remaining steps all take place within
181 the Angular staff root:
184 ------------------------------------------------------------------------------
185 cd $EVERGREEN_ROOT/Open-ILS/src/eg2/
186 ------------------------------------------------------------------------------
188 2. Install Project-local Dependencies. npm inspects the 'package.json' file
189 for dependencies and fetches them from the Node package network.
192 ------------------------------------------------------------------------------
193 npm install # fetch JS dependencies
194 ------------------------------------------------------------------------------
196 3. Run the build script.
199 ------------------------------------------------------------------------------
200 # build and run tests
203 ------------------------------------------------------------------------------
205 Configuration and compilation instructions
206 ------------------------------------------
208 For the time being, we are still installing everything in the `/openils/`
209 directory. From the Evergreen source directory, issue the following commands as
210 the *user* Linux account to configure and build Evergreen:
213 ------------------------------------------------------------------------------
214 PATH=/openils/bin:$PATH ./configure --prefix=/openils --sysconfdir=/openils/conf
216 ------------------------------------------------------------------------------
218 These instructions assume that you have also installed OpenSRF under `/openils/`.
219 If not, please adjust PATH as needed so that the Evergreen `configure` script
220 can find `osrf_config`.
222 Installation instructions
223 -------------------------
225 1. Once you have configured and compiled Evergreen, issue the following
226 command as the *root* Linux account to install Evergreen and copy
227 example configuration files to `/openils/conf`.
230 ------------------------------------------------------------------------------
232 ------------------------------------------------------------------------------
234 Change ownership of the Evergreen files
235 ---------------------------------------
237 All files in the `/openils/` directory and subdirectories must be owned by the
238 `opensrf` user. Issue the following command as the *root* Linux account to
239 change the ownership on the files:
242 ------------------------------------------------------------------------------
243 chown -R opensrf:opensrf /openils
244 ------------------------------------------------------------------------------
249 On Debian Stretch, run the following command as the root user:
252 ------------------------------------------------------------------------------
254 ------------------------------------------------------------------------------
256 Additional Instructions for Developers
257 --------------------------------------
260 Skip this section if you are using an official release tarball downloaded
261 from http://evergreen-ils.org/egdownloads
263 Developers working directly with the source code from the Git repository,
264 rather than an official release tarball, need to install the Dojo Toolkit
265 set of JavaScript libraries. The appropriate version of Dojo is included in
266 Evergreen release tarballs. Developers should install the Dojo 1.3.3 version
267 of Dojo by issuing the following commands as the *opensrf* Linux account:
270 ------------------------------------------------------------------------------
271 wget http://download.dojotoolkit.org/release-1.3.3/dojo-release-1.3.3.tar.gz
272 tar -C /openils/var/web/js -xzf dojo-release-1.3.3.tar.gz
273 cp -r /openils/var/web/js/dojo-release-1.3.3/* /openils/var/web/js/dojo/.
274 ------------------------------------------------------------------------------
277 Configure the Apache Web server
278 -------------------------------
280 . Use the example configuration files to configure your Web server for
281 the Evergreen catalog, web staff client, Web services, and administration
282 interfaces. Issue the following commands as the *root* Linux account:
285 ------------------------------------------------------------------------------------
286 cp Open-ILS/examples/apache_24/eg_24.conf /etc/apache2/sites-available/eg.conf
287 cp Open-ILS/examples/apache_24/eg_vhost_24.conf /etc/apache2/eg_vhost.conf
288 cp Open-ILS/examples/apache_24/eg_startup /etc/apache2/
290 mkdir /etc/apache2/ssl
292 ------------------------------------------------------------------------------------
294 . The `openssl` command cuts a new SSL key for your Apache server. For a
295 production server, you should purchase a signed SSL certificate, but you can
296 just use a self-signed certificate and accept the warnings in the
297 and browser during testing and development. Create an SSL key for the Apache
298 server by issuing the following command as the *root* Linux account:
301 ------------------------------------------------------------------------------
302 openssl req -new -x509 -days 365 -nodes -out server.crt -keyout server.key
303 ------------------------------------------------------------------------------
305 . As the *root* Linux account, edit the `eg.conf` file that you copied into
307 a. To enable access to the offline upload / execute interface from any
308 workstation on any network, make the following change (and note that
309 you *must* secure this for a production instance):
310 * Replace `Require host 10.0.0.0/8` with `Require all granted`
311 . Change the user for the Apache server.
312 * As the *root* Linux account, edit
313 `/etc/apache2/envvars`. Change `export APACHE_RUN_USER=www-data` to
314 `export APACHE_RUN_USER=opensrf`.
315 . As the *root* Linux account, configure Apache with KeepAlive settings
316 appropriate for Evergreen. Higher values can improve the performance of a
317 single client by allowing multiple requests to be sent over the same TCP
318 connection, but increase the risk of using up all available Apache child
319 processes and memory.
320 * Edit `/etc/apache2/apache2.conf`.
321 a. Change `KeepAliveTimeout` to `1`.
322 b. Change `MaxKeepAliveRequests` to `100`.
323 . As the *root* Linux account, configure the prefork module to start and keep
324 enough Apache servers available to provide quick responses to clients without
325 running out of memory. The following settings are a good starting point for a
326 site that exposes the default Evergreen catalogue to the web:
328 .`/etc/apache2/mods-available/mpm_prefork.conf`
330 ------------------------------------------------------------------------------
331 <IfModule mpm_prefork_module>
336 MaxConnectionsPerChild 500
338 ------------------------------------------------------------------------------
340 . As the *root* user, enable the mpm_prefork module:
343 ------------------------------------------------------------------------------
346 ------------------------------------------------------------------------------
348 . As the *root* Linux account, enable the Evergreen site:
351 ------------------------------------------------------------------------------
352 a2dissite 000-default # OPTIONAL: disable the default site (the "It Works" page)
354 ------------------------------------------------------------------------------
356 . As the *root* Linux account, enable Apache to write
357 to the lock directory; this is currently necessary because Apache
358 is running as the `opensrf` user:
361 ------------------------------------------------------------------------------
362 chown opensrf /var/lock/apache2
363 ------------------------------------------------------------------------------
365 Learn more about additional Apache options in the following sections:
367 * <<_apache_rewrite_tricks,Apache Rewrite Tricks>>
368 * <<_apache_access_handler_perl_module,Apache Access Handler Perl Module>>
370 Configure OpenSRF for the Evergreen application
371 -----------------------------------------------
372 There are a number of example OpenSRF configuration files in `/openils/conf/`
373 that you can use as a template for your Evergreen installation. Issue the
374 following commands as the *opensrf* Linux account:
377 ------------------------------------------------------------------------------
378 cp -b /openils/conf/opensrf_core.xml.example /openils/conf/opensrf_core.xml
379 cp -b /openils/conf/opensrf.xml.example /openils/conf/opensrf.xml
380 ------------------------------------------------------------------------------
382 When you installed OpenSRF, you created four Jabber users on two
383 separate domains and edited the `opensrf_core.xml` file accordingly. Please
384 refer back to the OpenSRF README and, as the *opensrf* Linux account, edit the
385 Evergreen version of the `opensrf_core.xml` file using the same Jabber users
386 and domains as you used while installing and testing OpenSRF.
389 The `-b` flag tells the `cp` command to create a backup version of the
390 destination file. The backup version of the destination file has a tilde (`~`)
391 appended to the file name, so if you have forgotten the Jabber users and
392 domains, you can retrieve the settings from the backup version of the files.
394 `eg_db_config`, described in <<_creating_the_evergreen_database,Creating the Evergreen
395 database>>, sets the database connection information in `opensrf.xml` for you.
397 Configure action triggers for the Evergreen application
398 -------------------------------------------------------
399 _Action Triggers_ provide hooks for the system to perform actions when a given
400 event occurs; for example, to generate reminder or overdue notices, the
401 `checkout.due` hook is processed and events are triggered for potential actions
402 if there is no checkin time.
404 To enable the default set of hooks, issue the following command as the
405 *opensrf* Linux account:
408 ------------------------------------------------------------------------------
409 cp -b /openils/conf/action_trigger_filters.json.example /openils/conf/action_trigger_filters.json
410 ------------------------------------------------------------------------------
412 For more information about configuring and running action triggers, see
413 <<_processing_action_triggers,Notifications / Action Triggers>>.
415 Creating the Evergreen database
416 -------------------------------
418 Setting up the PostgreSQL server
419 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
421 For production use, most libraries install the PostgreSQL database server on a
422 dedicated machine. Therefore, by default, the `Makefile.install` prerequisite
423 installer does *not* install the PostgreSQL 9 database server that is required
424 by every Evergreen system. You can install the packages required by Debian or
425 Ubuntu on the machine of your choice using the following commands as the
426 *root* Linux account:
428 . Installing PostgreSQL server packages
430 Each OS build target provides the postgres server installation packages
431 required for each operating system. To install Postgres server packages,
432 use the make target 'postgres-server-<OSTYPE>'. Choose the most appropriate
433 command below based on your operating system.
436 ------------------------------------------------------------------------------
437 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-stretch
438 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-jessie
439 make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-trusty
440 make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-xenial
441 make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-bionic
442 ------------------------------------------------------------------------------
444 For a standalone PostgreSQL server, install the following Perl modules for your
445 distribution as the *root* Linux account:
448 No extra modules required for these distributions.
450 You need to create a PostgreSQL superuser to create and access the database.
451 Issue the following command as the *postgres* Linux account to create a new
452 PostgreSQL superuser named `evergreen`. When prompted, enter the new user's
456 ------------------------------------------------------------------------------
457 createuser -s -P evergreen
458 ------------------------------------------------------------------------------
460 .Enabling connections to the PostgreSQL database
462 Your PostgreSQL database may be configured by default to prevent connections,
463 for example, it might reject attempts to connect via TCP/IP or from other
464 servers. To enable TCP/IP connections from localhost, check your `pg_hba.conf`
465 file, found in the `/etc/postgresql/` directory on Debian and Ubuntu.
466 A simple way to enable TCP/IP
467 connections from localhost to all databases with password authentication, which
468 would be suitable for a test install of Evergreen on a single server, is to
469 ensure the file contains the following entries _before_ any "host ... ident"
472 ------------------------------------------------------------------------------
473 host all all ::1/128 md5
474 host all all 127.0.0.1/32 md5
475 ------------------------------------------------------------------------------
477 When you change the `pg_hba.conf` file, you will need to reload PostgreSQL to
478 make the changes take effect. For more information on configuring connectivity
480 http://www.postgresql.org/docs/devel/static/auth-pg-hba-conf.html
482 Creating the Evergreen database and schema
483 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
485 Once you have created the *evergreen* PostgreSQL account, you also need to
486 create the database and schema, and configure your configuration files to point
487 at the database server. Issue the following command as the *root* Linux account
488 from inside the Evergreen source directory, replacing <user>, <password>,
489 <hostname>, <port>, and <dbname> with the appropriate values for your
490 PostgreSQL database (where <user> and <password> are for the *evergreen*
491 PostgreSQL account you just created), and replace <admin-user> and <admin-pass>
492 with the values you want for the *egadmin* Evergreen administrator account:
495 ------------------------------------------------------------------------------
496 perl Open-ILS/src/support-scripts/eg_db_config --update-config \
497 --service all --create-database --create-schema --create-offline \
498 --user <user> --password <password> --hostname <hostname> --port <port> \
499 --database <dbname> --admin-user <admin-user> --admin-pass <admin-pass>
500 ------------------------------------------------------------------------------
502 This creates the database and schema and configures all of the services in
503 your `/openils/conf/opensrf.xml` configuration file to point to that database.
504 It also creates the configuration files required by the Evergreen `cgi-bin`
505 administration scripts, and sets the user name and password for the *egadmin*
506 Evergreen administrator account to your requested values.
508 You can get a complete set of options for `eg_db_config` by passing the
513 If you add the `--load-all-sample` parameter to the `eg_db_config` command,
514 a set of authority and bibliographic records, call numbers, copies, staff
515 and regular users, and transactions will be loaded into your target
516 database. This sample dataset is commonly referred to as the _concerto_
517 sample data, and can be useful for testing out Evergreen functionality and
518 for creating problem reports that developers can easily recreate with their
519 own copy of the _concerto_ sample data.
521 Creating the database on a remote server
522 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
523 In a production instance of Evergreen, your PostgreSQL server should be
524 installed on a dedicated server.
526 PostgreSQL 9.4 and later
527 ^^^^^^^^^^^^^^^^^^^^^^^^
528 To create the database instance on a remote database server running PostgreSQL
529 9.4 or later, simply use the `--create-database` flag on `eg_db_config`.
533 1. As the *root* Linux account, start the `memcached` and `ejabberd` services
534 (if they aren't already running):
537 ------------------------------------------------------------------------------
538 /etc/init.d/ejabberd start
539 /etc/init.d/memcached start
540 ------------------------------------------------------------------------------
542 2. As the *opensrf* Linux account, start Evergreen. The `-l` flag in the
543 following command is only necessary if you want to force Evergreen to treat the
544 hostname as `localhost`; if you configured `opensrf.xml` using the real
545 hostname of your machine as returned by `perl -ENet::Domain 'print
546 Net::Domain::hostfqdn() . "\n";'`, you should not use the `-l` flag.
549 ------------------------------------------------------------------------------
550 osrf_control -l --start-all
551 ------------------------------------------------------------------------------
553 ** If you receive the error message `bash: osrf_control: command not found`,
554 then your environment variable `PATH` does not include the `/openils/bin`
555 directory; this should have been set in the *opensrf* Linux account's
556 `.bashrc` configuration file. To manually set the `PATH` variable, edit the
557 configuration file `~/.bashrc` as the *opensrf* Linux account and add the
561 ------------------------------------------------------------------------------
562 export PATH=$PATH:/openils/bin
563 ------------------------------------------------------------------------------
565 3. As the *opensrf* Linux account, generate the Web files needed by the web staff
566 client and catalogue and update the organization unit proximity (you need to do
567 this the first time you start Evergreen, and after that each time you change the library org unit configuration.
571 ------------------------------------------------------------------------------
573 ------------------------------------------------------------------------------
575 4. As the *root* Linux account, restart the Apache Web server:
578 ------------------------------------------------------------------------------
579 /etc/init.d/apache2 restart
580 ------------------------------------------------------------------------------
582 If the Apache Web server was running when you started the OpenSRF services, you
583 might not be able to successfully log in to the OPAC or web staff client until the
584 Apache Web server is restarted.
586 Testing connections to Evergreen
587 --------------------------------
589 Once you have installed and started Evergreen, test your connection to
590 Evergreen via `srfsh`. As the *opensrf* Linux account, issue the following
591 commands to start `srfsh` and try to log onto the Evergreen server using the
592 *egadmin* Evergreen administrator user name and password that you set using the
593 `eg_db_config` command:
596 ------------------------------------------------------------------------------
598 srfsh% login <admin-user> <admin-pass>
599 ------------------------------------------------------------------------------
601 You should see a result like:
603 Received Data: "250bf1518c7527a03249858687714376"
604 ------------------------------------
605 Request Completed Successfully
606 Request Time in seconds: 0.045286
607 ------------------------------------
611 "textcode":"SUCCESS",
614 "stacktrace":"oils_auth.c:304",
616 "authtoken":"e5f9827cc0f93b503a1cc66bee6bdd1a",
622 ------------------------------------
623 Request Completed Successfully
624 Request Time in seconds: 1.336568
625 ------------------------------------
626 [[install-troubleshooting-1]]
627 If this does not work, it's time to do some troubleshooting.
629 * As the *opensrf* Linux account, run the `settings-tester.pl` script to see
630 if it finds any system configuration problems. The script is found at
631 `Open-ILS/src/support-scripts/settings-tester.pl` in the Evergreen source
633 * Follow the steps in the http://evergreen-ils.org/dokuwiki/doku.php?id=troubleshooting:checking_for_errors[troubleshooting guide].
634 * If you have faithfully followed the entire set of installation steps
635 listed here, you are probably extremely close to a working system.
636 Gather your configuration files and log files and contact the
637 http://evergreen-ils.org/communicate/mailing-lists/[Evergreen development
638 mailing list] for assistance before making any drastic changes to your system
644 Need help installing or using Evergreen? Join the mailing lists at
645 http://evergreen-ils.org/communicate/mailing-lists/ or contact us on the Freenode
646 IRC network on the #evergreen channel.
650 This work is licensed under the Creative Commons Attribution-ShareAlike 3.0
651 Unported License. To view a copy of this license, visit
652 http://creativecommons.org/licenses/by-sa/3.0/ or send a letter to Creative
653 Commons, 444 Castro Street, Suite 900, Mountain View, California, 94041, USA.