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 Focal Fossa (20.04),
58 and Ubuntu Bionic Beaver (18.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-focal`,
74 or `ubuntu-bionic` 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 are 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
91 * To optionally run Angular and AngularJS tests you will need to manually
92 install Firefox and your choice of Chromium or Chrome.
95 ------------------------------------------------------------------------------
96 make -f Open-ILS/src/extras/Makefile.install <osname>-developer
97 ------------------------------------------------------------------------------
99 * To install packages required for building Evergreen translations, use
100 the <osname>-translator Makefile.install target.
103 ------------------------------------------------------------------------------
104 make -f Open-ILS/src/extras/Makefile.install <osname>-translator
105 ------------------------------------------------------------------------------
107 * To install packages required for building Evergreen release bundles, use
108 the <osname>-packager Makefile.install target.
111 ------------------------------------------------------------------------------
112 make -f Open-ILS/src/extras/Makefile.install <osname>-packager
113 ------------------------------------------------------------------------------
115 == Extra steps for web staff client ==
118 Skip this entire section if you are using an official release tarball downloaded
119 from http://evergreen-ils.org/downloads. Otherwise, ensure you have installed the
120 xref:#optional_developer_additions[optional developer additions] before proceeding.
122 [[install_files_for_web_staff_client]]
123 === Install AngularJS files for web staff client ===
125 1. Building, Testing, Minification: The remaining steps all take place within
126 the staff JS web root:
129 ------------------------------------------------------------------------------
130 cd $EVERGREEN_ROOT/Open-ILS/web/js/ui/default/staff/
131 ------------------------------------------------------------------------------
133 2. Install Project-local Dependencies. npm inspects the 'package.json' file
134 for dependencies and fetches them from the Node package network.
137 ------------------------------------------------------------------------------
138 npm install # fetch JS dependencies
139 ------------------------------------------------------------------------------
141 3. Run the build script.
144 ------------------------------------------------------------------------------
146 ------------------------------------------------------------------------------
148 4. OPTIONAL: Test web client code if the <osname>-developer packages and
149 the necessary browsers are installed.
150 CHROME_BIN should be set to the path to chrome or chromimum, e.g.,
154 ------------------------------------------------------------------------------
155 CHROME_BIN=/path/to/chrome npm run test
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 ------------------------------------------------------------------------------
182 ------------------------------------------------------------------------------
184 4. OPTIONAL: Test eg2 web client code if the <osname>-developer packages and
185 the necessary browsers are installed:
186 CHROME_BIN should be set to the path to chrome or chromimum, e.g.,
190 ------------------------------------------------------------------------------
191 CHROME_BIN=/path/to/chrome npm run test
192 ------------------------------------------------------------------------------
194 [[install_opac_deps]]
195 === Install OPAC skin dependencies ===
197 1. The following steps take place within the OPAC dependencies root:
200 ------------------------------------------------------------------------------
201 cd $EVERGREEN_ROOT/Open-ILS/web/opac/deps
202 ------------------------------------------------------------------------------
204 2. Install Project-local Dependencies. npm inspects the 'package.json' file
205 for dependencies and fetches them from the Node package network.
208 ------------------------------------------------------------------------------
209 npm install # fetch JS and CSS dependencies
210 ------------------------------------------------------------------------------
212 Note that there is no build step.
214 == Configuration and compilation instructions ==
216 For the time being, we are still installing everything in the `/openils/`
217 directory. From the Evergreen source directory, issue the following commands as
218 the *user* Linux account to configure and build Evergreen:
221 ------------------------------------------------------------------------------
222 PATH=/openils/bin:$PATH ./configure --prefix=/openils --sysconfdir=/openils/conf
224 ------------------------------------------------------------------------------
226 These instructions assume that you have also installed OpenSRF under `/openils/`.
227 If not, please adjust PATH as needed so that the Evergreen `configure` script
228 can find `osrf_config`.
230 == Installation instructions ==
232 1. Once you have configured and compiled Evergreen, issue the following
233 command as the *root* Linux account to install Evergreen and copy
234 example configuration files to `/openils/conf`.
237 ------------------------------------------------------------------------------
239 ------------------------------------------------------------------------------
241 == Change ownership of the Evergreen files ==
243 All files in the `/openils/` directory and subdirectories must be owned by the
244 `opensrf` user. Issue the following command as the *root* Linux account to
245 change the ownership on the files:
248 ------------------------------------------------------------------------------
249 chown -R opensrf:opensrf /openils
250 ------------------------------------------------------------------------------
254 On Ubuntu 18.04 / 20.04 or Debian Stretch / Buster, run the following command as the root user:
257 ------------------------------------------------------------------------------
259 ------------------------------------------------------------------------------
261 == Additional Instructions for Developers ==
264 Skip this section if you are using an official release tarball downloaded
265 from http://evergreen-ils.org/egdownloads
267 Developers working directly with the source code from the Git repository,
268 rather than an official release tarball, need to install the Dojo Toolkit
269 set of JavaScript libraries. The appropriate version of Dojo is included in
270 Evergreen release tarballs. Developers should install the Dojo 1.3.3 version
271 of Dojo by issuing the following commands as the *opensrf* Linux account:
274 ------------------------------------------------------------------------------
275 wget http://download.dojotoolkit.org/release-1.3.3/dojo-release-1.3.3.tar.gz
276 tar -C /openils/var/web/js -xzf dojo-release-1.3.3.tar.gz
277 cp -r /openils/var/web/js/dojo-release-1.3.3/* /openils/var/web/js/dojo/.
278 ------------------------------------------------------------------------------
281 == Configure the Apache Web server ==
283 . Use the example configuration files to configure your Web server for
284 the Evergreen catalog, web staff client, Web services, and administration
285 interfaces. Issue the following commands as the *root* Linux account:
288 ------------------------------------------------------------------------------------
289 cp Open-ILS/examples/apache_24/eg_24.conf /etc/apache2/sites-available/eg.conf
290 cp Open-ILS/examples/apache_24/eg_vhost_24.conf /etc/apache2/eg_vhost.conf
291 cp Open-ILS/examples/apache_24/eg_startup /etc/apache2/
293 mkdir /etc/apache2/ssl
295 ------------------------------------------------------------------------------------
297 . The `openssl` command cuts a new SSL key for your Apache server. For a
298 production server, you should purchase a signed SSL certificate, but you can
299 just use a self-signed certificate and accept the warnings in the
300 and browser during testing and development. Create an SSL key for the Apache
301 server by issuing the following command as the *root* Linux account:
304 ------------------------------------------------------------------------------
305 openssl req -new -x509 -days 365 -nodes -out server.crt -keyout server.key
306 ------------------------------------------------------------------------------
308 . As the *root* Linux account, edit the `eg.conf` file that you copied into
310 a. To enable access to the offline upload / execute interface from any
311 workstation on any network, make the following change (and note that
312 you *must* secure this for a production instance):
313 * Replace `Require host 10.0.0.0/8` with `Require all granted`
314 . Change the user for the Apache server.
315 * As the *root* Linux account, edit
316 `/etc/apache2/envvars`. Change `export APACHE_RUN_USER=www-data` to
317 `export APACHE_RUN_USER=opensrf`.
318 . As the *root* Linux account, configure Apache with KeepAlive settings
319 appropriate for Evergreen. Higher values can improve the performance of a
320 single client by allowing multiple requests to be sent over the same TCP
321 connection, but increase the risk of using up all available Apache child
322 processes and memory.
323 * Edit `/etc/apache2/apache2.conf`.
324 a. Change `KeepAliveTimeout` to `1`.
325 b. Change `MaxKeepAliveRequests` to `100`.
326 . As the *root* Linux account, configure the prefork module to start and keep
327 enough Apache servers available to provide quick responses to clients without
328 running out of memory. The following settings are a good starting point for a
329 site that exposes the default Evergreen catalog to the web:
331 .`/etc/apache2/mods-available/mpm_prefork.conf`
333 ------------------------------------------------------------------------------
334 <IfModule mpm_prefork_module>
339 MaxConnectionsPerChild 500
341 ------------------------------------------------------------------------------
343 . As the *root* user, enable the mpm_prefork module:
346 ------------------------------------------------------------------------------
349 ------------------------------------------------------------------------------
351 . As the *root* Linux account, enable the Evergreen site:
354 ------------------------------------------------------------------------------
355 a2dissite 000-default # OPTIONAL: disable the default site (the "It Works" page)
357 ------------------------------------------------------------------------------
359 . As the *root* Linux account, enable Apache to write
360 to the lock directory; this is currently necessary because Apache
361 is running as the `opensrf` user:
364 ------------------------------------------------------------------------------
365 chown opensrf /var/lock/apache2
366 ------------------------------------------------------------------------------
368 Learn more about additional Apache options in the following sections:
370 * xref:admin:apache_rewrite_tricks.adoc#apache_rewrite_tricks[Apache Rewrite Tricks]
371 * xref:admin:apache_access_handler.adoc#apache_access_handler_perl_module[Apache Access Handler Perl Module]
373 == Configure OpenSRF for the Evergreen application ==
375 There are a number of example OpenSRF configuration files in `/openils/conf/`
376 that you can use as a template for your Evergreen installation. Issue the
377 following commands as the *opensrf* Linux account:
380 ------------------------------------------------------------------------------
381 cp -b /openils/conf/opensrf_core.xml.example /openils/conf/opensrf_core.xml
382 cp -b /openils/conf/opensrf.xml.example /openils/conf/opensrf.xml
383 ------------------------------------------------------------------------------
385 When you installed OpenSRF, you created four Jabber users on two
386 separate domains and edited the `opensrf_core.xml` file accordingly. Please
387 refer back to the OpenSRF README and, as the *opensrf* Linux account, edit the
388 Evergreen version of the `opensrf_core.xml` file using the same Jabber users
389 and domains as you used while installing and testing OpenSRF.
392 The `-b` flag tells the `cp` command to create a backup version of the
393 destination file. The backup version of the destination file has a tilde (`~`)
394 appended to the file name, so if you have forgotten the Jabber users and
395 domains, you can retrieve the settings from the backup version of the files.
397 `eg_db_config`, described in xref:#creating_the_evergreen_database[Creating the Evergreen database], sets the database connection information in `opensrf.xml` for you.
399 === Configure action triggers for the Evergreen application ===
400 _Action Triggers_ provide hooks for the system to perform actions when a given
401 event occurs; for example, to generate reminder or overdue notices, the
402 `checkout.due` hook is processed and events are triggered for potential actions
403 if there is no checkin time.
405 To enable the default set of hooks, issue the following command as the
406 *opensrf* Linux account:
409 ------------------------------------------------------------------------------
410 cp -b /openils/conf/action_trigger_filters.json.example /openils/conf/action_trigger_filters.json
411 ------------------------------------------------------------------------------
413 For more information about configuring and running action triggers, see
414 xref:admin:actiontriggers_process.adoc#processing_action_triggers[Notifications / Action Triggers].
416 [[creating_the_evergreen_database]]
417 == Creating the Evergreen database ==
419 === Setting up the PostgreSQL server ===
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. This will install PostgreSQL 9.6,
434 the minimum supported version.
437 ------------------------------------------------------------------------------
438 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-buster
439 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-stretch
440 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-jessie
441 make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-bionic
442 make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-focal
443 ------------------------------------------------------------------------------
445 To install PostgreSQL version 10, use the following command for your operating
449 ------------------------------------------------------------------------------
450 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-buster-10
451 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-stretch-10
452 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-jessie-10
453 make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-bionic-10
454 make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-focal-10
455 ------------------------------------------------------------------------------
457 For a standalone PostgreSQL server, install the following Perl modules for your
458 distribution as the *root* Linux account:
461 No extra modules required for these distributions.
463 You need to create a PostgreSQL superuser to create and access the database.
464 Issue the following command as the *postgres* Linux account to create a new
465 PostgreSQL superuser named `evergreen`. When prompted, enter the new user's
469 ------------------------------------------------------------------------------
470 createuser -s -P evergreen
471 ------------------------------------------------------------------------------
473 .Enabling connections to the PostgreSQL database
475 Your PostgreSQL database may be configured by default to prevent connections,
476 for example, it might reject attempts to connect via TCP/IP or from other
477 servers. To enable TCP/IP connections from localhost, check your `pg_hba.conf`
478 file, found in the `/etc/postgresql/` directory on Debian and Ubuntu.
479 A simple way to enable TCP/IP
480 connections from localhost to all databases with password authentication, which
481 would be suitable for a test install of Evergreen on a single server, is to
482 ensure the file contains the following entries _before_ any "host ... ident"
485 ------------------------------------------------------------------------------
486 host all all ::1/128 md5
487 host all all 127.0.0.1/32 md5
488 ------------------------------------------------------------------------------
490 When you change the `pg_hba.conf` file, you will need to reload PostgreSQL to
491 make the changes take effect. For more information on configuring connectivity
493 http://www.postgresql.org/docs/devel/static/auth-pg-hba-conf.html
495 === Creating the Evergreen database and schema ===
497 Once you have created the *evergreen* PostgreSQL account, you also need to
498 create the database and schema, and configure your configuration files to point
499 at the database server. Issue the following command as the *root* Linux account
500 from inside the Evergreen source directory, replacing <user>, <password>,
501 <hostname>, <port>, and <dbname> with the appropriate values for your
502 PostgreSQL database (where <user> and <password> are for the *evergreen*
503 PostgreSQL account you just created), and replace <admin-user> and <admin-pass>
504 with the values you want for the *egadmin* Evergreen administrator account:
507 ------------------------------------------------------------------------------
508 perl Open-ILS/src/support-scripts/eg_db_config --update-config \
509 --service all --create-database --create-schema --create-offline \
510 --user <user> --password <password> --hostname <hostname> --port <port> \
511 --database <dbname> --admin-user <admin-user> --admin-pass <admin-pass>
512 ------------------------------------------------------------------------------
514 This creates the database and schema and configures all of the services in
515 your `/openils/conf/opensrf.xml` configuration file to point to that database.
516 It also creates the configuration files required by the Evergreen `cgi-bin`
517 administration scripts, and sets the user name and password for the *egadmin*
518 Evergreen administrator account to your requested values.
520 You can get a complete set of options for `eg_db_config` by passing the
523 === Loading sample data ===
525 If you add the `--load-all-sample` parameter to the `eg_db_config` command,
526 a set of authority and bibliographic records, call numbers, copies, staff
527 and regular users, and transactions will be loaded into your target
528 database. This sample dataset is commonly referred to as the _concerto_
529 sample data, and can be useful for testing out Evergreen functionality and
530 for creating problem reports that developers can easily recreate with their
531 own copy of the _concerto_ sample data.
533 === Creating the database on a remote server ===
535 In a production instance of Evergreen, your PostgreSQL server should be
536 installed on a dedicated server.
538 ==== PostgreSQL 9.6 and later ====
540 To create the database instance on a remote database server running PostgreSQL
541 9.6 or later, simply use the `--create-database` flag on `eg_db_config`.
543 == Starting Evergreen ==
545 1. As the *root* Linux account, start the `memcached` and `ejabberd` services
546 (if they aren't already running):
549 ------------------------------------------------------------------------------
550 /etc/init.d/ejabberd start
551 /etc/init.d/memcached start
552 ------------------------------------------------------------------------------
554 2. As the *opensrf* Linux account, start Evergreen. The `-l` flag in the
555 following command is only necessary if you want to force Evergreen to treat the
556 hostname as `localhost`; if you configured `opensrf.xml` using the real
557 hostname of your machine as returned by `perl -ENet::Domain 'print
558 Net::Domain::hostfqdn() . "\n";'`, you should not use the `-l` flag.
561 ------------------------------------------------------------------------------
562 osrf_control -l --start-all
563 ------------------------------------------------------------------------------
565 ** If you receive the error message `bash: osrf_control: command not found`,
566 then your environment variable `PATH` does not include the `/openils/bin`
567 directory; this should have been set in the *opensrf* Linux account's
568 `.bashrc` configuration file. To manually set the `PATH` variable, edit the
569 configuration file `~/.bashrc` as the *opensrf* Linux account and add the
573 ------------------------------------------------------------------------------
574 export PATH=$PATH:/openils/bin
575 ------------------------------------------------------------------------------
577 3. As the *opensrf* Linux account, generate the Web files needed by the web staff
578 client and catalog and update the organization unit proximity (you need to do
579 this the first time you start Evergreen, and after that each time you change the library org unit configuration.
583 ------------------------------------------------------------------------------
585 ------------------------------------------------------------------------------
587 4. As the *root* Linux account, restart the Apache Web server:
590 ------------------------------------------------------------------------------
591 /etc/init.d/apache2 restart
592 ------------------------------------------------------------------------------
594 If the Apache Web server was running when you started the OpenSRF services, you
595 might not be able to successfully log in to the OPAC or web staff client until the
596 Apache Web server is restarted.
598 == Testing connections to Evergreen ==
600 Once you have installed and started Evergreen, test your connection to
601 Evergreen via `srfsh`. As the *opensrf* Linux account, issue the following
602 commands to start `srfsh` and try to log onto the Evergreen server using the
603 *egadmin* Evergreen administrator user name and password that you set using the
604 `eg_db_config` command:
607 ------------------------------------------------------------------------------
609 srfsh% login <admin-user> <admin-pass>
610 ------------------------------------------------------------------------------
612 You should see a result like:
614 Received Data: "250bf1518c7527a03249858687714376"
615 ------------------------------------
616 Request Completed Successfully
617 Request Time in seconds: 0.045286
618 ------------------------------------
622 "textcode":"SUCCESS",
625 "stacktrace":"oils_auth.c:304",
627 "authtoken":"e5f9827cc0f93b503a1cc66bee6bdd1a",
633 ------------------------------------
634 Request Completed Successfully
635 Request Time in seconds: 1.336568
636 ------------------------------------
637 [[install-troubleshooting-1]]
638 If this does not work, it's time to do some troubleshooting.
640 * As the *opensrf* Linux account, run the `settings-tester.pl` script to see
641 if it finds any system configuration problems. The script is found at
642 `Open-ILS/src/support-scripts/settings-tester.pl` in the Evergreen source
644 * Follow the steps in the http://evergreen-ils.org/dokuwiki/doku.php?id=troubleshooting:checking_for_errors[troubleshooting guide].
645 * If you have faithfully followed the entire set of installation steps
646 listed here, you are probably extremely close to a working system.
647 Gather your configuration files and log files and contact the
648 http://evergreen-ils.org/communicate/mailing-lists/[Evergreen development
649 mailing list] for assistance before making any drastic changes to your system
654 Need help installing or using Evergreen? Join the mailing lists at
655 http://evergreen-ils.org/communicate/mailing-lists/ or contact us on the Freenode
656 IRC network on the #evergreen channel.
660 This work is licensed under the Creative Commons Attribution-ShareAlike 3.0
661 Unported License. To view a copy of this license, visit
662 http://creativecommons.org/licenses/by-sa/3.0/ or send a letter to Creative
663 Commons, 444 Castro Street, Suite 900, Mountain View, California, 94041, USA.