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 and Ubuntu Xenial Xerus (16.04).
63 If you are running an older version of these distributions, you may want
64 to upgrade before upgrading Evergreen. For instructions on upgrading these
65 distributions, visit the Debian or Ubuntu websites.
66 * **OpenSRF**: The minimum supported version of OpenSRF is 3.0.0.
69 Evergreen has a number of prerequisite packages that must be installed
70 before you can successfully configure, compile, and install Evergreen.
72 1. Begin by installing the most recent version of OpenSRF (3.0.0 or later).
73 You can download OpenSRF releases from http://evergreen-ils.org/opensrf-downloads/
75 2. Issue the following commands as the *root* Linux account to install
76 prerequisites using the `Makefile.install` prerequisite installer,
77 substituting `debian-stretch`,`debian-jessie`,`ubuntu-bionic`, or
78 `ubuntu-xenial` for <osname> below:
81 ------------------------------------------------------------------------------
82 make -f Open-ILS/src/extras/Makefile.install <osname>
83 ------------------------------------------------------------------------------
85 [[optional_developer_additions]]
86 4. OPTIONAL: Developer additions
88 To perform certain developer tasks from a Git source code checkout,
89 additional packages may be required. As the *root* Linux account:
91 * To install packages needed for retrieving and managing web dependencies,
92 use the <osname>-developer Makefile.install target. Currently,
93 this is only needed for building and installing the web
97 ------------------------------------------------------------------------------
98 make -f Open-ILS/src/extras/Makefile.install <osname>-developer
99 ------------------------------------------------------------------------------
101 * To install packages required for building Evergreen translations, use
102 the <osname>-translator Makefile.install target.
105 ------------------------------------------------------------------------------
106 make -f Open-ILS/src/extras/Makefile.install <osname>-translator
107 ------------------------------------------------------------------------------
109 * To install packages required for building Evergreen release bundles, use
110 the <osname>-packager Makefile.install target.
113 ------------------------------------------------------------------------------
114 make -f Open-ILS/src/extras/Makefile.install <osname>-packager
115 ------------------------------------------------------------------------------
117 Extra steps for web staff client
118 --------------------------------
121 Skip this entire section if you are using an official release tarball downloaded
122 from http://evergreen-ils.org/downloads
124 Install dependencies for web staff client
125 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
128 You may skip this section if you have installed the
129 <<optional_developer_additions,optional developer additions>>. You will still need to do the following
130 steps in <<install_files_for_web_staff_client,Install files for web staff client>>.
132 1. Install the long-term stability (LTS) release of
133 https://nodejs.org[Node.js]. Add the Node.js `/bin` directory to your
134 environment variable `PATH`.
136 [[install_files_for_web_staff_client]]
137 Install AngularJS files for web staff client
138 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
140 1. Building, Testing, Minification: The remaining steps all take place within
141 the staff JS web root:
144 ------------------------------------------------------------------------------
145 cd $EVERGREEN_ROOT/Open-ILS/web/js/ui/default/staff/
146 ------------------------------------------------------------------------------
148 2. Install Project-local Dependencies. npm inspects the 'package.json' file
149 for dependencies and fetches them from the Node package network.
152 ------------------------------------------------------------------------------
153 npm install # fetch JS dependencies
154 ------------------------------------------------------------------------------
156 3. Run the build script.
159 ------------------------------------------------------------------------------
160 # build, run tests, concat+minify
163 ------------------------------------------------------------------------------
165 [[install_files_for_angular_web_staff_client]]
166 Install Angular files for web staff client
167 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
169 1. Building, Testing, Minification: The remaining steps all take place within
170 the Angular staff root:
173 ------------------------------------------------------------------------------
174 cd $EVERGREEN_ROOT/Open-ILS/src/eg2/
175 ------------------------------------------------------------------------------
177 2. Install Project-local Dependencies. npm inspects the 'package.json' file
178 for dependencies and fetches them from the Node package network.
181 ------------------------------------------------------------------------------
182 npm install # fetch JS dependencies
183 ------------------------------------------------------------------------------
185 3. Run the build script.
188 ------------------------------------------------------------------------------
189 # build and run tests
192 ------------------------------------------------------------------------------
194 Configuration and compilation instructions
195 ------------------------------------------
197 For the time being, we are still installing everything in the `/openils/`
198 directory. From the Evergreen source directory, issue the following commands as
199 the *user* Linux account to configure and build Evergreen:
202 ------------------------------------------------------------------------------
203 PATH=/openils/bin:$PATH ./configure --prefix=/openils --sysconfdir=/openils/conf
205 ------------------------------------------------------------------------------
207 These instructions assume that you have also installed OpenSRF under `/openils/`.
208 If not, please adjust PATH as needed so that the Evergreen `configure` script
209 can find `osrf_config`.
211 Installation instructions
212 -------------------------
214 1. Once you have configured and compiled Evergreen, issue the following
215 command as the *root* Linux account to install Evergreen and copy
216 example configuration files to `/openils/conf`.
219 ------------------------------------------------------------------------------
221 ------------------------------------------------------------------------------
223 Change ownership of the Evergreen files
224 ---------------------------------------
226 All files in the `/openils/` directory and subdirectories must be owned by the
227 `opensrf` user. Issue the following command as the *root* Linux account to
228 change the ownership on the files:
231 ------------------------------------------------------------------------------
232 chown -R opensrf:opensrf /openils
233 ------------------------------------------------------------------------------
238 On Debian Stretch, run the following command as the root user:
241 ------------------------------------------------------------------------------
243 ------------------------------------------------------------------------------
245 Additional Instructions for Developers
246 --------------------------------------
249 Skip this section if you are using an official release tarball downloaded
250 from http://evergreen-ils.org/egdownloads
252 Developers working directly with the source code from the Git repository,
253 rather than an official release tarball, need to install the Dojo Toolkit
254 set of JavaScript libraries. The appropriate version of Dojo is included in
255 Evergreen release tarballs. Developers should install the Dojo 1.3.3 version
256 of Dojo by issuing the following commands as the *opensrf* Linux account:
259 ------------------------------------------------------------------------------
260 wget http://download.dojotoolkit.org/release-1.3.3/dojo-release-1.3.3.tar.gz
261 tar -C /openils/var/web/js -xzf dojo-release-1.3.3.tar.gz
262 cp -r /openils/var/web/js/dojo-release-1.3.3/* /openils/var/web/js/dojo/.
263 ------------------------------------------------------------------------------
266 Configure the Apache Web server
267 -------------------------------
269 . Use the example configuration files to configure your Web server for
270 the Evergreen catalog, web staff client, Web services, and administration
271 interfaces. Issue the following commands as the *root* Linux account:
274 ------------------------------------------------------------------------------------
275 cp Open-ILS/examples/apache_24/eg_24.conf /etc/apache2/sites-available/eg.conf
276 cp Open-ILS/examples/apache_24/eg_vhost_24.conf /etc/apache2/eg_vhost.conf
277 cp Open-ILS/examples/apache_24/eg_startup /etc/apache2/
279 mkdir /etc/apache2/ssl
281 ------------------------------------------------------------------------------------
283 . The `openssl` command cuts a new SSL key for your Apache server. For a
284 production server, you should purchase a signed SSL certificate, but you can
285 just use a self-signed certificate and accept the warnings in the
286 and browser during testing and development. Create an SSL key for the Apache
287 server by issuing the following command as the *root* Linux account:
290 ------------------------------------------------------------------------------
291 openssl req -new -x509 -days 365 -nodes -out server.crt -keyout server.key
292 ------------------------------------------------------------------------------
294 . As the *root* Linux account, edit the `eg.conf` file that you copied into
296 a. To enable access to the offline upload / execute interface from any
297 workstation on any network, make the following change (and note that
298 you *must* secure this for a production instance):
299 * Replace `Require host 10.0.0.0/8` with `Require all granted`
300 . Change the user for the Apache server.
301 * As the *root* Linux account, edit
302 `/etc/apache2/envvars`. Change `export APACHE_RUN_USER=www-data` to
303 `export APACHE_RUN_USER=opensrf`.
304 . As the *root* Linux account, configure Apache with KeepAlive settings
305 appropriate for Evergreen. Higher values can improve the performance of a
306 single client by allowing multiple requests to be sent over the same TCP
307 connection, but increase the risk of using up all available Apache child
308 processes and memory.
309 * Edit `/etc/apache2/apache2.conf`.
310 a. Change `KeepAliveTimeout` to `1`.
311 b. Change `MaxKeepAliveRequests` to `100`.
312 . As the *root* Linux account, configure the prefork module to start and keep
313 enough Apache servers available to provide quick responses to clients without
314 running out of memory. The following settings are a good starting point for a
315 site that exposes the default Evergreen catalogue to the web:
317 .`/etc/apache2/mods-available/mpm_prefork.conf`
319 ------------------------------------------------------------------------------
320 <IfModule mpm_prefork_module>
325 MaxConnectionsPerChild 500
327 ------------------------------------------------------------------------------
329 . As the *root* user, enable the mpm_prefork module:
332 ------------------------------------------------------------------------------
335 ------------------------------------------------------------------------------
337 . As the *root* Linux account, enable the Evergreen site:
340 ------------------------------------------------------------------------------
341 a2dissite 000-default # OPTIONAL: disable the default site (the "It Works" page)
343 ------------------------------------------------------------------------------
345 . As the *root* Linux account, enable Apache to write
346 to the lock directory; this is currently necessary because Apache
347 is running as the `opensrf` user:
350 ------------------------------------------------------------------------------
351 chown opensrf /var/lock/apache2
352 ------------------------------------------------------------------------------
354 Learn more about additional Apache options in the following sections:
356 * <<_apache_rewrite_tricks,Apache Rewrite Tricks>>
357 * <<_apache_access_handler_perl_module,Apache Access Handler Perl Module>>
359 Configure OpenSRF for the Evergreen application
360 -----------------------------------------------
361 There are a number of example OpenSRF configuration files in `/openils/conf/`
362 that you can use as a template for your Evergreen installation. Issue the
363 following commands as the *opensrf* Linux account:
366 ------------------------------------------------------------------------------
367 cp -b /openils/conf/opensrf_core.xml.example /openils/conf/opensrf_core.xml
368 cp -b /openils/conf/opensrf.xml.example /openils/conf/opensrf.xml
369 ------------------------------------------------------------------------------
371 When you installed OpenSRF, you created four Jabber users on two
372 separate domains and edited the `opensrf_core.xml` file accordingly. Please
373 refer back to the OpenSRF README and, as the *opensrf* Linux account, edit the
374 Evergreen version of the `opensrf_core.xml` file using the same Jabber users
375 and domains as you used while installing and testing OpenSRF.
378 The `-b` flag tells the `cp` command to create a backup version of the
379 destination file. The backup version of the destination file has a tilde (`~`)
380 appended to the file name, so if you have forgotten the Jabber users and
381 domains, you can retrieve the settings from the backup version of the files.
383 `eg_db_config`, described in <<_creating_the_evergreen_database,Creating the Evergreen
384 database>>, sets the database connection information in `opensrf.xml` for you.
386 Configure action triggers for the Evergreen application
387 -------------------------------------------------------
388 _Action Triggers_ provide hooks for the system to perform actions when a given
389 event occurs; for example, to generate reminder or overdue notices, the
390 `checkout.due` hook is processed and events are triggered for potential actions
391 if there is no checkin time.
393 To enable the default set of hooks, issue the following command as the
394 *opensrf* Linux account:
397 ------------------------------------------------------------------------------
398 cp -b /openils/conf/action_trigger_filters.json.example /openils/conf/action_trigger_filters.json
399 ------------------------------------------------------------------------------
401 For more information about configuring and running action triggers, see
402 <<_processing_action_triggers,Notifications / Action Triggers>>.
404 Creating the Evergreen database
405 -------------------------------
407 Setting up the PostgreSQL server
408 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
410 For production use, most libraries install the PostgreSQL database server on a
411 dedicated machine. Therefore, by default, the `Makefile.install` prerequisite
412 installer does *not* install the PostgreSQL 9 database server that is required
413 by every Evergreen system. You can install the packages required by Debian or
414 Ubuntu on the machine of your choice using the following commands as the
415 *root* Linux account:
417 . Installing PostgreSQL server packages
419 Each OS build target provides the postgres server installation packages
420 required for each operating system. To install Postgres server packages,
421 use the make target 'postgres-server-<OSTYPE>'. Choose the most appropriate
422 command below based on your operating system.
425 ------------------------------------------------------------------------------
426 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-stretch
427 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-jessie
428 make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-xenial
429 make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-bionic
430 ------------------------------------------------------------------------------
432 For a standalone PostgreSQL server, install the following Perl modules for your
433 distribution as the *root* Linux account:
436 No extra modules required for these distributions.
438 You need to create a PostgreSQL superuser to create and access the database.
439 Issue the following command as the *postgres* Linux account to create a new
440 PostgreSQL superuser named `evergreen`. When prompted, enter the new user's
444 ------------------------------------------------------------------------------
445 createuser -s -P evergreen
446 ------------------------------------------------------------------------------
448 .Enabling connections to the PostgreSQL database
450 Your PostgreSQL database may be configured by default to prevent connections,
451 for example, it might reject attempts to connect via TCP/IP or from other
452 servers. To enable TCP/IP connections from localhost, check your `pg_hba.conf`
453 file, found in the `/etc/postgresql/` directory on Debian and Ubuntu.
454 A simple way to enable TCP/IP
455 connections from localhost to all databases with password authentication, which
456 would be suitable for a test install of Evergreen on a single server, is to
457 ensure the file contains the following entries _before_ any "host ... ident"
460 ------------------------------------------------------------------------------
461 host all all ::1/128 md5
462 host all all 127.0.0.1/32 md5
463 ------------------------------------------------------------------------------
465 When you change the `pg_hba.conf` file, you will need to reload PostgreSQL to
466 make the changes take effect. For more information on configuring connectivity
468 http://www.postgresql.org/docs/devel/static/auth-pg-hba-conf.html
470 Creating the Evergreen database and schema
471 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
473 Once you have created the *evergreen* PostgreSQL account, you also need to
474 create the database and schema, and configure your configuration files to point
475 at the database server. Issue the following command as the *root* Linux account
476 from inside the Evergreen source directory, replacing <user>, <password>,
477 <hostname>, <port>, and <dbname> with the appropriate values for your
478 PostgreSQL database (where <user> and <password> are for the *evergreen*
479 PostgreSQL account you just created), and replace <admin-user> and <admin-pass>
480 with the values you want for the *egadmin* Evergreen administrator account:
483 ------------------------------------------------------------------------------
484 perl Open-ILS/src/support-scripts/eg_db_config --update-config \
485 --service all --create-database --create-schema --create-offline \
486 --user <user> --password <password> --hostname <hostname> --port <port> \
487 --database <dbname> --admin-user <admin-user> --admin-pass <admin-pass>
488 ------------------------------------------------------------------------------
490 This creates the database and schema and configures all of the services in
491 your `/openils/conf/opensrf.xml` configuration file to point to that database.
492 It also creates the configuration files required by the Evergreen `cgi-bin`
493 administration scripts, and sets the user name and password for the *egadmin*
494 Evergreen administrator account to your requested values.
496 You can get a complete set of options for `eg_db_config` by passing the
501 If you add the `--load-all-sample` parameter to the `eg_db_config` command,
502 a set of authority and bibliographic records, call numbers, copies, staff
503 and regular users, and transactions will be loaded into your target
504 database. This sample dataset is commonly referred to as the _concerto_
505 sample data, and can be useful for testing out Evergreen functionality and
506 for creating problem reports that developers can easily recreate with their
507 own copy of the _concerto_ sample data.
509 Creating the database on a remote server
510 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
511 In a production instance of Evergreen, your PostgreSQL server should be
512 installed on a dedicated server.
514 PostgreSQL 9.4 and later
515 ^^^^^^^^^^^^^^^^^^^^^^^^
516 To create the database instance on a remote database server running PostgreSQL
517 9.4 or later, simply use the `--create-database` flag on `eg_db_config`.
521 1. As the *root* Linux account, start the `memcached` and `ejabberd` services
522 (if they aren't already running):
525 ------------------------------------------------------------------------------
526 /etc/init.d/ejabberd start
527 /etc/init.d/memcached start
528 ------------------------------------------------------------------------------
530 2. As the *opensrf* Linux account, start Evergreen. The `-l` flag in the
531 following command is only necessary if you want to force Evergreen to treat the
532 hostname as `localhost`; if you configured `opensrf.xml` using the real
533 hostname of your machine as returned by `perl -ENet::Domain 'print
534 Net::Domain::hostfqdn() . "\n";'`, you should not use the `-l` flag.
537 ------------------------------------------------------------------------------
538 osrf_control -l --start-all
539 ------------------------------------------------------------------------------
541 ** If you receive the error message `bash: osrf_control: command not found`,
542 then your environment variable `PATH` does not include the `/openils/bin`
543 directory; this should have been set in the *opensrf* Linux account's
544 `.bashrc` configuration file. To manually set the `PATH` variable, edit the
545 configuration file `~/.bashrc` as the *opensrf* Linux account and add the
549 ------------------------------------------------------------------------------
550 export PATH=$PATH:/openils/bin
551 ------------------------------------------------------------------------------
553 3. As the *opensrf* Linux account, generate the Web files needed by the web staff
554 client and catalogue and update the organization unit proximity (you need to do
555 this the first time you start Evergreen, and after that each time you change the library org unit configuration.
559 ------------------------------------------------------------------------------
561 ------------------------------------------------------------------------------
563 4. As the *root* Linux account, restart the Apache Web server:
566 ------------------------------------------------------------------------------
567 /etc/init.d/apache2 restart
568 ------------------------------------------------------------------------------
570 If the Apache Web server was running when you started the OpenSRF services, you
571 might not be able to successfully log in to the OPAC or web staff client until the
572 Apache Web server is restarted.
574 Testing connections to Evergreen
575 --------------------------------
577 Once you have installed and started Evergreen, test your connection to
578 Evergreen via `srfsh`. As the *opensrf* Linux account, issue the following
579 commands to start `srfsh` and try to log onto the Evergreen server using the
580 *egadmin* Evergreen administrator user name and password that you set using the
581 `eg_db_config` command:
584 ------------------------------------------------------------------------------
586 srfsh% login <admin-user> <admin-pass>
587 ------------------------------------------------------------------------------
589 You should see a result like:
591 Received Data: "250bf1518c7527a03249858687714376"
592 ------------------------------------
593 Request Completed Successfully
594 Request Time in seconds: 0.045286
595 ------------------------------------
599 "textcode":"SUCCESS",
602 "stacktrace":"oils_auth.c:304",
604 "authtoken":"e5f9827cc0f93b503a1cc66bee6bdd1a",
610 ------------------------------------
611 Request Completed Successfully
612 Request Time in seconds: 1.336568
613 ------------------------------------
614 [[install-troubleshooting-1]]
615 If this does not work, it's time to do some troubleshooting.
617 * As the *opensrf* Linux account, run the `settings-tester.pl` script to see
618 if it finds any system configuration problems. The script is found at
619 `Open-ILS/src/support-scripts/settings-tester.pl` in the Evergreen source
621 * Follow the steps in the http://evergreen-ils.org/dokuwiki/doku.php?id=troubleshooting:checking_for_errors[troubleshooting guide].
622 * If you have faithfully followed the entire set of installation steps
623 listed here, you are probably extremely close to a working system.
624 Gather your configuration files and log files and contact the
625 http://evergreen-ils.org/communicate/mailing-lists/[Evergreen development
626 mailing list] for assistance before making any drastic changes to your system
632 Need help installing or using Evergreen? Join the mailing lists at
633 http://evergreen-ils.org/communicate/mailing-lists/ or contact us on the Freenode
634 IRC network on the #evergreen channel.
638 This work is licensed under the Creative Commons Attribution-ShareAlike 3.0
639 Unported License. To view a copy of this license, visit
640 http://creativecommons.org/licenses/by-sa/3.0/ or send a letter to Creative
641 Commons, 444 Castro Street, Suite 900, Mountain View, California, 94041, USA.