1 Installing the Evergreen server
2 ===============================
6 Preamble: referenced user accounts
7 ----------------------------------
9 In subsequent sections, we will refer to a number of different accounts, as
12 * Linux user accounts:
13 ** The *user* Linux account is the account that you use to log onto the
14 Linux system as a regular user.
15 ** The *root* Linux account is an account that has system administrator
16 privileges. On Debian you can switch to this account from
17 your *user* account by issuing the `su -` command and entering the
18 password for the *root* account when prompted. On Ubuntu you can switch
19 to this account from your *user* account using the `sudo su -` command
20 and entering the password for your *user* account when prompted.
21 ** The *opensrf* Linux account is an account that you create when installing
22 OpenSRF. You can switch to this account from the *root* account by
23 issuing the `su - opensrf` command.
24 ** The *postgres* Linux account is created automatically when you install
25 the PostgreSQL database server. You can switch to this account from the
26 *root* account by issuing the `su - postgres` command.
27 * PostgreSQL user accounts:
28 ** The *evergreen* PostgreSQL account is a superuser account that you will
29 create to connect to the PostgreSQL database server.
30 * Evergreen administrator account:
31 ** The *egadmin* Evergreen account is an administrator account for
32 Evergreen that you will use to test connectivity and configure your
35 Preamble: developer instructions
36 --------------------------------
39 Skip this section if you are using an official release tarball downloaded
40 from http://evergreen-ils.org/egdownloads
42 Developers working directly with the source code from the Git repository,
43 rather than an official release tarball, must perform one step before they
44 can proceed with the `./configure` step.
46 As the *user* Linux account, issue the following command in the Evergreen
47 source directory to generate the configure script and Makefiles:
50 ------------------------------------------------------------------------------
52 ------------------------------------------------------------------------------
54 Installing prerequisites
55 ------------------------
57 * **PostgreSQL**: The minimum supported version is 9.4.
58 * **Linux**: Evergreen has been tested on Debian Stretch (9),
59 Debian Jessie (8), Ubuntu Xenial Xerus (16.04), and Ubuntu
61 If you are running an older version of these distributions, you may want
62 to upgrade before upgrading Evergreen. For instructions on upgrading these
63 distributions, visit the Debian or Ubuntu websites.
64 * **OpenSRF**: The minimum supported version of OpenSRF is 3.0.0.
67 Evergreen has a number of prerequisite packages that must be installed
68 before you can successfully configure, compile, and install Evergreen.
70 1. Begin by installing the most recent version of OpenSRF (3.0.0 or later).
71 You can download OpenSRF releases from http://evergreen-ils.org/opensrf-downloads/
72 2. On some distributions, it is necessary to install PostgreSQL 9.4+ from external
75 * Ubuntu (Trusty) comes with an older version of PostgreSQL, so
76 steps are taken to automatically utilize the PostgreSQL
77 community's apt sources.
78 (For complete details, see: https://wiki.postgresql.org/wiki/Apt)
79 * Debian (Jessie/Stretch) and Ubuntu (Xenial) comes with PostgreSQL 9.4+,
80 so no additional steps are required.
82 3. Issue the following commands as the *root* Linux account to install
83 prerequisites using the `Makefile.install` prerequisite installer,
84 substituting `debian-stretch`, `debian-jessie`,`ubuntu-xenial`,
85 or `ubuntu-trusty` for <osname> below:
88 ------------------------------------------------------------------------------
89 make -f Open-ILS/src/extras/Makefile.install <osname>
90 ------------------------------------------------------------------------------
92 4. OPTIONAL: Developer additions
94 To perform certain developer tasks from a Git source code checkout,
95 additional packages may be required. As the *root* Linux account:
97 * To install packages needed for retrieving and managing web dependencies,
98 use the <osname>-developer Makefile.install target. Currently,
99 this is only needed for building and installing the web
103 ------------------------------------------------------------------------------
104 make -f Open-ILS/src/extras/Makefile.install <osname>-developer
105 ------------------------------------------------------------------------------
107 * To install packages required for building Evergreen translations, use
108 the <osname>-translator Makefile.install target.
111 ------------------------------------------------------------------------------
112 make -f Open-ILS/src/extras/Makefile.install <osname>-translator
113 ------------------------------------------------------------------------------
115 * To install packages required for building Evergreen release bundles, use
116 the <osname>-packager Makefile.install target.
119 ------------------------------------------------------------------------------
120 make -f Open-ILS/src/extras/Makefile.install <osname>-packager
121 ------------------------------------------------------------------------------
123 Extra steps for web staff client
124 --------------------------------
127 Skip this entire section if you are using an official release tarball downloaded
128 from http://evergreen-ils.org/downloads
130 Install dependencies for web staff client
131 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
134 You may skip this section if you have installed the
135 <<optional_developer_additions,optional developer additions>>. You will still need to do the following
136 steps in <<install_files_for_web_staff_client,Install files for web staff client>>.
138 1. Install the long-term stability (LTS) release of
139 https://nodejs.org[Node.js]. Add the Node.js `/bin` directory to your
140 environment variable `PATH`.
142 [[install_files_for_web_staff_client]]
143 Install AngularJS files for web staff client
144 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
146 1. Building, Testing, Minification: The remaining steps all take place within
147 the staff JS web root:
150 ------------------------------------------------------------------------------
151 cd $EVERGREEN_ROOT/Open-ILS/web/js/ui/default/staff/
152 ------------------------------------------------------------------------------
154 2. Install Project-local Dependencies. npm inspects the 'package.json' file
155 for dependencies and fetches them from the Node package network.
158 ------------------------------------------------------------------------------
159 npm install # fetch JS dependencies
160 ------------------------------------------------------------------------------
162 3. Run the build script.
165 ------------------------------------------------------------------------------
166 # build, run tests, concat+minify
169 ------------------------------------------------------------------------------
171 [[install_files_for_angular_web_staff_client]]
172 Install Angular files for web staff client
173 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
175 1. Building, Testing, Minification: The remaining steps all take place within
176 the Angular staff root:
179 ------------------------------------------------------------------------------
180 cd $EVERGREEN_ROOT/Open-ILS/src/eg2/
181 ------------------------------------------------------------------------------
183 2. Install Project-local Dependencies. npm inspects the 'package.json' file
184 for dependencies and fetches them from the Node package network.
187 ------------------------------------------------------------------------------
188 npm install # fetch JS dependencies
189 ------------------------------------------------------------------------------
191 3. Run the build script.
194 ------------------------------------------------------------------------------
195 # build and run tests
198 ------------------------------------------------------------------------------
200 Configuration and compilation instructions
201 ------------------------------------------
203 For the time being, we are still installing everything in the `/openils/`
204 directory. From the Evergreen source directory, issue the following commands as
205 the *user* Linux account to configure and build Evergreen:
208 ------------------------------------------------------------------------------
209 PATH=/openils/bin:$PATH ./configure --prefix=/openils --sysconfdir=/openils/conf
211 ------------------------------------------------------------------------------
213 These instructions assume that you have also installed OpenSRF under `/openils/`.
214 If not, please adjust PATH as needed so that the Evergreen `configure` script
215 can find `osrf_config`.
217 Installation instructions
218 -------------------------
220 1. Once you have configured and compiled Evergreen, issue the following
221 command as the *root* Linux account to install Evergreen and copy
222 example configuration files to `/openils/conf`.
225 ------------------------------------------------------------------------------
227 ------------------------------------------------------------------------------
229 Change ownership of the Evergreen files
230 ---------------------------------------
232 All files in the `/openils/` directory and subdirectories must be owned by the
233 `opensrf` user. Issue the following command as the *root* Linux account to
234 change the ownership on the files:
237 ------------------------------------------------------------------------------
238 chown -R opensrf:opensrf /openils
239 ------------------------------------------------------------------------------
244 On Debian Stretch, run the following command as the root user:
247 ------------------------------------------------------------------------------
249 ------------------------------------------------------------------------------
251 Additional Instructions for Developers
252 --------------------------------------
255 Skip this section if you are using an official release tarball downloaded
256 from http://evergreen-ils.org/egdownloads
258 Developers working directly with the source code from the Git repository,
259 rather than an official release tarball, need to install the Dojo Toolkit
260 set of JavaScript libraries. The appropriate version of Dojo is included in
261 Evergreen release tarballs. Developers should install the Dojo 1.3.3 version
262 of Dojo by issuing the following commands as the *opensrf* Linux account:
265 ------------------------------------------------------------------------------
266 wget http://download.dojotoolkit.org/release-1.3.3/dojo-release-1.3.3.tar.gz
267 tar -C /openils/var/web/js -xzf dojo-release-1.3.3.tar.gz
268 cp -r /openils/var/web/js/dojo-release-1.3.3/* /openils/var/web/js/dojo/.
269 ------------------------------------------------------------------------------
272 Configure the Apache Web server
273 -------------------------------
275 . Use the example configuration files to configure your Web server for
276 the Evergreen catalog, web staff client, Web services, and administration
277 interfaces. Issue the following commands as the *root* Linux account:
280 ------------------------------------------------------------------------------------
281 cp Open-ILS/examples/apache_24/eg_24.conf /etc/apache2/sites-available/eg.conf
282 cp Open-ILS/examples/apache_24/eg_vhost_24.conf /etc/apache2/eg_vhost.conf
283 cp Open-ILS/examples/apache_24/eg_startup /etc/apache2/
285 mkdir /etc/apache2/ssl
287 ------------------------------------------------------------------------------------
289 . The `openssl` command cuts a new SSL key for your Apache server. For a
290 production server, you should purchase a signed SSL certificate, but you can
291 just use a self-signed certificate and accept the warnings in the
292 and browser during testing and development. Create an SSL key for the Apache
293 server by issuing the following command as the *root* Linux account:
296 ------------------------------------------------------------------------------
297 openssl req -new -x509 -days 365 -nodes -out server.crt -keyout server.key
298 ------------------------------------------------------------------------------
300 . As the *root* Linux account, edit the `eg.conf` file that you copied into
302 a. To enable access to the offline upload / execute interface from any
303 workstation on any network, make the following change (and note that
304 you *must* secure this for a production instance):
305 * Replace `Require host 10.0.0.0/8` with `Require all granted`
306 . Change the user for the Apache server.
307 * As the *root* Linux account, edit
308 `/etc/apache2/envvars`. Change `export APACHE_RUN_USER=www-data` to
309 `export APACHE_RUN_USER=opensrf`.
310 . As the *root* Linux account, configure Apache with KeepAlive settings
311 appropriate for Evergreen. Higher values can improve the performance of a
312 single client by allowing multiple requests to be sent over the same TCP
313 connection, but increase the risk of using up all available Apache child
314 processes and memory.
315 * Edit `/etc/apache2/apache2.conf`.
316 a. Change `KeepAliveTimeout` to `1`.
317 b. Change `MaxKeepAliveRequests` to `100`.
318 . As the *root* Linux account, configure the prefork module to start and keep
319 enough Apache servers available to provide quick responses to clients without
320 running out of memory. The following settings are a good starting point for a
321 site that exposes the default Evergreen catalogue to the web:
323 .`/etc/apache2/mods-available/mpm_prefork.conf`
325 ------------------------------------------------------------------------------
326 <IfModule mpm_prefork_module>
331 MaxConnectionsPerChild 500
333 ------------------------------------------------------------------------------
335 . As the *root* user, enable the mpm_prefork module:
338 ------------------------------------------------------------------------------
341 ------------------------------------------------------------------------------
343 . As the *root* Linux account, enable the Evergreen site:
346 ------------------------------------------------------------------------------
347 a2dissite 000-default # OPTIONAL: disable the default site (the "It Works" page)
349 ------------------------------------------------------------------------------
351 . As the *root* Linux account, enable Apache to write
352 to the lock directory; this is currently necessary because Apache
353 is running as the `opensrf` user:
356 ------------------------------------------------------------------------------
357 chown opensrf /var/lock/apache2
358 ------------------------------------------------------------------------------
360 Learn more about additional Apache options in the following sections:
362 * <<_apache_rewrite_tricks,Apache Rewrite Tricks>>
363 * <<_apache_access_handler_perl_module,Apache Access Handler Perl Module>>
365 Configure OpenSRF for the Evergreen application
366 -----------------------------------------------
367 There are a number of example OpenSRF configuration files in `/openils/conf/`
368 that you can use as a template for your Evergreen installation. Issue the
369 following commands as the *opensrf* Linux account:
372 ------------------------------------------------------------------------------
373 cp -b /openils/conf/opensrf_core.xml.example /openils/conf/opensrf_core.xml
374 cp -b /openils/conf/opensrf.xml.example /openils/conf/opensrf.xml
375 ------------------------------------------------------------------------------
377 When you installed OpenSRF, you created four Jabber users on two
378 separate domains and edited the `opensrf_core.xml` file accordingly. Please
379 refer back to the OpenSRF README and, as the *opensrf* Linux account, edit the
380 Evergreen version of the `opensrf_core.xml` file using the same Jabber users
381 and domains as you used while installing and testing OpenSRF.
384 The `-b` flag tells the `cp` command to create a backup version of the
385 destination file. The backup version of the destination file has a tilde (`~`)
386 appended to the file name, so if you have forgotten the Jabber users and
387 domains, you can retrieve the settings from the backup version of the files.
389 `eg_db_config`, described in <<_creating_the_evergreen_database,Creating the Evergreen
390 database>>, sets the database connection information in `opensrf.xml` for you.
392 Configure action triggers for the Evergreen application
393 -------------------------------------------------------
394 _Action Triggers_ provide hooks for the system to perform actions when a given
395 event occurs; for example, to generate reminder or overdue notices, the
396 `checkout.due` hook is processed and events are triggered for potential actions
397 if there is no checkin time.
399 To enable the default set of hooks, issue the following command as the
400 *opensrf* Linux account:
403 ------------------------------------------------------------------------------
404 cp -b /openils/conf/action_trigger_filters.json.example /openils/conf/action_trigger_filters.json
405 ------------------------------------------------------------------------------
407 For more information about configuring and running action triggers, see
408 <<_processing_action_triggers,Notifications / Action Triggers>>.
410 Creating the Evergreen database
411 -------------------------------
413 Setting up the PostgreSQL server
414 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
416 For production use, most libraries install the PostgreSQL database server on a
417 dedicated machine. Therefore, by default, the `Makefile.install` prerequisite
418 installer does *not* install the PostgreSQL 9 database server that is required
419 by every Evergreen system. You can install the packages required by Debian or
420 Ubuntu on the machine of your choice using the following commands as the
421 *root* Linux account:
423 . Installing PostgreSQL server packages
425 Each OS build target provides the postgres server installation packages
426 required for each operating system. To install Postgres server packages,
427 use the make target 'postgres-server-<OSTYPE>'. Choose the most appropriate
428 command below based on your operating system.
431 ------------------------------------------------------------------------------
432 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-stretch
433 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-jessie
434 make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-trusty
435 make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-xenial
436 ------------------------------------------------------------------------------
438 For a standalone PostgreSQL server, install the following Perl modules for your
439 distribution as the *root* Linux account:
442 No extra modules required for these distributions.
444 You need to create a PostgreSQL superuser to create and access the database.
445 Issue the following command as the *postgres* Linux account to create a new
446 PostgreSQL superuser named `evergreen`. When prompted, enter the new user's
450 ------------------------------------------------------------------------------
451 createuser -s -P evergreen
452 ------------------------------------------------------------------------------
454 .Enabling connections to the PostgreSQL database
456 Your PostgreSQL database may be configured by default to prevent connections,
457 for example, it might reject attempts to connect via TCP/IP or from other
458 servers. To enable TCP/IP connections from localhost, check your `pg_hba.conf`
459 file, found in the `/etc/postgresql/` directory on Debian and Ubuntu.
460 A simple way to enable TCP/IP
461 connections from localhost to all databases with password authentication, which
462 would be suitable for a test install of Evergreen on a single server, is to
463 ensure the file contains the following entries _before_ any "host ... ident"
466 ------------------------------------------------------------------------------
467 host all all ::1/128 md5
468 host all all 127.0.0.1/32 md5
469 ------------------------------------------------------------------------------
471 When you change the `pg_hba.conf` file, you will need to reload PostgreSQL to
472 make the changes take effect. For more information on configuring connectivity
474 http://www.postgresql.org/docs/devel/static/auth-pg-hba-conf.html
476 Creating the Evergreen database and schema
477 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
479 Once you have created the *evergreen* PostgreSQL account, you also need to
480 create the database and schema, and configure your configuration files to point
481 at the database server. Issue the following command as the *root* Linux account
482 from inside the Evergreen source directory, replacing <user>, <password>,
483 <hostname>, <port>, and <dbname> with the appropriate values for your
484 PostgreSQL database (where <user> and <password> are for the *evergreen*
485 PostgreSQL account you just created), and replace <admin-user> and <admin-pass>
486 with the values you want for the *egadmin* Evergreen administrator account:
489 ------------------------------------------------------------------------------
490 perl Open-ILS/src/support-scripts/eg_db_config --update-config \
491 --service all --create-database --create-schema --create-offline \
492 --user <user> --password <password> --hostname <hostname> --port <port> \
493 --database <dbname> --admin-user <admin-user> --admin-pass <admin-pass>
494 ------------------------------------------------------------------------------
496 This creates the database and schema and configures all of the services in
497 your `/openils/conf/opensrf.xml` configuration file to point to that database.
498 It also creates the configuration files required by the Evergreen `cgi-bin`
499 administration scripts, and sets the user name and password for the *egadmin*
500 Evergreen administrator account to your requested values.
502 You can get a complete set of options for `eg_db_config` by passing the
507 If you add the `--load-all-sample` parameter to the `eg_db_config` command,
508 a set of authority and bibliographic records, call numbers, copies, staff
509 and regular users, and transactions will be loaded into your target
510 database. This sample dataset is commonly referred to as the _concerto_
511 sample data, and can be useful for testing out Evergreen functionality and
512 for creating problem reports that developers can easily recreate with their
513 own copy of the _concerto_ sample data.
515 Creating the database on a remote server
516 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
517 In a production instance of Evergreen, your PostgreSQL server should be
518 installed on a dedicated server.
520 PostgreSQL 9.4 and later
521 ^^^^^^^^^^^^^^^^^^^^^^^^
522 To create the database instance on a remote database server running PostgreSQL
523 9.4 or later, simply use the `--create-database` flag on `eg_db_config`.
527 1. As the *root* Linux account, start the `memcached` and `ejabberd` services
528 (if they aren't already running):
531 ------------------------------------------------------------------------------
532 /etc/init.d/ejabberd start
533 /etc/init.d/memcached start
534 ------------------------------------------------------------------------------
536 2. As the *opensrf* Linux account, start Evergreen. The `-l` flag in the
537 following command is only necessary if you want to force Evergreen to treat the
538 hostname as `localhost`; if you configured `opensrf.xml` using the real
539 hostname of your machine as returned by `perl -ENet::Domain 'print
540 Net::Domain::hostfqdn() . "\n";'`, you should not use the `-l` flag.
543 ------------------------------------------------------------------------------
544 osrf_control -l --start-all
545 ------------------------------------------------------------------------------
547 ** If you receive the error message `bash: osrf_control: command not found`,
548 then your environment variable `PATH` does not include the `/openils/bin`
549 directory; this should have been set in the *opensrf* Linux account's
550 `.bashrc` configuration file. To manually set the `PATH` variable, edit the
551 configuration file `~/.bashrc` as the *opensrf* Linux account and add the
555 ------------------------------------------------------------------------------
556 export PATH=$PATH:/openils/bin
557 ------------------------------------------------------------------------------
559 3. As the *opensrf* Linux account, generate the Web files needed by the web staff
560 client and catalogue and update the organization unit proximity (you need to do
561 this the first time you start Evergreen, and after that each time you change the library org unit configuration.
565 ------------------------------------------------------------------------------
567 ------------------------------------------------------------------------------
569 4. As the *root* Linux account, restart the Apache Web server:
572 ------------------------------------------------------------------------------
573 /etc/init.d/apache2 restart
574 ------------------------------------------------------------------------------
576 If the Apache Web server was running when you started the OpenSRF services, you
577 might not be able to successfully log in to the OPAC or web staff client until the
578 Apache Web server is restarted.
580 Testing connections to Evergreen
581 --------------------------------
583 Once you have installed and started Evergreen, test your connection to
584 Evergreen via `srfsh`. As the *opensrf* Linux account, issue the following
585 commands to start `srfsh` and try to log onto the Evergreen server using the
586 *egadmin* Evergreen administrator user name and password that you set using the
587 `eg_db_config` command:
590 ------------------------------------------------------------------------------
592 srfsh% login <admin-user> <admin-pass>
593 ------------------------------------------------------------------------------
595 You should see a result like:
597 Received Data: "250bf1518c7527a03249858687714376"
598 ------------------------------------
599 Request Completed Successfully
600 Request Time in seconds: 0.045286
601 ------------------------------------
605 "textcode":"SUCCESS",
608 "stacktrace":"oils_auth.c:304",
610 "authtoken":"e5f9827cc0f93b503a1cc66bee6bdd1a",
616 ------------------------------------
617 Request Completed Successfully
618 Request Time in seconds: 1.336568
619 ------------------------------------
620 [[install-troubleshooting-1]]
621 If this does not work, it's time to do some troubleshooting.
623 * As the *opensrf* Linux account, run the `settings-tester.pl` script to see
624 if it finds any system configuration problems. The script is found at
625 `Open-ILS/src/support-scripts/settings-tester.pl` in the Evergreen source
627 * Follow the steps in the http://evergreen-ils.org/dokuwiki/doku.php?id=troubleshooting:checking_for_errors[troubleshooting guide].
628 * If you have faithfully followed the entire set of installation steps
629 listed here, you are probably extremely close to a working system.
630 Gather your configuration files and log files and contact the
631 http://evergreen-ils.org/communicate/mailing-lists/[Evergreen development
632 mailing list] for assistance before making any drastic changes to your system
638 Need help installing or using Evergreen? Join the mailing lists at
639 http://evergreen-ils.org/communicate/mailing-lists/ or contact us on the Freenode
640 IRC network on the #evergreen channel.
644 This work is licensed under the Creative Commons Attribution-ShareAlike 3.0
645 Unported License. To view a copy of this license, visit
646 http://creativecommons.org/licenses/by-sa/3.0/ or send a letter to Creative
647 Commons, 444 Castro Street, Suite 900, Mountain View, California, 94041, USA.