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 and Fedora 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**: Version 9.3 is recommended. The minimum supported version
59 * **Linux**: Evergreen 2.8 has been tested on Debian Jessie (8.0),
60 Debian Wheezy (7.0), Ubuntu Trusty Tahr (14.04),
61 Ubuntu Precise Pangolin (12.04), and Fedora.
62 If you are running an older version of these distributions, you may want
63 to upgrade before upgrading Evergreen. For instructions on upgrading these
64 distributions, visit the Debian, Ubuntu or Fedora websites.
65 * **OpenSRF**: The minimum supported version of OpenSRF is 2.4.0.
68 Evergreen has a number of prerequisite packages that must be installed
69 before you can successfully configure, compile, and install Evergreen.
71 1. Begin by installing the most recent version of OpenSRF (2.4.0 or later).
72 You can download OpenSRF releases from http://evergreen-ils.org/opensrf-downloads/
73 2. On some distributions, it is necessary to install PostgreSQL 9.1+ from external
76 * Debian Wheezy and Jessie Ubuntu Precise and Trusty comes with
77 PostgreSQL 9.1+, so no additional steps are required.
78 * Fedora 19 and 20 come with PostgreSQL 9.2+, so no additional steps are required.
80 3. On Debian and Ubuntu, run `aptitude update` as the *root* Linux account to
81 retrieve the new packages from the backports repository.
82 4. Issue the following commands as the *root* Linux account to install
83 prerequisites using the `Makefile.install` prerequisite installer,
84 substituting `debian-jessie`, `debian-wheezy`, `fedora`,
85 `ubuntu-trusty`, or `ubuntu-precise` for <osname> below:
88 ------------------------------------------------------------------------------
89 make -f Open-ILS/src/extras/Makefile.install <osname>
90 ------------------------------------------------------------------------------
92 5. Add the libdbi-libdbd libraries to the system dynamic library path by
93 issuing the following commands as the *root* Linux account:
96 You should skip this step if installing on Ubuntu Precise, Trusty or Debian Jessie. The ubuntu
97 and Debian Jessie targets use libdbd-pgsql from packages.
101 ------------------------------------------------------------------------------
102 echo "/usr/local/lib/dbd" > /etc/ld.so.conf.d/eg.conf
104 ------------------------------------------------------------------------------
108 ------------------------------------------------------------------------------
109 echo "/usr/lib64/dbd" > /etc/ld.so.conf.d/eg.conf
111 ------------------------------------------------------------------------------
113 6. OPTIONAL: Developer additions
115 To perform certain developer tasks from a Git source code checkout,
116 additional packages may be required. As the *root* Linux account:
118 * To install packages needed for retriving and managing web dependencies,
119 use the <osname>-developer Makefile.install target. Currently,
120 this is only needed for building and installing the (preview) browser
124 ------------------------------------------------------------------------------
125 make -f Open-ILS/src/extras/Makefile.install <osname>-developer
126 ------------------------------------------------------------------------------
128 * To install packages required for building Evergreen release bundles, use
129 the <osname>-packager Makefile.install target.
132 ------------------------------------------------------------------------------
133 make -f Open-ILS/src/extras/Makefile.install <osname>-packager
134 ------------------------------------------------------------------------------
136 Configuration and compilation instructions
137 ------------------------------------------
139 For the time being, we are still installing everything in the `/openils/`
140 directory. From the Evergreen source directory, issue the following commands as
141 the *user* Linux account to configure and build Evergreen:
144 ------------------------------------------------------------------------------
145 PATH=/openils/bin:$PATH ./configure --prefix=/openils --sysconfdir=/openils/conf
147 ------------------------------------------------------------------------------
149 These instructions assume that you have also installed OpenSRF under `/openils/`.
150 If not, please adjust PATH as needed so that the Evergreen `configure` script
151 can find `osrf_config`.
153 Installation instructions
154 -------------------------
156 1. Once you have configured and compiled Evergreen, issue the following
157 command as the *root* Linux account to install Evergreen, build the server
158 portion of the staff client, and copy example configuration files to
160 Change the value of the `STAFF_CLIENT_STAMP_ID` variable to match the version
161 of the staff client that you will use to connect to the Evergreen server.
164 ------------------------------------------------------------------------------
165 make STAFF_CLIENT_STAMP_ID=rel_name install
166 ------------------------------------------------------------------------------
168 2. The server portion of the staff client expects `http://hostname/xul/server`
169 to resolve. Issue the following commands as the *root* Linux account to
170 create a symbolic link pointing to the `server` subdirectory of the server
171 portion of the staff client that we just built using the staff client ID
175 ------------------------------------------------------------------------------
176 cd /openils/var/web/xul
177 ln -sf rel_name/server server
178 ------------------------------------------------------------------------------
180 Change ownership of the Evergreen files
181 ---------------------------------------
183 All files in the `/openils/` directory and subdirectories must be owned by the
184 `opensrf` user. Issue the following command as the *root* Linux account to
185 change the ownership on the files:
188 ------------------------------------------------------------------------------
189 chown -R opensrf:opensrf /openils
190 ------------------------------------------------------------------------------
192 Additional Instructions for Developers
193 --------------------------------------
196 Skip this section if you are using an official release tarball downloaded
197 from http://evergreen-ils.org/egdownloads
199 Developers working directly with the source code from the Git repository,
200 rather than an official release tarball, need to install the Dojo Toolkit
201 set of JavaScript libraries. The appropriate version of Dojo is included in
202 Evergreen release tarballs. Developers should install the Dojo 1.3.3 version
203 of Dojo by issuing the following commands as the *opensrf* Linux account:
206 ------------------------------------------------------------------------------
207 wget http://download.dojotoolkit.org/release-1.3.3/dojo-release-1.3.3.tar.gz
208 tar -C /openils/var/web/js -xzf dojo-release-1.3.3.tar.gz
209 cp -r /openils/var/web/js/dojo-release-1.3.3/* /openils/var/web/js/dojo/.
210 ------------------------------------------------------------------------------
213 Configure the Apache Web server
214 -------------------------------
216 1. Use the example configuration files in `Open-ILS/examples/apache/` (for
217 Apache versions below 2.4) or `Open-ILS/examples/apache_24/` (for Apache
218 versions 2.4 or greater) to configure your Web server for the Evergreen
219 catalog, staff client, Web services, and administration interfaces. Issue the
220 following commands as the *root* Linux account:
222 .Debian Wheezy and Ubuntu Precise
224 ------------------------------------------------------------------------------
225 cp Open-ILS/examples/apache/eg.conf /etc/apache2/sites-available/
226 cp Open-ILS/examples/apache/eg_vhost.conf /etc/apache2/
227 cp Open-ILS/examples/apache/eg_startup /etc/apache2/
229 mkdir /etc/apache2/ssl
231 ------------------------------------------------------------------------------
233 .Ubuntu Trusty and Debian Jessie
235 ------------------------------------------------------------------------------------
236 cp Open-ILS/examples/apache_24/eg_24.conf /etc/apache2/sites-available/eg.conf
237 cp Open-ILS/examples/apache_24/eg_vhost_24.conf /etc/apache2/eg_vhost.conf
238 cp Open-ILS/examples/apache/eg_startup /etc/apache2/
240 mkdir /etc/apache2/ssl
242 ------------------------------------------------------------------------------------
246 ------------------------------------------------------------------------------
247 cp Open-ILS/examples/apache_24/eg_24.conf /etc/httpd/conf.d/
248 cp Open-ILS/examples/apache_24/eg_vhost_24.conf /etc/httpd/eg_vhost.conf
249 cp Open-ILS/examples/apache/eg_startup /etc/httpd/
253 ------------------------------------------------------------------------------
255 2. The `openssl` command cuts a new SSL key for your Apache server. For a
256 production server, you should purchase a signed SSL certificate, but you can
257 just use a self-signed certificate and accept the warnings in the staff client
258 and browser during testing and development. Create an SSL key for the Apache
259 server by issuing the following command as the *root* Linux account:
262 ------------------------------------------------------------------------------
263 openssl req -new -x509 -days 365 -nodes -out server.crt -keyout server.key
264 ------------------------------------------------------------------------------
266 3. As the *root* Linux account, edit the `eg.conf` file that you copied into
268 a. To enable access to the offline upload / execute interface from any
269 workstation on any network, make the following change (and note that
270 you *must* secure this for a production instance):
271 * (Apache 2.2): Replace `Allow from 10.0.0.0/8` with `Allow from all`
272 * (Apache 2.4): Replace `Require host 10.0.0.0/8` with `Require all granted`
273 b. (Fedora): Change references from the non-existent `/etc/apache2/` directory
275 4. Change the user for the Apache server.
276 * (Debian and Ubuntu): As the *root* Linux account, edit
277 `/etc/apache2/envvars`. Change `export APACHE_RUN_USER=www-data` to
278 `export APACHE_RUN_USER=opensrf`.
279 * (Fedora): As the *root* Linux account , edit `/etc/httpd/conf/httpd.conf`.
280 Change `User apache` to `User opensrf`.
281 5. Configure Apache with performance settings appropriate for Evergreen:
282 * (Debian and Ubuntu): As the *root* Linux account, edit
283 `/etc/apache2/apache2.conf`:
284 * (Fedora): As the *root* Linux account, edit `/etc/httpd/conf/httpd.conf`:
285 a. Change `KeepAliveTimeout` to `1`. Higher values reduce the chance of
286 a request timing out unexpectedly, but increase the risk of using up
287 all available Apache child processes.
288 b. 'Optional': Change `MaxKeepAliveRequests` to `100`
289 c. (Debian Wheezy, Ubuntu Precise, and Fedora) Update the prefork configuration
290 section to suit your environment. The following settings apply to a busy
294 ------------------------------------------------------------------------------
295 <IfModule mpm_prefork_module>
300 MaxRequestsPerChild 10000
302 ------------------------------------------------------------------------------
303 d. (Ubuntu Trusty, Debian Jessie) As the *root* user, edit
304 /etc/apache2/mods-available/mpm_prefork.conf to match the above values.
305 Then, also as the *root* user, enable the mpm_prefork module by doing:
308 ------------------------------------------------------------------------------
311 ------------------------------------------------------------------------------
313 6. (Fedora): As the *root* Linux account, edit the `/etc/httpd/eg_vhost.conf`
314 file to change references from the non-existent `/etc/apache2/` directory
316 7. (Debian Wheezy and Ubuntu Precise): As the *root* Linux account, enable the Evergreen site:
319 ------------------------------------------------------------------------------
320 a2dissite default # OPTIONAL: disable the default site (the "It Works" page)
322 ------------------------------------------------------------------------------
324 (Ubuntu Trusty, Debian Jessie):
327 ------------------------------------------------------------------------------
328 a2dissite 000-default # OPTIONAL: disable the default site (the "It Works" page)
330 ------------------------------------------------------------------------------
332 8. (Ubuntu): As the *root* Linux account, enable Apache to write
333 to the lock directory; this is currently necessary because Apache
334 is running as the `opensrf` user:
337 ------------------------------------------------------------------------------
338 chown opensrf /var/lock/apache2
339 ------------------------------------------------------------------------------
341 9. Learn more about additional Apache options in the following sections:
342 * <<_apache_rewrite_tricks,Apache Rewrite Tricks>>
343 * <<_apache_access_handler_perl_module,Apache Access Handler Perl Module>>
345 Configure OpenSRF for the Evergreen application
346 -----------------------------------------------
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 the following section, sets the database
370 connection information in `opensrf.xml` for you.
372 Creating the Evergreen database
373 -------------------------------
375 Setting up the PostgreSQL server
376 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
378 For production use, most libraries install the PostgreSQL database server on a
379 dedicated machine. Therefore, by default, the `Makefile.install` prerequisite
380 installer does *not* install the PostgreSQL 9 database server that is required
381 by every Evergreen system. You can install the packages required by Debian or
382 Ubuntu on the machine of your choice using the following commands as the
383 *root* Linux account:
385 .(Debian / Ubuntu / Fedora) Installing PostgreSQL server packages
387 Each OS build target provides the postgres server installation packages
388 required for each operating system. To install Postgres server packages,
389 use the make target 'postgres-server-<OSTYPE>'. Choose the most appropriate
390 command below based on your operating system.
393 ------------------------------------------------------------------------------
394 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-jessie
395 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-wheezy
396 make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-precise
397 make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-trusty
398 make -f Open-ILS/src/extras/Makefile.install postgres-server-fedora
399 ------------------------------------------------------------------------------
401 .(Fedora) Postgres initialization
403 Installing Postgres on Fedora also requires you to initialize the PostgreSQL
404 cluster and start the service. Issue the following commands as the *root* user:
407 ------------------------------------------------------------------------------
408 postgresql-setup initdb
409 systemctl start postgresql
410 ------------------------------------------------------------------------------
412 For a standalone PostgreSQL server, install the following Perl modules for your
413 distribution as the *root* Linux account:
417 ---------------------------------------------------------------------------------
419 ---------------------------------------------------------------------------------
421 .(Debian "wheezy" and Ubuntu Trusty)
422 No extra modules required for these distributions.
426 ------------------------------------------------------------------------------
428 ------------------------------------------------------------------------------
430 You need to create a PostgreSQL superuser to create and access the database.
431 Issue the following command as the *postgres* Linux account to create a new
432 PostgreSQL superuser named `evergreen`. When prompted, enter the new user's
436 ------------------------------------------------------------------------------
437 createuser -s -P evergreen
438 ------------------------------------------------------------------------------
440 .Enabling connections to the PostgreSQL database
442 Your PostgreSQL database may be configured by default to prevent connections,
443 for example, it might reject attempts to connect via TCP/IP or from other
444 servers. To enable TCP/IP connections from localhost, check your `pg_hba.conf`
445 file, found in the `/etc/postgresql/` directory on Debian and Ubuntu, and in
446 the `/var/lib/pgsql/data/` directory on Fedora. A simple way to enable TCP/IP
447 connections from localhost to all databases with password authentication, which
448 would be suitable for a test install of Evergreen on a single server, is to
449 ensure the file contains the following entries _before_ any "host ... ident"
452 ------------------------------------------------------------------------------
453 host all all ::1/128 md5
454 host all all 127.0.0.1/32 md5
455 ------------------------------------------------------------------------------
457 When you change the `pg_hba.conf` file, you will need to reload PostgreSQL to
458 make the changes take effect. For more information on configuring connectivity
460 http://www.postgresql.org/docs/devel/static/auth-pg-hba-conf.html
462 Creating the Evergreen database and schema
463 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
465 Once you have created the *evergreen* PostgreSQL account, you also need to
466 create the database and schema, and configure your configuration files to point
467 at the database server. Issue the following command as the *root* Linux account
468 from inside the Evergreen source directory, replacing <user>, <password>,
469 <hostname>, <port>, and <dbname> with the appropriate values for your
470 PostgreSQL database (where <user> and <password> are for the *evergreen*
471 PostgreSQL account you just created), and replace <admin-user> and <admin-pass>
472 with the values you want for the *egadmin* Evergreen administrator account:
475 ------------------------------------------------------------------------------
476 perl Open-ILS/src/support-scripts/eg_db_config --update-config \
477 --service all --create-database --create-schema --create-offline \
478 --user <user> --password <password> --hostname <hostname> --port <port> \
479 --database <dbname> --admin-user <admin-user> --admin-pass <admin-pass>
480 ------------------------------------------------------------------------------
482 This creates the database and schema and configures all of the services in
483 your `/openils/conf/opensrf.xml` configuration file to point to that database.
484 It also creates the configuration files required by the Evergreen `cgi-bin`
485 administration scripts, and sets the user name and password for the *egadmin*
486 Evergreen administrator account to your requested values.
488 You can get a complete set of options for `eg_db_config` by passing the
493 If you add the `--load-all-sample` parameter to the `eg_db_config` command,
494 a set of authority and bibliographic records, call numbers, copies, staff
495 and regular users, and transactions will be loaded into your target
496 database. This sample dataset is commonly referred to as the _concerto_
497 sample data, and can be useful for testing out Evergreen functionality and
498 for creating problem reports that developers can easily recreate with their
499 own copy of the _concerto_ sample data.
501 Creating the database on a remote server
502 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
503 In a production instance of Evergreen, your PostgreSQL server should be
504 installed on a dedicated server.
506 PostgreSQL 9.1 and later
507 ^^^^^^^^^^^^^^^^^^^^^^^^
508 To create the database instance on a remote database server running PostgreSQL
509 9.1 or later, simply use the `--create-database` flag on `eg_db_config`.
513 1. As the *root* Linux account, start the `memcached` and `ejabberd` services
514 (if they aren't already running):
517 ------------------------------------------------------------------------------
518 /etc/init.d/ejabberd start
519 /etc/init.d/memcached start
520 ------------------------------------------------------------------------------
522 2. As the *opensrf* Linux account, start Evergreen. The `-l` flag in the
523 following command is only necessary if you want to force Evergreen to treat the
524 hostname as `localhost`; if you configured `opensrf.xml` using the real
525 hostname of your machine as returned by `perl -ENet::Domain 'print
526 Net::Domain::hostfqdn() . "\n";'`, you should not use the `-l` flag.
529 ------------------------------------------------------------------------------
530 osrf_control -l --start-all
531 ------------------------------------------------------------------------------
533 ** If you receive the error message `bash: osrf_control: command not found`,
534 then your environment variable `PATH` does not include the `/openils/bin`
535 directory; this should have been set in the *opensrf* Linux account's
536 `.bashrc` configuration file. To manually set the `PATH` variable, edit the
537 configuration file `~/.bashrc` as the *opensrf* Linux account and add the
541 ------------------------------------------------------------------------------
542 export PATH=$PATH:/openils/bin
543 ------------------------------------------------------------------------------
545 3. As the *opensrf* Linux account, generate the Web files needed by the staff
546 client and catalogue and update the organization unit proximity (you need to do
547 this the first time you start Evergreen, and after that each time you change the library org unit configuration.
551 ------------------------------------------------------------------------------
553 ------------------------------------------------------------------------------
555 4. As the *root* Linux account, restart the Apache Web server:
558 ------------------------------------------------------------------------------
559 /etc/init.d/apache2 restart
560 ------------------------------------------------------------------------------
562 If the Apache Web server was running when you started the OpenSRF services, you
563 might not be able to successfully log in to the OPAC or staff client until the
564 Apache Web server is restarted.
566 Testing connections to Evergreen
567 --------------------------------
569 Once you have installed and started Evergreen, test your connection to
570 Evergreen via `srfsh`. As the *opensrf* Linux account, issue the following
571 commands to start `srfsh` and try to log onto the Evergreen server using the
572 *egadmin* Evergreen administrator user name and password that you set using the
573 `eg_db_config` command:
576 ------------------------------------------------------------------------------
578 srfsh% login <admin-user> <admin-pass>
579 ------------------------------------------------------------------------------
581 You should see a result like:
583 Received Data: "250bf1518c7527a03249858687714376"
584 ------------------------------------
585 Request Completed Successfully
586 Request Time in seconds: 0.045286
587 ------------------------------------
591 "textcode":"SUCCESS",
594 "stacktrace":"oils_auth.c:304",
596 "authtoken":"e5f9827cc0f93b503a1cc66bee6bdd1a",
602 ------------------------------------
603 Request Completed Successfully
604 Request Time in seconds: 1.336568
605 ------------------------------------
606 [[install-troubleshooting-1]]
607 If this does not work, it's time to do some troubleshooting.
609 * As the *opensrf* Linux account, run the `settings-tester.pl` script to see
610 if it finds any system configuration problems. The script is found at
611 `Open-ILS/src/support-scripts/settings-tester.pl` in the Evergreen source
613 * Follow the steps in the http://evergreen-ils.org/dokuwiki/doku.php?id=troubleshooting:checking_for_errors[troubleshooting guide].
614 * If you have faithfully followed the entire set of installation steps
615 listed here, you are probably extremely close to a working system.
616 Gather your configuration files and log files and contact the
617 http://evergreen-ils.org/communicate/mailing-lists/[Evergreen development
618 mailing list] for assistance before making any drastic changes to your system
624 Need help installing or using Evergreen? Join the mailing lists at
625 http://evergreen-ils.org/communicate/mailing-lists/ or contact us on the Freenode
626 IRC network on the #evergreen channel.
630 This work is licensed under the Creative Commons Attribution-ShareAlike 3.0
631 Unported License. To view a copy of this license, visit
632 http://creativecommons.org/licenses/by-sa/3.0/ or send a letter to Creative
633 Commons, 444 Castro Street, Suite 900, Mountain View, California, 94041, USA.