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/downloads
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 Evergreen has a number of prerequisite packages that must be installed
58 before you can successfully configure, compile, and install Evergreen.
60 1. Begin by installing the most recent version of OpenSRF (2.3.0 or later).
61 You can download OpenSRF releases from http://evergreen-ils.org/opensrf-downloads/
62 2. On many distributions, it is necessary to install PostgreSQL 9 from external
65 * On Debian Squeeze, open `/etc/apt/sources.list` in a text editor as the
66 *root* Linux account and add the following line:
69 ------------------------------------------------------------------------------
70 deb http://backports.debian.org/debian-backports squeeze-backports main contrib
71 ------------------------------------------------------------------------------
73 * Ubuntu Precise and Trusty comes with PostgreSQL 9+, so no additional steps are required.
74 * Fedora comes with PostgreSQL 9, so no additional steps are required.
76 3. On Debian and Ubuntu, run `aptitude update` as the *root* Linux account to
77 retrieve the new packages from the backports repository.
78 4. Issue the following commands as the *root* Linux account to install
79 prerequisites using the `Makefile.install` prerequisite installer,
80 substituting `debian-jessie`, `debian-wheezy`, `debian-squeeze`, `fedora`,
81 `ubuntu-trusty`, or `ubuntu-precise` for <osname> below:
84 ------------------------------------------------------------------------------
85 make -f Open-ILS/src/extras/Makefile.install <osname>
86 ------------------------------------------------------------------------------
88 5. Add the libdbi-libdbd libraries to the system dynamic library path by
89 issuing the following commands as the *root* Linux account:
92 You should skip this step if installing on Ubuntu Precise or Trusty. The ubuntu
93 targets use libdbd-pgsql from packages.
97 ------------------------------------------------------------------------------
98 echo "/usr/local/lib/dbd" > /etc/ld.so.conf.d/eg.conf
100 ------------------------------------------------------------------------------
104 ------------------------------------------------------------------------------
105 echo "/usr/lib64/dbd" > /etc/ld.so.conf.d/eg.conf
107 ------------------------------------------------------------------------------
109 6. OPTIONAL: Developer additions
111 To perform certain developer tasks from a Git source code checkout,
112 additional packages may be required. As the *root* Linux account:
114 * To install packages needed for retriving and managing web dependencies,
115 use the <osname>-developer Makefile.install target. Currently,
116 this is only needed for building and installing the (preview) browser
120 ------------------------------------------------------------------------------
121 make -f Open-ILS/src/extras/Makefile.install <osname>-developer
122 ------------------------------------------------------------------------------
124 * To install packages required for building Evergreen release bundles, use
125 the <osname>-packager Makefile.install target.
128 ------------------------------------------------------------------------------
129 make -f Open-ILS/src/extras/Makefile.install <osname>-packager
130 ------------------------------------------------------------------------------
132 Configuration and compilation instructions
133 ------------------------------------------
135 For the time being, we are still installing everything in the `/openils/`
136 directory. From the Evergreen source directory, issue the following commands as
137 the *user* Linux account to configure and build Evergreen:
140 ------------------------------------------------------------------------------
141 PATH=/openils/bin:$PATH ./configure --prefix=/openils --sysconfdir=/openils/conf
143 ------------------------------------------------------------------------------
145 These instructions assume that you have also installed OpenSRF under `/openils/`.
146 If not, please adjust PATH as needed so that the Evergreen `configure` script
147 can find `osrf_config`.
149 Installation instructions
150 -------------------------
152 1. Once you have configured and compiled Evergreen, issue the following
153 command as the *root* Linux account to install Evergreen, build the server
154 portion of the staff client, and copy example configuration files to
156 Change the value of the `STAFF_CLIENT_STAMP_ID` variable to match the version
157 of the staff client that you will use to connect to the Evergreen server.
160 ------------------------------------------------------------------------------
161 make STAFF_CLIENT_STAMP_ID=rel_name install
162 ------------------------------------------------------------------------------
164 2. The server portion of the staff client expects `http://hostname/xul/server`
165 to resolve. Issue the following commands as the *root* Linux account to
166 create a symbolic link pointing to the `server` subdirectory of the server
167 portion of the staff client that we just built using the staff client ID
171 ------------------------------------------------------------------------------
172 cd /openils/var/web/xul
173 ln -sf rel_name/server server
174 ------------------------------------------------------------------------------
176 Change ownership of the Evergreen files
177 ---------------------------------------
179 All files in the `/openils/` directory and subdirectories must be owned by the
180 `opensrf` user. Issue the following command as the *root* Linux account to
181 change the ownership on the files:
184 ------------------------------------------------------------------------------
185 chown -R opensrf:opensrf /openils
186 ------------------------------------------------------------------------------
188 Additional Instructions for Developers
189 --------------------------------------
192 Skip this section if you are using an official release tarball downloaded
193 from http://evergreen-ils.org/downloads
195 Developers working directly with the source code from the Git repository,
196 rather than an official release tarball, need to install the Dojo Toolkit
197 set of JavaScript libraries. The appropriate version of Dojo is included in
198 Evergreen release tarballs. Developers should install the Dojo 1.3.3 version
199 of Dojo by issuing the following commands as the *opensrf* Linux account:
202 ------------------------------------------------------------------------------
203 wget http://download.dojotoolkit.org/release-1.3.3/dojo-release-1.3.3.tar.gz
204 tar -C /openils/var/web/js -xzf dojo-release-1.3.3.tar.gz
205 cp -r /openils/var/web/js/dojo-release-1.3.3/* /openils/var/web/js/dojo/.
206 ------------------------------------------------------------------------------
209 Configure the Apache Web server
210 -------------------------------
212 1. Use the example configuration files in `Open-ILS/examples/apache/` (for
213 Apache versions below 2.4) or `Open-ILS/examples/apache_24/` (for Apache
214 versions 2.4 or greater) to configure your Web server for the Evergreen
215 catalog, staff client, Web services, and administration interfaces. Issue the
216 following commands as the *root* Linux account:
218 .Debian and Ubuntu Precise
220 ------------------------------------------------------------------------------
221 cp Open-ILS/examples/apache/eg.conf /etc/apache2/sites-available/
222 cp Open-ILS/examples/apache/eg_vhost.conf /etc/apache2/
223 cp Open-ILS/examples/apache/eg_startup /etc/apache2/
225 mkdir /etc/apache2/ssl
227 ------------------------------------------------------------------------------
231 ------------------------------------------------------------------------------------
232 cp Open-ILS/examples/apache_24/eg_24.conf /etc/apache2/sites-available/eg.conf
233 cp Open-ILS/examples/apache_24/eg_vhost_24.conf /etc/apache2/eg_vhost.conf
234 cp Open-ILS/examples/apache/eg_startup /etc/apache2/
236 mkdir /etc/apache2/ssl
238 ------------------------------------------------------------------------------------
242 ------------------------------------------------------------------------------
243 cp Open-ILS/examples/apache_24/eg_24.conf /etc/httpd/conf.d/
244 cp Open-ILS/examples/apache_24/eg_vhost_24.conf /etc/httpd/eg_vhost.conf
245 cp Open-ILS/examples/apache/eg_startup /etc/httpd/
249 ------------------------------------------------------------------------------
251 2. The `openssl` command cuts a new SSL key for your Apache server. For a
252 production server, you should purchase a signed SSL certificate, but you can
253 just use a self-signed certificate and accept the warnings in the staff client
254 and browser during testing and development. Create an SSL key for the Apache
255 server by issuing the following command as the *root* Linux account:
258 ------------------------------------------------------------------------------
259 openssl req -new -x509 -days 365 -nodes -out server.crt -keyout server.key
260 ------------------------------------------------------------------------------
262 3. As the *root* Linux account, edit the `eg.conf` file that you copied into
264 a. To enable access to the offline upload / execute interface from any
265 workstation on any network, make the following change (and note that
266 you *must* secure this for a production instance):
267 * (Apache 2.2): Replace `Allow from 10.0.0.0/8` with `Allow from all`
268 * (Apache 2.4): Replace `Require host 10.0.0.0/8` with `Require all granted`
269 b. (Fedora): Change references from the non-existent `/etc/apache2/` directory
271 4. Change the user for the Apache server.
272 * (Debian and Ubuntu): As the *root* Linux account, edit
273 `/etc/apache2/envvars`. Change `export APACHE_RUN_USER=www-data` to
274 `export APACHE_RUN_USER=opensrf`.
275 * (Fedora): As the *root* Linux account , edit `/etc/httpd/conf/httpd.conf`.
276 Change `User apache` to `User opensrf`.
277 5. Configure Apache with performance settings appropriate for Evergreen:
278 * (Debian and Ubuntu): As the *root* Linux account, edit
279 `/etc/apache2/apache2.conf`:
280 * (Fedora): As the *root* Linux account, edit `/etc/httpd/conf/httpd.conf`:
281 a. Change `KeepAliveTimeout` to `1`. Higher values reduce the chance of
282 a request timing out unexpectedly, but increase the risk of using up
283 all available Apache child processes.
284 b. 'Optional': Change `MaxKeepAliveRequests` to `100`
285 c. (Debian, Ubuntu Precise, and Fedora) Update the prefork configuration
286 section to suit your environment. The following settings apply to a busy
290 ------------------------------------------------------------------------------
291 <IfModule mpm_prefork_module>
296 MaxRequestsPerChild 10000
298 ------------------------------------------------------------------------------
299 d. (Ubuntu Trusty) As the *root* user, edit
300 /etc/apache2/mods-available/mpm_prefork.conf to match the above values.
301 Then, also as the *root* user, enable the mpm_prefork module by doing:
304 ------------------------------------------------------------------------------
307 ------------------------------------------------------------------------------
309 6. (Fedora): As the *root* Linux account, edit the `/etc/httpd/eg_vhost.conf`
310 file to change references from the non-existent `/etc/apache2/` directory
312 7. (Debian and Ubuntu Precise): As the *root* Linux account, enable the Evergreen site:
315 ------------------------------------------------------------------------------
316 a2dissite default # OPTIONAL: disable the default site (the "It Works" page)
318 ------------------------------------------------------------------------------
323 ------------------------------------------------------------------------------
324 a2dissite 000-default # OPTIONAL: disable the default site (the "It Works" page)
326 ------------------------------------------------------------------------------
328 8. (Ubuntu): As the *root* Linux account, enable Apache to write
329 to the lock directory; this is currently necessary because Apache
330 is running as the `opensrf` user:
333 ------------------------------------------------------------------------------
334 chown opensrf /var/lock/apache2
335 ------------------------------------------------------------------------------
337 Configure OpenSRF for the Evergreen application
338 -----------------------------------------------
339 There are a number of example OpenSRF configuration files in `/openils/conf/`
340 that you can use as a template for your Evergreen installation. Issue the
341 following commands as the *opensrf* Linux account:
344 ------------------------------------------------------------------------------
345 cp -b /openils/conf/opensrf_core.xml.example /openils/conf/opensrf_core.xml
346 cp -b /openils/conf/opensrf.xml.example /openils/conf/opensrf.xml
347 ------------------------------------------------------------------------------
349 When you installed OpenSRF, you created four Jabber users on two
350 separate domains and edited the `opensrf_core.xml` file accordingly. Please
351 refer back to the OpenSRF README and, as the *opensrf* Linux account, edit the
352 Evergreen version of the `opensrf_core.xml` file using the same Jabber users
353 and domains as you used while installing and testing OpenSRF.
356 The `-b` flag tells the `cp` command to create a backup version of the
357 destination file. The backup version of the destination file has a tilde (`~`)
358 appended to the file name, so if you have forgotten the Jabber users and
359 domains, you can retrieve the settings from the backup version of the files.
361 `eg_db_config`, described in the following section, sets the database
362 connection information in `opensrf.xml` for you.
364 Creating the Evergreen database
365 -------------------------------
367 Setting up the PostgreSQL server
368 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
370 For production use, most libraries install the PostgreSQL database server on a
371 dedicated machine. Therefore, by default, the `Makefile.install` prerequisite
372 installer does *not* install the PostgreSQL 9 database server that is required
373 by every Evergreen system. You can install the packages required by Debian or
374 Ubuntu on the machine of your choice using the following commands as the
375 *root* Linux account:
377 .(Debian / Ubuntu / Fedora) Installing PostgreSQL server packages
379 Each OS build target provides the postgres server installation packages
380 required for each operating system. To install Postgres server packages,
381 use the make target 'postgres-server-<OSTYPE>'. Choose the most appropriate
382 command below based on your operating system.
385 ------------------------------------------------------------------------------
386 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-wheezy
387 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-squeeze
388 make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-precise
389 make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-trusty
390 make -f Open-ILS/src/extras/Makefile.install postgres-server-fedora
391 ------------------------------------------------------------------------------
393 .(Fedora) Postgres initialization
395 Installing Postgres on Fedora also requires you to initialize the PostgreSQL
396 cluster and start the service. Issue the following commands as the *root* user:
399 ------------------------------------------------------------------------------
400 postgresql-setup initdb
401 systemctl start postgresql
402 ------------------------------------------------------------------------------
404 For a standalone PostgreSQL server, install the following Perl modules for your
405 distribution as the *root* Linux account:
409 ---------------------------------------------------------------------------------
411 ---------------------------------------------------------------------------------
413 .(Debian "wheezy" and Ubuntu Trusty)
414 No extra modules required for these distributions.
418 ------------------------------------------------------------------------------
420 ------------------------------------------------------------------------------
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, and in
438 the `/var/lib/pgsql/data/` directory on Fedora. 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
455 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
457 Once you have created the *evergreen* PostgreSQL account, you also need to
458 create the database and schema, and configure your configuration files to point
459 at the database server. Issue the following command as the *root* Linux account
460 from inside the Evergreen source directory, replacing <user>, <password>,
461 <hostname>, <port>, and <dbname> with the appropriate values for your
462 PostgreSQL database (where <user> and <password> are for the *evergreen*
463 PostgreSQL account you just created), and replace <admin-user> and <admin-pass>
464 with the values you want for the *egadmin* Evergreen administrator account:
467 ------------------------------------------------------------------------------
468 perl Open-ILS/src/support-scripts/eg_db_config --update-config \
469 --service all --create-database --create-schema --create-offline \
470 --user <user> --password <password> --hostname <hostname> --port <port> \
471 --database <dbname> --admin-user <admin-user> --admin-pass <admin-pass>
472 ------------------------------------------------------------------------------
474 This creates the database and schema and configures all of the services in
475 your `/openils/conf/opensrf.xml` configuration file to point to that database.
476 It also creates the configuration files required by the Evergreen `cgi-bin`
477 administration scripts, and sets the user name and password for the *egadmin*
478 Evergreen administrator account to your requested values.
480 You can get a complete set of options for `eg_db_config` by passing the
485 If you add the `--load-all-sample` parameter to the `eg_db_config` command,
486 a set of authority and bibliographic records, call numbers, copies, staff
487 and regular users, and transactions will be loaded into your target
488 database. This sample dataset is commonly referred to as the _concerto_
489 sample data, and can be useful for testing out Evergreen functionality and
490 for creating problem reports that developers can easily recreate with their
491 own copy of the _concerto_ sample data.
493 Creating the database on a remote server
494 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
495 In a production instance of Evergreen, your PostgreSQL server should be
496 installed on a dedicated server.
498 PostgreSQL 9.1 and later
499 ^^^^^^^^^^^^^^^^^^^^^^^^
500 To create the database instance on a remote database server running PostgreSQL
501 9.1 or later, simply use the `--create-database` flag on `eg_db_config`.
505 1. As the *root* Linux account, start the `memcached` and `ejabberd` services
506 (if they aren't already running):
509 ------------------------------------------------------------------------------
510 /etc/init.d/ejabberd start
511 /etc/init.d/memcached start
512 ------------------------------------------------------------------------------
514 2. As the *opensrf* Linux account, start Evergreen. The `-l` flag in the
515 following command is only necessary if you want to force Evergreen to treat the
516 hostname as `localhost`; if you configured `opensrf.xml` using the real
517 hostname of your machine as returned by `perl -ENet::Domain 'print
518 Net::Domain::hostfqdn() . "\n";'`, you should not use the `-l` flag.
521 ------------------------------------------------------------------------------
522 osrf_control -l --start-all
523 ------------------------------------------------------------------------------
525 ** If you receive the error message `bash: osrf_control: command not found`,
526 then your environment variable `PATH` does not include the `/openils/bin`
527 directory; this should have been set in the *opensrf* Linux account's
528 `.bashrc` configuration file. To manually set the `PATH` variable, edit the
529 configuration file `~/.bashrc` as the *opensrf* Linux account and add the
533 ------------------------------------------------------------------------------
534 export PATH=$PATH:/openils/bin
535 ------------------------------------------------------------------------------
537 3. As the *opensrf* Linux account, generate the Web files needed by the staff
538 client and catalogue and update the organization unit proximity (you need to do
539 this the first time you start Evergreen, and after that each time you change the library org unit configuration.
543 ------------------------------------------------------------------------------
545 ------------------------------------------------------------------------------
547 4. As the *root* Linux account, restart the Apache Web server:
550 ------------------------------------------------------------------------------
551 /etc/init.d/apache2 restart
552 ------------------------------------------------------------------------------
554 If the Apache Web server was running when you started the OpenSRF services, you
555 might not be able to successfully log in to the OPAC or staff client until the
556 Apache Web server is restarted.
558 Testing connections to Evergreen
559 --------------------------------
561 Once you have installed and started Evergreen, test your connection to
562 Evergreen via `srfsh`. As the *opensrf* Linux account, issue the following
563 commands to start `srfsh` and try to log onto the Evergreen server using the
564 *egadmin* Evergreen administrator user name and password that you set using the
565 `eg_db_config` command:
568 ------------------------------------------------------------------------------
570 srfsh% login <admin-user> <admin-pass>
571 ------------------------------------------------------------------------------
573 You should see a result like:
575 Received Data: "250bf1518c7527a03249858687714376"
576 ------------------------------------
577 Request Completed Successfully
578 Request Time in seconds: 0.045286
579 ------------------------------------
583 "textcode":"SUCCESS",
586 "stacktrace":"oils_auth.c:304",
588 "authtoken":"e5f9827cc0f93b503a1cc66bee6bdd1a",
594 ------------------------------------
595 Request Completed Successfully
596 Request Time in seconds: 1.336568
597 ------------------------------------
599 If this does not work, it's time to do some troubleshooting.
601 * As the *opensrf* Linux account, run the `settings-tester.pl` script to see
602 if it finds any system configuration problems. The script is found at
603 `Open-ILS/src/support-scripts/settings-tester.pl` in the Evergreen source
605 * Follow the steps in the http://evergreen-ils.org/dokuwiki/doku.php?id=troubleshooting:checking_for_errors[troubleshooting guide].
606 * If you have faithfully followed the entire set of installation steps
607 listed here, you are probably extremely close to a working system.
608 Gather your configuration files and log files and contact the
609 http://evergreen-ils.org/communicate/mailing-lists/[Evergreen development
610 mailing list] for assistance before making any drastic changes to your system
616 Need help installing or using Evergreen? Join the mailing lists at
617 http://evergreen-ils.org/communicate/mailing-lists/ or contact us on the Freenode
618 IRC network on the #evergreen channel.
622 This work is licensed under the Creative Commons Attribution-ShareAlike 3.0
623 Unported License. To view a copy of this license, visit
624 http://creativecommons.org/licenses/by-sa/3.0/ or send a letter to Creative
625 Commons, 444 Castro Street, Suite 900, Mountain View, California, 94041, USA.