1 = Installing the Evergreen server =
4 == Preamble: referenced user accounts ==
6 In subsequent sections, we will refer to a number of different accounts, as
10 ** The *user* Linux account is the account that you use to log onto the
11 Linux system as a regular user.
12 ** The *root* Linux account is an account that has system administrator
13 privileges. On Debian you can switch to this account from
14 your *user* account by issuing the `su -` command and entering the
15 password for the *root* account when prompted. On Ubuntu you can switch
16 to this account from your *user* account using the `sudo su -` command
17 and entering the password for your *user* account when prompted.
18 ** The *opensrf* Linux account is an account that you create when installing
19 OpenSRF. You can switch to this account from the *root* account by
20 issuing the `su - opensrf` command.
21 ** The *postgres* Linux account is created automatically when you install
22 the PostgreSQL database server. You can switch to this account from the
23 *root* account by issuing the `su - postgres` command.
24 * PostgreSQL user accounts:
25 ** The *evergreen* PostgreSQL account is a superuser account that you will
26 create to connect to the PostgreSQL database server.
27 * Evergreen administrator account:
28 ** The *egadmin* Evergreen account is an administrator account for
29 Evergreen that you will use to test connectivity and configure your
32 == Preamble: developer instructions ==
35 Skip this section if you are using an official release tarball downloaded
36 from http://evergreen-ils.org/egdownloads
38 Developers working directly with the source code from the Git repository,
39 rather than an official release tarball, must perform one step before they
40 can proceed with the `./configure` step.
42 As the *user* Linux account, issue the following command in the Evergreen
43 source directory to generate the configure script and Makefiles:
46 ------------------------------------------------------------------------------
48 ------------------------------------------------------------------------------
50 == Installing prerequisites ==
52 * **PostgreSQL**: The minimum supported version is 9.6.
53 * **Linux**: Evergreen has been tested on
57 Ubuntu Bionic Beaver (18.04),
58 and Ubuntu Xenial Xerus (16.04).
59 If you are running an older version of these distributions, you may want
60 to upgrade before upgrading Evergreen. For instructions on upgrading these
61 distributions, visit the Debian or Ubuntu websites.
62 * **OpenSRF**: The minimum supported version of OpenSRF is 3.2.0.
65 Evergreen has a number of prerequisite packages that must be installed
66 before you can successfully configure, compile, and install Evergreen.
68 1. Begin by installing the most recent version of OpenSRF (3.2.0 or later).
69 You can download OpenSRF releases from http://evergreen-ils.org/opensrf-downloads/
71 2. Issue the following commands as the *root* Linux account to install
72 prerequisites using the `Makefile.install` prerequisite installer,
73 substituting `debian-buster`,`debian-stretch`,`debian-jessie`,`ubuntu-bionic`, or
74 `ubuntu-xenial` for <osname> below:
77 ------------------------------------------------------------------------------
78 make -f Open-ILS/src/extras/Makefile.install <osname>
79 ------------------------------------------------------------------------------
81 [[optional_developer_additions]]
82 3. OPTIONAL: Developer additions
84 To perform certain developer tasks from a Git source code checkout,
85 additional packages may be required. As the *root* Linux account:
87 * To install packages needed for retrieving and managing web dependencies,
88 use the <osname>-developer Makefile.install target. Currently,
89 this is only needed for building and installing the web
93 ------------------------------------------------------------------------------
94 make -f Open-ILS/src/extras/Makefile.install <osname>-developer
95 ------------------------------------------------------------------------------
97 * To install packages required for building Evergreen translations, use
98 the <osname>-translator Makefile.install target.
101 ------------------------------------------------------------------------------
102 make -f Open-ILS/src/extras/Makefile.install <osname>-translator
103 ------------------------------------------------------------------------------
105 * To install packages required for building Evergreen release bundles, use
106 the <osname>-packager Makefile.install target.
109 ------------------------------------------------------------------------------
110 make -f Open-ILS/src/extras/Makefile.install <osname>-packager
111 ------------------------------------------------------------------------------
113 == Extra steps for web staff client ==
116 Skip this entire section if you are using an official release tarball downloaded
117 from http://evergreen-ils.org/downloads
119 === Install dependencies for web staff client ===
122 You may skip this section if you have installed the
123 <<optional_developer_additions,optional developer additions>>. You will still need to do the following
124 steps in <<install_files_for_web_staff_client,Install files for web staff client>>.
126 1. Install the long-term stability (LTS) release of
127 https://nodejs.org[Node.js]. Add the Node.js `/bin` directory to your
128 environment variable `PATH`.
130 [[install_files_for_web_staff_client]]
131 === Install AngularJS files for web staff client ===
133 1. Building, Testing, Minification: The remaining steps all take place within
134 the staff JS web root:
137 ------------------------------------------------------------------------------
138 cd $EVERGREEN_ROOT/Open-ILS/web/js/ui/default/staff/
139 ------------------------------------------------------------------------------
141 2. Install Project-local Dependencies. npm inspects the 'package.json' file
142 for dependencies and fetches them from the Node package network.
145 ------------------------------------------------------------------------------
146 npm install # fetch JS dependencies
147 ------------------------------------------------------------------------------
149 3. Run the build script.
152 ------------------------------------------------------------------------------
153 # build, run tests, concat+minify
156 ------------------------------------------------------------------------------
158 [[install_files_for_angular_web_staff_client]]
159 === Install Angular files for web staff client ===
161 1. Building, Testing, Minification: The remaining steps all take place within
162 the Angular staff root:
165 ------------------------------------------------------------------------------
166 cd $EVERGREEN_ROOT/Open-ILS/src/eg2/
167 ------------------------------------------------------------------------------
169 2. Install Project-local Dependencies. npm inspects the 'package.json' file
170 for dependencies and fetches them from the Node package network.
173 ------------------------------------------------------------------------------
174 npm install # fetch JS dependencies
175 ------------------------------------------------------------------------------
177 3. Run the build script.
180 ------------------------------------------------------------------------------
181 # build and run tests
184 ------------------------------------------------------------------------------
186 == Configuration and compilation instructions ==
188 For the time being, we are still installing everything in the `/openils/`
189 directory. From the Evergreen source directory, issue the following commands as
190 the *user* Linux account to configure and build Evergreen:
193 ------------------------------------------------------------------------------
194 PATH=/openils/bin:$PATH ./configure --prefix=/openils --sysconfdir=/openils/conf
196 ------------------------------------------------------------------------------
198 These instructions assume that you have also installed OpenSRF under `/openils/`.
199 If not, please adjust PATH as needed so that the Evergreen `configure` script
200 can find `osrf_config`.
202 == Installation instructions ==
204 1. Once you have configured and compiled Evergreen, issue the following
205 command as the *root* Linux account to install Evergreen and copy
206 example configuration files to `/openils/conf`.
209 ------------------------------------------------------------------------------
211 ------------------------------------------------------------------------------
213 == Change ownership of the Evergreen files ==
215 All files in the `/openils/` directory and subdirectories must be owned by the
216 `opensrf` user. Issue the following command as the *root* Linux account to
217 change the ownership on the files:
220 ------------------------------------------------------------------------------
221 chown -R opensrf:opensrf /openils
222 ------------------------------------------------------------------------------
226 On Debian Stretch / Buster, run the following command as the root user:
229 ------------------------------------------------------------------------------
231 ------------------------------------------------------------------------------
233 == Additional Instructions for Developers ==
236 Skip this section if you are using an official release tarball downloaded
237 from http://evergreen-ils.org/egdownloads
239 Developers working directly with the source code from the Git repository,
240 rather than an official release tarball, need to install the Dojo Toolkit
241 set of JavaScript libraries. The appropriate version of Dojo is included in
242 Evergreen release tarballs. Developers should install the Dojo 1.3.3 version
243 of Dojo by issuing the following commands as the *opensrf* Linux account:
246 ------------------------------------------------------------------------------
247 wget http://download.dojotoolkit.org/release-1.3.3/dojo-release-1.3.3.tar.gz
248 tar -C /openils/var/web/js -xzf dojo-release-1.3.3.tar.gz
249 cp -r /openils/var/web/js/dojo-release-1.3.3/* /openils/var/web/js/dojo/.
250 ------------------------------------------------------------------------------
253 == Configure the Apache Web server ==
255 . Use the example configuration files to configure your Web server for
256 the Evergreen catalog, web staff client, Web services, and administration
257 interfaces. Issue the following commands as the *root* Linux account:
260 ------------------------------------------------------------------------------------
261 cp Open-ILS/examples/apache_24/eg_24.conf /etc/apache2/sites-available/eg.conf
262 cp Open-ILS/examples/apache_24/eg_vhost_24.conf /etc/apache2/eg_vhost.conf
263 cp Open-ILS/examples/apache_24/eg_startup /etc/apache2/
265 mkdir /etc/apache2/ssl
267 ------------------------------------------------------------------------------------
269 . The `openssl` command cuts a new SSL key for your Apache server. For a
270 production server, you should purchase a signed SSL certificate, but you can
271 just use a self-signed certificate and accept the warnings in the
272 and browser during testing and development. Create an SSL key for the Apache
273 server by issuing the following command as the *root* Linux account:
276 ------------------------------------------------------------------------------
277 openssl req -new -x509 -days 365 -nodes -out server.crt -keyout server.key
278 ------------------------------------------------------------------------------
280 . As the *root* Linux account, edit the `eg.conf` file that you copied into
282 a. To enable access to the offline upload / execute interface from any
283 workstation on any network, make the following change (and note that
284 you *must* secure this for a production instance):
285 * Replace `Require host 10.0.0.0/8` with `Require all granted`
286 . Change the user for the Apache server.
287 * As the *root* Linux account, edit
288 `/etc/apache2/envvars`. Change `export APACHE_RUN_USER=www-data` to
289 `export APACHE_RUN_USER=opensrf`.
290 . As the *root* Linux account, configure Apache with KeepAlive settings
291 appropriate for Evergreen. Higher values can improve the performance of a
292 single client by allowing multiple requests to be sent over the same TCP
293 connection, but increase the risk of using up all available Apache child
294 processes and memory.
295 * Edit `/etc/apache2/apache2.conf`.
296 a. Change `KeepAliveTimeout` to `1`.
297 b. Change `MaxKeepAliveRequests` to `100`.
298 . As the *root* Linux account, configure the prefork module to start and keep
299 enough Apache servers available to provide quick responses to clients without
300 running out of memory. The following settings are a good starting point for a
301 site that exposes the default Evergreen catalogue to the web:
303 .`/etc/apache2/mods-available/mpm_prefork.conf`
305 ------------------------------------------------------------------------------
306 <IfModule mpm_prefork_module>
311 MaxConnectionsPerChild 500
313 ------------------------------------------------------------------------------
315 . As the *root* user, enable the mpm_prefork module:
318 ------------------------------------------------------------------------------
321 ------------------------------------------------------------------------------
323 . As the *root* Linux account, enable the Evergreen site:
326 ------------------------------------------------------------------------------
327 a2dissite 000-default # OPTIONAL: disable the default site (the "It Works" page)
329 ------------------------------------------------------------------------------
331 . As the *root* Linux account, enable Apache to write
332 to the lock directory; this is currently necessary because Apache
333 is running as the `opensrf` user:
336 ------------------------------------------------------------------------------
337 chown opensrf /var/lock/apache2
338 ------------------------------------------------------------------------------
340 Learn more about additional Apache options in the following sections:
342 * xref:admin:apache_rewrite_tricks.adoc#apache_rewrite_tricks[Apache Rewrite Tricks]
343 * xref:admin:apache_access_handler.adoc#apache_access_handler_perl_module[Apache Access Handler Perl Module]
345 == Configure OpenSRF for the Evergreen application ==
347 There are a number of example OpenSRF configuration files in `/openils/conf/`
348 that you can use as a template for your Evergreen installation. Issue the
349 following commands as the *opensrf* Linux account:
352 ------------------------------------------------------------------------------
353 cp -b /openils/conf/opensrf_core.xml.example /openils/conf/opensrf_core.xml
354 cp -b /openils/conf/opensrf.xml.example /openils/conf/opensrf.xml
355 ------------------------------------------------------------------------------
357 When you installed OpenSRF, you created four Jabber users on two
358 separate domains and edited the `opensrf_core.xml` file accordingly. Please
359 refer back to the OpenSRF README and, as the *opensrf* Linux account, edit the
360 Evergreen version of the `opensrf_core.xml` file using the same Jabber users
361 and domains as you used while installing and testing OpenSRF.
364 The `-b` flag tells the `cp` command to create a backup version of the
365 destination file. The backup version of the destination file has a tilde (`~`)
366 appended to the file name, so if you have forgotten the Jabber users and
367 domains, you can retrieve the settings from the backup version of the files.
369 `eg_db_config`, described in xref:#creating_the_evergreen_database[Creating the Evergreen database], sets the database connection information in `opensrf.xml` for you.
371 === Configure action triggers for the Evergreen application ===
372 _Action Triggers_ provide hooks for the system to perform actions when a given
373 event occurs; for example, to generate reminder or overdue notices, the
374 `checkout.due` hook is processed and events are triggered for potential actions
375 if there is no checkin time.
377 To enable the default set of hooks, issue the following command as the
378 *opensrf* Linux account:
381 ------------------------------------------------------------------------------
382 cp -b /openils/conf/action_trigger_filters.json.example /openils/conf/action_trigger_filters.json
383 ------------------------------------------------------------------------------
385 For more information about configuring and running action triggers, see
386 xref:admin:actiontriggers_process.adoc#processing_action_triggers[Notifications / Action Triggers].
388 [#creating_the_evergreen_database]
389 == Creating the Evergreen database ==
391 === Setting up the PostgreSQL server ===
393 For production use, most libraries install the PostgreSQL database server on a
394 dedicated machine. Therefore, by default, the `Makefile.install` prerequisite
395 installer does *not* install the PostgreSQL 9 database server that is required
396 by every Evergreen system. You can install the packages required by Debian or
397 Ubuntu on the machine of your choice using the following commands as the
398 *root* Linux account:
400 . Installing PostgreSQL server packages
402 Each OS build target provides the postgres server installation packages
403 required for each operating system. To install Postgres server packages,
404 use the make target 'postgres-server-<OSTYPE>'. Choose the most appropriate
405 command below based on your operating system.
408 ------------------------------------------------------------------------------
409 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-buster
410 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-stretch
411 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-jessie
412 make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-xenial
413 make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-bionic
414 ------------------------------------------------------------------------------
416 For a standalone PostgreSQL server, install the following Perl modules for your
417 distribution as the *root* Linux account:
420 No extra modules required for these distributions.
422 You need to create a PostgreSQL superuser to create and access the database.
423 Issue the following command as the *postgres* Linux account to create a new
424 PostgreSQL superuser named `evergreen`. When prompted, enter the new user's
428 ------------------------------------------------------------------------------
429 createuser -s -P evergreen
430 ------------------------------------------------------------------------------
432 .Enabling connections to the PostgreSQL database
434 Your PostgreSQL database may be configured by default to prevent connections,
435 for example, it might reject attempts to connect via TCP/IP or from other
436 servers. To enable TCP/IP connections from localhost, check your `pg_hba.conf`
437 file, found in the `/etc/postgresql/` directory on Debian and Ubuntu.
438 A simple way to enable TCP/IP
439 connections from localhost to all databases with password authentication, which
440 would be suitable for a test install of Evergreen on a single server, is to
441 ensure the file contains the following entries _before_ any "host ... ident"
444 ------------------------------------------------------------------------------
445 host all all ::1/128 md5
446 host all all 127.0.0.1/32 md5
447 ------------------------------------------------------------------------------
449 When you change the `pg_hba.conf` file, you will need to reload PostgreSQL to
450 make the changes take effect. For more information on configuring connectivity
452 http://www.postgresql.org/docs/devel/static/auth-pg-hba-conf.html
454 === Creating the Evergreen database and schema ===
456 Once you have created the *evergreen* PostgreSQL account, you also need to
457 create the database and schema, and configure your configuration files to point
458 at the database server. Issue the following command as the *root* Linux account
459 from inside the Evergreen source directory, replacing <user>, <password>,
460 <hostname>, <port>, and <dbname> with the appropriate values for your
461 PostgreSQL database (where <user> and <password> are for the *evergreen*
462 PostgreSQL account you just created), and replace <admin-user> and <admin-pass>
463 with the values you want for the *egadmin* Evergreen administrator account:
466 ------------------------------------------------------------------------------
467 perl Open-ILS/src/support-scripts/eg_db_config --update-config \
468 --service all --create-database --create-schema --create-offline \
469 --user <user> --password <password> --hostname <hostname> --port <port> \
470 --database <dbname> --admin-user <admin-user> --admin-pass <admin-pass>
471 ------------------------------------------------------------------------------
473 This creates the database and schema and configures all of the services in
474 your `/openils/conf/opensrf.xml` configuration file to point to that database.
475 It also creates the configuration files required by the Evergreen `cgi-bin`
476 administration scripts, and sets the user name and password for the *egadmin*
477 Evergreen administrator account to your requested values.
479 You can get a complete set of options for `eg_db_config` by passing the
482 === Loading sample data ===
484 If you add the `--load-all-sample` parameter to the `eg_db_config` command,
485 a set of authority and bibliographic records, call numbers, copies, staff
486 and regular users, and transactions will be loaded into your target
487 database. This sample dataset is commonly referred to as the _concerto_
488 sample data, and can be useful for testing out Evergreen functionality and
489 for creating problem reports that developers can easily recreate with their
490 own copy of the _concerto_ sample data.
492 === Creating the database on a remote server ===
494 In a production instance of Evergreen, your PostgreSQL server should be
495 installed on a dedicated server.
497 ==== PostgreSQL 9.6 and later ====
499 To create the database instance on a remote database server running PostgreSQL
500 9.6 or later, simply use the `--create-database` flag on `eg_db_config`.
502 == Starting Evergreen ==
504 1. As the *root* Linux account, start the `memcached` and `ejabberd` services
505 (if they aren't already running):
508 ------------------------------------------------------------------------------
509 /etc/init.d/ejabberd start
510 /etc/init.d/memcached start
511 ------------------------------------------------------------------------------
513 2. As the *opensrf* Linux account, start Evergreen. The `-l` flag in the
514 following command is only necessary if you want to force Evergreen to treat the
515 hostname as `localhost`; if you configured `opensrf.xml` using the real
516 hostname of your machine as returned by `perl -ENet::Domain 'print
517 Net::Domain::hostfqdn() . "\n";'`, you should not use the `-l` flag.
520 ------------------------------------------------------------------------------
521 osrf_control -l --start-all
522 ------------------------------------------------------------------------------
524 ** If you receive the error message `bash: osrf_control: command not found`,
525 then your environment variable `PATH` does not include the `/openils/bin`
526 directory; this should have been set in the *opensrf* Linux account's
527 `.bashrc` configuration file. To manually set the `PATH` variable, edit the
528 configuration file `~/.bashrc` as the *opensrf* Linux account and add the
532 ------------------------------------------------------------------------------
533 export PATH=$PATH:/openils/bin
534 ------------------------------------------------------------------------------
536 3. As the *opensrf* Linux account, generate the Web files needed by the web staff
537 client and catalogue and update the organization unit proximity (you need to do
538 this the first time you start Evergreen, and after that each time you change the library org unit configuration.
542 ------------------------------------------------------------------------------
544 ------------------------------------------------------------------------------
546 4. As the *root* Linux account, restart the Apache Web server:
549 ------------------------------------------------------------------------------
550 /etc/init.d/apache2 restart
551 ------------------------------------------------------------------------------
553 If the Apache Web server was running when you started the OpenSRF services, you
554 might not be able to successfully log in to the OPAC or web staff client until the
555 Apache Web server is restarted.
557 == Testing connections to Evergreen ==
559 Once you have installed and started Evergreen, test your connection to
560 Evergreen via `srfsh`. As the *opensrf* Linux account, issue the following
561 commands to start `srfsh` and try to log onto the Evergreen server using the
562 *egadmin* Evergreen administrator user name and password that you set using the
563 `eg_db_config` command:
566 ------------------------------------------------------------------------------
568 srfsh% login <admin-user> <admin-pass>
569 ------------------------------------------------------------------------------
571 You should see a result like:
573 Received Data: "250bf1518c7527a03249858687714376"
574 ------------------------------------
575 Request Completed Successfully
576 Request Time in seconds: 0.045286
577 ------------------------------------
581 "textcode":"SUCCESS",
584 "stacktrace":"oils_auth.c:304",
586 "authtoken":"e5f9827cc0f93b503a1cc66bee6bdd1a",
592 ------------------------------------
593 Request Completed Successfully
594 Request Time in seconds: 1.336568
595 ------------------------------------
596 [[install-troubleshooting-1]]
597 If this does not work, it's time to do some troubleshooting.
599 * As the *opensrf* Linux account, run the `settings-tester.pl` script to see
600 if it finds any system configuration problems. The script is found at
601 `Open-ILS/src/support-scripts/settings-tester.pl` in the Evergreen source
603 * Follow the steps in the http://evergreen-ils.org/dokuwiki/doku.php?id=troubleshooting:checking_for_errors[troubleshooting guide].
604 * If you have faithfully followed the entire set of installation steps
605 listed here, you are probably extremely close to a working system.
606 Gather your configuration files and log files and contact the
607 http://evergreen-ils.org/communicate/mailing-lists/[Evergreen development
608 mailing list] for assistance before making any drastic changes to your system
613 Need help installing or using Evergreen? Join the mailing lists at
614 http://evergreen-ils.org/communicate/mailing-lists/ or contact us on the Freenode
615 IRC network on the #evergreen channel.
619 This work is licensed under the Creative Commons Attribution-ShareAlike 3.0
620 Unported License. To view a copy of this license, visit
621 http://creativecommons.org/licenses/by-sa/3.0/ or send a letter to Creative
622 Commons, 444 Castro Street, Suite 900, Mountain View, California, 94041, USA.