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 install some extra packages
44 and perform one step before they can proceed with the `./configure` step.
46 As the *root* Linux account, install the following packages:
52 As the *user* Linux account, issue the following command in the Evergreen
53 source directory to generate the configure script and Makefiles:
56 ------------------------------------------------------------------------------
58 ------------------------------------------------------------------------------
60 Installing prerequisites
61 ------------------------
63 * **PostgreSQL**: Version 9.3 is recommended. The minimum supported version
65 * **Linux**: Evergreen 2.8 has been tested on Debian Jessie (8.0),
66 Debian Wheezy (7.0), Debian Squeeze(6.0), Ubuntu Trusty Tahr (14.04),
67 Ubuntu Precise Pangolin (12.04), and Fedora.
68 If you are running an older version of these distributions, you may want
69 to upgrade before upgrading Evergreen. For instructions on upgrading these
70 distributions, visit the Debian, Ubuntu or Fedora websites.
71 * **OpenSRF**: The minimum supported version of OpenSRF is 2.4.0.
74 Evergreen has a number of prerequisite packages that must be installed
75 before you can successfully configure, compile, and install Evergreen.
77 1. Begin by installing the most recent version of OpenSRF (2.4.0 or later).
78 You can download OpenSRF releases from http://evergreen-ils.org/opensrf-downloads/
79 2. On many distributions, it is necessary to install PostgreSQL 9.1+ from external
82 * On Debian Squeeze, open `/etc/apt/sources.list` in a text editor as the
83 *root* Linux account and add the following line:
86 ------------------------------------------------------------------------------
87 deb http://backports.debian.org/debian-backports squeeze-backports main contrib
88 ------------------------------------------------------------------------------
90 * Ubuntu Precise and Trusty comes with PostgreSQL 9.1+, so no additional steps are required.
91 * Fedora 19 and 20 come with PostgreSQL 9.2+, so no additional steps are required.
93 3. On Debian and Ubuntu, run `aptitude update` as the *root* Linux account to
94 retrieve the new packages from the backports repository.
95 4. Issue the following commands as the *root* Linux account to install
96 prerequisites using the `Makefile.install` prerequisite installer,
97 substituting `debian-jessie`, `debian-wheezy`, `debian-squeeze`, `fedora`,
98 `ubuntu-trusty`, or `ubuntu-precise` for <osname> below:
101 ------------------------------------------------------------------------------
102 make -f Open-ILS/src/extras/Makefile.install <osname>
103 ------------------------------------------------------------------------------
105 5. Add the libdbi-libdbd libraries to the system dynamic library path by
106 issuing the following commands as the *root* Linux account:
109 You should skip this step if installing on Ubuntu Precise, Trusty or Debian Jessie. The ubuntu
110 and Debian Jessie targets use libdbd-pgsql from packages.
114 ------------------------------------------------------------------------------
115 echo "/usr/local/lib/dbd" > /etc/ld.so.conf.d/eg.conf
117 ------------------------------------------------------------------------------
121 ------------------------------------------------------------------------------
122 echo "/usr/lib64/dbd" > /etc/ld.so.conf.d/eg.conf
124 ------------------------------------------------------------------------------
126 Configuration and compilation instructions
127 ------------------------------------------
129 For the time being, we are still installing everything in the `/openils/`
130 directory. From the Evergreen source directory, issue the following commands as
131 the *user* Linux account to configure and build Evergreen:
134 ------------------------------------------------------------------------------
135 PATH=/openils/bin:$PATH ./configure --prefix=/openils --sysconfdir=/openils/conf
137 ------------------------------------------------------------------------------
139 These instructions assume that you have also installed OpenSRF under `/openils/`.
140 If not, please adjust PATH as needed so that the Evergreen `configure` script
141 can find `osrf_config`.
143 Installation instructions
144 -------------------------
146 1. Once you have configured and compiled Evergreen, issue the following
147 command as the *root* Linux account to install Evergreen, build the server
148 portion of the staff client, and copy example configuration files to
150 Change the value of the `STAFF_CLIENT_STAMP_ID` variable to match the version
151 of the staff client that you will use to connect to the Evergreen server.
154 ------------------------------------------------------------------------------
155 make STAFF_CLIENT_STAMP_ID=rel_name install
156 ------------------------------------------------------------------------------
158 2. The server portion of the staff client expects `http://hostname/xul/server`
159 to resolve. Issue the following commands as the *root* Linux account to
160 create a symbolic link pointing to the `server` subdirectory of the server
161 portion of the staff client that we just built using the staff client ID
165 ------------------------------------------------------------------------------
166 cd /openils/var/web/xul
167 ln -sf rel_name/server server
168 ------------------------------------------------------------------------------
170 Change ownership of the Evergreen files
171 ---------------------------------------
173 All files in the `/openils/` directory and subdirectories must be owned by the
174 `opensrf` user. Issue the following command as the *root* Linux account to
175 change the ownership on the files:
178 ------------------------------------------------------------------------------
179 chown -R opensrf:opensrf /openils
180 ------------------------------------------------------------------------------
182 Additional Instructions for Developers
183 --------------------------------------
186 Skip this section if you are using an official release tarball downloaded
187 from http://evergreen-ils.org/egdownloads
189 Developers working directly with the source code from the Git repository,
190 rather than an official release tarball, need to install the Dojo Toolkit
191 set of JavaScript libraries. The appropriate version of Dojo is included in
192 Evergreen release tarballs. Developers should install the Dojo 1.3.3 version
193 of Dojo by issuing the following commands as the *opensrf* Linux account:
196 ------------------------------------------------------------------------------
197 wget http://download.dojotoolkit.org/release-1.3.3/dojo-release-1.3.3.tar.gz
198 tar -C /openils/var/web/js -xzf dojo-release-1.3.3.tar.gz
199 cp -r /openils/var/web/js/dojo-release-1.3.3/* /openils/var/web/js/dojo/.
200 ------------------------------------------------------------------------------
203 Configure the Apache Web server
204 -------------------------------
206 1. Use the example configuration files in `Open-ILS/examples/apache/` (for
207 Apache versions below 2.4) or `Open-ILS/examples/apache_24/` (for Apache
208 versions 2.4 or greater) to configure your Web server for the Evergreen
209 catalog, staff client, Web services, and administration interfaces. Issue the
210 following commands as the *root* Linux account:
212 .Debian Wheezy and Ubuntu Precise
214 ------------------------------------------------------------------------------
215 cp Open-ILS/examples/apache/eg.conf /etc/apache2/sites-available/
216 cp Open-ILS/examples/apache/eg_vhost.conf /etc/apache2/
217 cp Open-ILS/examples/apache/eg_startup /etc/apache2/
219 mkdir /etc/apache2/ssl
221 ------------------------------------------------------------------------------
223 .Ubuntu Trusty and Debian Jessie
225 ------------------------------------------------------------------------------------
226 cp Open-ILS/examples/apache_24/eg_24.conf /etc/apache2/sites-available/eg.conf
227 cp Open-ILS/examples/apache_24/eg_vhost_24.conf /etc/apache2/eg_vhost.conf
228 cp Open-ILS/examples/apache/eg_startup /etc/apache2/
230 mkdir /etc/apache2/ssl
232 ------------------------------------------------------------------------------------
236 ------------------------------------------------------------------------------
237 cp Open-ILS/examples/apache_24/eg_24.conf /etc/httpd/conf.d/
238 cp Open-ILS/examples/apache_24/eg_vhost_24.conf /etc/httpd/eg_vhost.conf
239 cp Open-ILS/examples/apache/eg_startup /etc/httpd/
243 ------------------------------------------------------------------------------
245 2. The `openssl` command cuts a new SSL key for your Apache server. For a
246 production server, you should purchase a signed SSL certificate, but you can
247 just use a self-signed certificate and accept the warnings in the staff client
248 and browser during testing and development. Create an SSL key for the Apache
249 server by issuing the following command as the *root* Linux account:
252 ------------------------------------------------------------------------------
253 openssl req -new -x509 -days 365 -nodes -out server.crt -keyout server.key
254 ------------------------------------------------------------------------------
256 3. As the *root* Linux account, edit the `eg.conf` file that you copied into
258 a. To enable access to the offline upload / execute interface from any
259 workstation on any network, make the following change (and note that
260 you *must* secure this for a production instance):
261 * (Apache 2.2): Replace `Allow from 10.0.0.0/8` with `Allow from all`
262 * (Apache 2.4): Replace `Require host 10.0.0.0/8` with `Require all granted`
263 b. (Fedora): Change references from the non-existent `/etc/apache2/` directory
265 4. Change the user for the Apache server.
266 * (Debian and Ubuntu): As the *root* Linux account, edit
267 `/etc/apache2/envvars`. Change `export APACHE_RUN_USER=www-data` to
268 `export APACHE_RUN_USER=opensrf`.
269 * (Fedora): As the *root* Linux account , edit `/etc/httpd/conf/httpd.conf`.
270 Change `User apache` to `User opensrf`.
271 5. Configure Apache with performance settings appropriate for Evergreen:
272 * (Debian and Ubuntu): As the *root* Linux account, edit
273 `/etc/apache2/apache2.conf`:
274 * (Fedora): As the *root* Linux account, edit `/etc/httpd/conf/httpd.conf`:
275 a. Change `KeepAliveTimeout` to `1`. Higher values reduce the chance of
276 a request timing out unexpectedly, but increase the risk of using up
277 all available Apache child processes.
278 b. 'Optional': Change `MaxKeepAliveRequests` to `100`
279 c. (Debian Wheezy, Ubuntu Precise, and Fedora) Update the prefork configuration
280 section to suit your environment. The following settings apply to a busy
284 ------------------------------------------------------------------------------
285 <IfModule mpm_prefork_module>
290 MaxRequestsPerChild 10000
292 ------------------------------------------------------------------------------
293 d. (Ubuntu Trusty, Debian Jessie) As the *root* user, edit
294 /etc/apache2/mods-available/mpm_prefork.conf to match the above values.
295 Then, also as the *root* user, enable the mpm_prefork module by doing:
298 ------------------------------------------------------------------------------
301 ------------------------------------------------------------------------------
303 6. (Fedora): As the *root* Linux account, edit the `/etc/httpd/eg_vhost.conf`
304 file to change references from the non-existent `/etc/apache2/` directory
306 7. (Debian Wheezy and Ubuntu Precise): As the *root* Linux account, enable the Evergreen site:
309 ------------------------------------------------------------------------------
310 a2dissite default # OPTIONAL: disable the default site (the "It Works" page)
312 ------------------------------------------------------------------------------
314 (Ubuntu Trusty, Debian Jessie):
317 ------------------------------------------------------------------------------
318 a2dissite 000-default # OPTIONAL: disable the default site (the "It Works" page)
320 ------------------------------------------------------------------------------
322 8. (Ubuntu): As the *root* Linux account, enable Apache to write
323 to the lock directory; this is currently necessary because Apache
324 is running as the `opensrf` user:
327 ------------------------------------------------------------------------------
328 chown opensrf /var/lock/apache2
329 ------------------------------------------------------------------------------
331 Configure OpenSRF for the Evergreen application
332 -----------------------------------------------
333 There are a number of example OpenSRF configuration files in `/openils/conf/`
334 that you can use as a template for your Evergreen installation. Issue the
335 following commands as the *opensrf* Linux account:
338 ------------------------------------------------------------------------------
339 cp -b /openils/conf/opensrf_core.xml.example /openils/conf/opensrf_core.xml
340 cp -b /openils/conf/opensrf.xml.example /openils/conf/opensrf.xml
341 ------------------------------------------------------------------------------
343 When you installed OpenSRF, you created four Jabber users on two
344 separate domains and edited the `opensrf_core.xml` file accordingly. Please
345 refer back to the OpenSRF README and, as the *opensrf* Linux account, edit the
346 Evergreen version of the `opensrf_core.xml` file using the same Jabber users
347 and domains as you used while installing and testing OpenSRF.
350 The `-b` flag tells the `cp` command to create a backup version of the
351 destination file. The backup version of the destination file has a tilde (`~`)
352 appended to the file name, so if you have forgotten the Jabber users and
353 domains, you can retrieve the settings from the backup version of the files.
355 `eg_db_config`, described in the following section, sets the database
356 connection information in `opensrf.xml` for you.
358 Creating the Evergreen database
359 -------------------------------
361 Setting up the PostgreSQL server
362 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
364 For production use, most libraries install the PostgreSQL database server on a
365 dedicated machine. Therefore, by default, the `Makefile.install` prerequisite
366 installer does *not* install the PostgreSQL 9 database server that is required
367 by every Evergreen system. You can install the packages required by Debian or
368 Ubuntu on the machine of your choice using the following commands as the
369 *root* Linux account:
371 .(Debian / Ubuntu / Fedora) Installing PostgreSQL server packages
373 Each OS build target provides the postgres server installation packages
374 required for each operating system. To install Postgres server packages,
375 use the make target 'postgres-server-<OSTYPE>'. Choose the most appropriate
376 command below based on your operating system.
379 ------------------------------------------------------------------------------
380 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-jessie
381 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-wheezy
382 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-squeeze
383 make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-precise
384 make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-trusty
385 make -f Open-ILS/src/extras/Makefile.install postgres-server-fedora
386 ------------------------------------------------------------------------------
388 .(Fedora) Postgres initialization
390 Installing Postgres on Fedora also requires you to initialize the PostgreSQL
391 cluster and start the service. Issue the following commands as the *root* user:
394 ------------------------------------------------------------------------------
395 postgresql-setup initdb
396 systemctl start postgresql
397 ------------------------------------------------------------------------------
399 For a standalone PostgreSQL server, install the following Perl modules for your
400 distribution as the *root* Linux account:
404 ---------------------------------------------------------------------------------
406 ---------------------------------------------------------------------------------
408 .(Debian "wheezy" and Ubuntu Trusty)
409 No extra modules required for these distributions.
413 ------------------------------------------------------------------------------
415 ------------------------------------------------------------------------------
417 You need to create a PostgreSQL superuser to create and access the database.
418 Issue the following command as the *postgres* Linux account to create a new
419 PostgreSQL superuser named `evergreen`. When prompted, enter the new user's
423 ------------------------------------------------------------------------------
424 createuser -s -P evergreen
425 ------------------------------------------------------------------------------
427 .Enabling connections to the PostgreSQL database
429 Your PostgreSQL database may be configured by default to prevent connections,
430 for example, it might reject attempts to connect via TCP/IP or from other
431 servers. To enable TCP/IP connections from localhost, check your `pg_hba.conf`
432 file, found in the `/etc/postgresql/` directory on Debian and Ubuntu, and in
433 the `/var/lib/pgsql/data/` directory on Fedora. A simple way to enable TCP/IP
434 connections from localhost to all databases with password authentication, which
435 would be suitable for a test install of Evergreen on a single server, is to
436 ensure the file contains the following entries _before_ any "host ... ident"
439 ------------------------------------------------------------------------------
440 host all all ::1/128 md5
441 host all all 127.0.0.1/32 md5
442 ------------------------------------------------------------------------------
444 When you change the `pg_hba.conf` file, you will need to reload PostgreSQL to
445 make the changes take effect. For more information on configuring connectivity
447 http://www.postgresql.org/docs/devel/static/auth-pg-hba-conf.html
449 Creating the Evergreen database and schema
450 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
452 Once you have created the *evergreen* PostgreSQL account, you also need to
453 create the database and schema, and configure your configuration files to point
454 at the database server. Issue the following command as the *root* Linux account
455 from inside the Evergreen source directory, replacing <user>, <password>,
456 <hostname>, <port>, and <dbname> with the appropriate values for your
457 PostgreSQL database (where <user> and <password> are for the *evergreen*
458 PostgreSQL account you just created), and replace <admin-user> and <admin-pass>
459 with the values you want for the *egadmin* Evergreen administrator account:
462 ------------------------------------------------------------------------------
463 perl Open-ILS/src/support-scripts/eg_db_config --update-config \
464 --service all --create-database --create-schema --create-offline \
465 --user <user> --password <password> --hostname <hostname> --port <port> \
466 --database <dbname> --admin-user <admin-user> --admin-pass <admin-pass>
467 ------------------------------------------------------------------------------
469 This creates the database and schema and configures all of the services in
470 your `/openils/conf/opensrf.xml` configuration file to point to that database.
471 It also creates the configuration files required by the Evergreen `cgi-bin`
472 administration scripts, and sets the user name and password for the *egadmin*
473 Evergreen administrator account to your requested values.
475 You can get a complete set of options for `eg_db_config` by passing the
480 If you add the `--load-all-sample` parameter to the `eg_db_config` command,
481 a set of authority and bibliographic records, call numbers, copies, staff
482 and regular users, and transactions will be loaded into your target
483 database. This sample dataset is commonly referred to as the _concerto_
484 sample data, and can be useful for testing out Evergreen functionality and
485 for creating problem reports that developers can easily recreate with their
486 own copy of the _concerto_ sample data.
488 Creating the database on a remote server
489 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
490 In a production instance of Evergreen, your PostgreSQL server should be
491 installed on a dedicated server.
493 PostgreSQL 9.1 and later
494 ^^^^^^^^^^^^^^^^^^^^^^^^
495 To create the database instance on a remote database server running PostgreSQL
496 9.1 or later, simply use the `--create-database` flag on `eg_db_config`.
500 1. As the *root* Linux account, start the `memcached` and `ejabberd` services
501 (if they aren't already running):
504 ------------------------------------------------------------------------------
505 /etc/init.d/ejabberd start
506 /etc/init.d/memcached start
507 ------------------------------------------------------------------------------
509 2. As the *opensrf* Linux account, start Evergreen. The `-l` flag in the
510 following command is only necessary if you want to force Evergreen to treat the
511 hostname as `localhost`; if you configured `opensrf.xml` using the real
512 hostname of your machine as returned by `perl -ENet::Domain 'print
513 Net::Domain::hostfqdn() . "\n";'`, you should not use the `-l` flag.
516 ------------------------------------------------------------------------------
517 osrf_control -l --start-all
518 ------------------------------------------------------------------------------
520 ** If you receive the error message `bash: osrf_control: command not found`,
521 then your environment variable `PATH` does not include the `/openils/bin`
522 directory; this should have been set in the *opensrf* Linux account's
523 `.bashrc` configuration file. To manually set the `PATH` variable, edit the
524 configuration file `~/.bashrc` as the *opensrf* Linux account and add the
528 ------------------------------------------------------------------------------
529 export PATH=$PATH:/openils/bin
530 ------------------------------------------------------------------------------
532 3. As the *opensrf* Linux account, generate the Web files needed by the staff
533 client and catalogue and update the organization unit proximity (you need to do
534 this the first time you start Evergreen, and after that each time you change the library org unit configuration.
538 ------------------------------------------------------------------------------
540 ------------------------------------------------------------------------------
542 4. As the *root* Linux account, restart the Apache Web server:
545 ------------------------------------------------------------------------------
546 /etc/init.d/apache2 restart
547 ------------------------------------------------------------------------------
549 If the Apache Web server was running when you started the OpenSRF services, you
550 might not be able to successfully log in to the OPAC or staff client until the
551 Apache Web server is restarted.
553 Testing connections to Evergreen
554 --------------------------------
556 Once you have installed and started Evergreen, test your connection to
557 Evergreen via `srfsh`. As the *opensrf* Linux account, issue the following
558 commands to start `srfsh` and try to log onto the Evergreen server using the
559 *egadmin* Evergreen administrator user name and password that you set using the
560 `eg_db_config` command:
563 ------------------------------------------------------------------------------
565 srfsh% login <admin-user> <admin-pass>
566 ------------------------------------------------------------------------------
568 You should see a result like:
570 Received Data: "250bf1518c7527a03249858687714376"
571 ------------------------------------
572 Request Completed Successfully
573 Request Time in seconds: 0.045286
574 ------------------------------------
578 "textcode":"SUCCESS",
581 "stacktrace":"oils_auth.c:304",
583 "authtoken":"e5f9827cc0f93b503a1cc66bee6bdd1a",
589 ------------------------------------
590 Request Completed Successfully
591 Request Time in seconds: 1.336568
592 ------------------------------------
593 [[install-troubleshooting-1]]
594 If this does not work, it's time to do some troubleshooting.
596 * As the *opensrf* Linux account, run the `settings-tester.pl` script to see
597 if it finds any system configuration problems. The script is found at
598 `Open-ILS/src/support-scripts/settings-tester.pl` in the Evergreen source
600 * Follow the steps in the http://evergreen-ils.org/dokuwiki/doku.php?id=troubleshooting:checking_for_errors[troubleshooting guide].
601 * If you have faithfully followed the entire set of installation steps
602 listed here, you are probably extremely close to a working system.
603 Gather your configuration files and log files and contact the
604 http://evergreen-ils.org/communicate/mailing-lists/[Evergreen development
605 mailing list] for assistance before making any drastic changes to your system
611 Need help installing or using Evergreen? Join the mailing lists at
612 http://evergreen-ils.org/communicate/mailing-lists/ or contact us on the Freenode
613 IRC network on the #evergreen channel.
617 This work is licensed under the Creative Commons Attribution-ShareAlike 3.0
618 Unported License. To view a copy of this license, visit
619 http://creativecommons.org/licenses/by-sa/3.0/ or send a letter to Creative
620 Commons, 444 Castro Street, Suite 900, Mountain View, California, 94041, USA.