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 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 Evergreen has a number of prerequisite packages that must be installed
64 before you can successfully configure, compile, and install Evergreen.
66 1. Begin by installing the most recent version of OpenSRF (2.3.0 or later).
67 You can download OpenSRF releases from http://evergreen-ils.org/opensrf-downloads/
68 2. On many distributions, it is necessary to install PostgreSQL 9 from external
71 * On Debian Squeeze, open `/etc/apt/sources.list` in a text editor as the
72 *root* Linux account and add the following line:
75 ------------------------------------------------------------------------------
76 deb http://backports.debian.org/debian-backports squeeze-backports main contrib
77 ------------------------------------------------------------------------------
79 * On Ubuntu Lucid, you can use a PPA (personal package archive), which are
80 package sources hosted on Launchpad. The one most commonly used by Evergreen
81 Community members is maintained by Martin Pitt, who also maintains the
82 official PostgreSQL packages for Ubuntu. As the *root* Linux account, issue
83 the following commands to add the PPA source:
86 ------------------------------------------------------------------------------
87 apt-get install python-software-properties
88 add-apt-repository ppa:pitti/postgresql
89 ------------------------------------------------------------------------------
91 * Ubuntu Precise comes with PostgreSQL 9, so no additional steps are required.
93 * Fedora comes with PostgreSQL 9, so no additional steps are required.
95 3. On Debian and Ubuntu, run `aptitude update` as the *root* Linux account to
96 retrieve the new packages from the backports repository.
97 4. Issue the following commands as the *root* Linux account to install
98 prerequisites using the `Makefile.install` prerequisite installer,
99 substituting `debian-squeeze`, `debian-wheezy`, `fedora`, `ubuntu-lucid`, or
100 `ubuntu-precise` for <osname> below:
103 ------------------------------------------------------------------------------
104 make -f Open-ILS/src/extras/Makefile.install <osname>
105 ------------------------------------------------------------------------------
107 5. Add the libdbi-libdbd libraries to the system dynamic library path by
108 issuing the following commands as the *root* Linux account:
111 You should skip this step if installing on Ubuntu Precise or Trusty. The ubuntu
112 targets use libdbd-pgsql from packages.
116 ------------------------------------------------------------------------------
117 echo "/usr/local/lib/dbd" > /etc/ld.so.conf.d/eg.conf
119 ------------------------------------------------------------------------------
123 ------------------------------------------------------------------------------
124 echo "/usr/lib64/dbd" > /etc/ld.so.conf.d/eg.conf
126 ------------------------------------------------------------------------------
128 Configuration and compilation instructions
129 ------------------------------------------
131 For the time being, we are still installing everything in the `/openils/`
132 directory. From the Evergreen source directory, issue the following commands as
133 the *user* Linux account to configure and build Evergreen:
136 ------------------------------------------------------------------------------
137 PATH=/openils/bin:$PATH ./configure --prefix=/openils --sysconfdir=/openils/conf
139 ------------------------------------------------------------------------------
141 These instructions assume that you have also installed OpenSRF under `/openils/`.
142 If not, please adjust PATH as needed so that the Evergreen `configure` script
143 can find `osrf_config`.
145 Installation instructions
146 -------------------------
148 1. Once you have configured and compiled Evergreen, issue the following
149 command as the *root* Linux account to install Evergreen, build the server
150 portion of the staff client, and copy example configuration files to
152 Change the value of the `STAFF_CLIENT_STAMP_ID` variable to match the version
153 of the staff client that you will use to connect to the Evergreen server.
156 ------------------------------------------------------------------------------
157 make STAFF_CLIENT_STAMP_ID=rel_name install
158 ------------------------------------------------------------------------------
160 2. The server portion of the staff client expects `http://hostname/xul/server`
161 to resolve. Issue the following commands as the *root* Linux account to
162 create a symbolic link pointing to the `server` subdirectory of the server
163 portion of the staff client that we just built using the staff client ID
167 ------------------------------------------------------------------------------
168 cd /openils/var/web/xul
169 ln -sf rel_name/server server
170 ------------------------------------------------------------------------------
172 Change ownership of the Evergreen files
173 ---------------------------------------
175 All files in the `/openils/` directory and subdirectories must be owned by the
176 `opensrf` user. Issue the following command as the *root* Linux account to
177 change the ownership on the files:
180 ------------------------------------------------------------------------------
181 chown -R opensrf:opensrf /openils
182 ------------------------------------------------------------------------------
184 Additional Instructions for Developers
185 --------------------------------------
188 Skip this section if you are using an official release tarball downloaded
189 from http://evergreen-ils.org/downloads
191 Developers working directly with the source code from the Git repository,
192 rather than an official release tarball, need to install the Dojo Toolkit
193 set of JavaScript libraries. The appropriate version of Dojo is included in
194 Evergreen release tarballs. Developers should install the Dojo 1.3.3 version
195 of Dojo by issuing the following commands as the *opensrf* Linux account:
198 ------------------------------------------------------------------------------
199 wget http://download.dojotoolkit.org/release-1.3.3/dojo-release-1.3.3.tar.gz
200 tar -C /openils/var/web/js -xzf dojo-release-1.3.3.tar.gz
201 cp -r /openils/var/web/js/dojo-release-1.3.3/* /openils/var/web/js/dojo/.
202 ------------------------------------------------------------------------------
205 Configure the Apache Web server
206 -------------------------------
208 1. Use the example configuration files in `Open-ILS/examples/apache/` (for
209 Apache versions below 2.4) or `Open-ILS/examples/apache_24/` (for Apache
210 versions 2.4 or greater) to configure your Web server for the Evergreen
211 catalog, staff client, Web services, and administration interfaces. Issue the
212 following commands as the *root* Linux account:
214 .Debian and Ubuntu Precise
216 ------------------------------------------------------------------------------
217 cp Open-ILS/examples/apache/eg.conf /etc/apache2/sites-available/
218 cp Open-ILS/examples/apache/eg_vhost.conf /etc/apache2/
219 cp Open-ILS/examples/apache/eg_startup /etc/apache2/
221 mkdir /etc/apache2/ssl
223 ------------------------------------------------------------------------------
227 ------------------------------------------------------------------------------------
228 cp Open-ILS/examples/apache_24/eg_24.conf /etc/apache2/sites-available/eg.conf
229 cp Open-ILS/examples/apache_24/eg_vhost_24.conf /etc/apache2/eg_vhost.conf
230 cp Open-ILS/examples/apache/eg_startup /etc/apache2/
232 mkdir /etc/apache2/ssl
234 ------------------------------------------------------------------------------------
238 ------------------------------------------------------------------------------
239 cp Open-ILS/examples/apache_24/eg_24.conf /etc/httpd/conf.d/
240 cp Open-ILS/examples/apache_24/eg_vhost_24.conf /etc/httpd/eg_vhost.conf
241 cp Open-ILS/examples/apache/eg_startup /etc/httpd/
245 ------------------------------------------------------------------------------
247 2. The `openssl` command cuts a new SSL key for your Apache server. For a
248 production server, you should purchase a signed SSL certificate, but you can
249 just use a self-signed certificate and accept the warnings in the staff client
250 and browser during testing and development. Create an SSL key for the Apache
251 server by issuing the following command as the *root* Linux account:
254 ------------------------------------------------------------------------------
255 openssl req -new -x509 -days 365 -nodes -out server.crt -keyout server.key
256 ------------------------------------------------------------------------------
258 3. As the *root* Linux account, edit the `eg.conf` file that you copied into
260 a. To enable access to the offline upload / execute interface from any
261 workstation on any network, make the following change (and note that
262 you *must* secure this for a production instance):
263 * (Apache 2.2): Replace `Allow from 10.0.0.0/8` with `Allow from all`
264 * (Apache 2.4): Replace `Require host 10.0.0.0/8` with `Require all granted`
265 b. (Fedora): Change references from the non-existent `/etc/apache2/` directory
267 4. Change the user for the Apache server.
268 * (Debian and Ubuntu): As the *root* Linux account, edit
269 `/etc/apache2/envvars`. Change `export APACHE_RUN_USER=www-data` to
270 `export APACHE_RUN_USER=opensrf`.
271 * (Fedora): As the *root* Linux account , edit `/etc/httpd/conf/httpd.conf`.
272 Change `User apache` to `User opensrf`.
273 5. Configure Apache with performance settings appropriate for Evergreen:
274 * (Debian and Ubuntu): As the *root* Linux account, edit
275 `/etc/apache2/apache2.conf`:
276 * (Fedora): As the *root* Linux account, edit `/etc/httpd/conf/httpd.conf`:
277 a. Change `KeepAliveTimeout` to `1`. Higher values reduce the chance of
278 a request timing out unexpectedly, but increase the risk of using up
279 all available Apache child processes.
280 b. 'Optional': Change `MaxKeepAliveRequests` to `100`
281 c. (Debian, Ubuntu Precise, and Fedora) Update the prefork configuration
282 section to suit your environment. The following settings apply to a busy
286 ------------------------------------------------------------------------------
287 <IfModule mpm_prefork_module>
292 MaxRequestsPerChild 10000
294 ------------------------------------------------------------------------------
295 d. (Ubuntu Trusty) As the *root* user, edit
296 /etc/apache2/mods-available/mpm_prefork.conf to match the above values.
297 Then, also as the *root* user, enable the mpm_prefork module by doing:
300 ------------------------------------------------------------------------------
303 ------------------------------------------------------------------------------
305 6. (Fedora): As the *root* Linux account, edit the `/etc/httpd/eg_vhost.conf`
306 file to change references from the non-existent `/etc/apache2/` directory
308 7. (Debian and Ubuntu): As the *root* Linux account, enable the Evergreen site:
311 ------------------------------------------------------------------------------
312 a2dissite default # OPTIONAL: disable the default site (the "It Works" page)
314 ------------------------------------------------------------------------------
315 8. (Ubuntu): As the *root* Linux account, enable Apache to write
316 to the lock directory; this is currently necessary because Apache
317 is running as the `opensrf` user:
320 ------------------------------------------------------------------------------
321 chown opensrf /var/lock/apache2
322 ------------------------------------------------------------------------------
324 Configure OpenSRF for the Evergreen application
325 -----------------------------------------------
326 There are a number of example OpenSRF configuration files in `/openils/conf/`
327 that you can use as a template for your Evergreen installation. Issue the
328 following commands as the *opensrf* Linux account:
331 ------------------------------------------------------------------------------
332 cp -b /openils/conf/opensrf_core.xml.example /openils/conf/opensrf_core.xml
333 cp -b /openils/conf/opensrf.xml.example /openils/conf/opensrf.xml
334 ------------------------------------------------------------------------------
336 When you installed OpenSRF, you created four Jabber users on two
337 separate domains and edited the `opensrf_core.xml` file accordingly. Please
338 refer back to the OpenSRF README and, as the *opensrf* Linux account, edit the
339 Evergreen version of the `opensrf_core.xml` file using the same Jabber users
340 and domains as you used while installing and testing OpenSRF.
343 The `-b` flag tells the `cp` command to create a backup version of the
344 destination file. The backup version of the destination file has a tilde (`~`)
345 appended to the file name, so if you have forgotten the Jabber users and
346 domains, you can retrieve the settings from the backup version of the files.
348 `eg_db_config`, described in the following section, sets the database
349 connection information in `opensrf.xml` for you.
351 Creating the Evergreen database
352 -------------------------------
354 Setting up the PostgreSQL server
355 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
357 For production use, most libraries install the PostgreSQL database server on a
358 dedicated machine. Therefore, by default, the `Makefile.install` prerequisite
359 installer does *not* install the PostgreSQL 9 database server that is required
360 by every Evergreen system. You can install the packages required by Debian or
361 Ubuntu Lucid on the machine of your choice using the following commands as the
362 *root* Linux account:
364 .(Debian / Ubuntu / Fedora) Installing PostgreSQL server packages
366 Each OS build target provides the postgres server installation packages
367 required for each operating system. To install Postgres server packages,
368 use the make target 'postgres-server-<OSTYPE>'. Choose the most appropriate
369 command below based on your operating system.
372 ------------------------------------------------------------------------------
373 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-wheezy
374 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-squeeze
375 make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-precise
376 make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-trusty
377 make -f Open-ILS/src/extras/Makefile.install postgres-server-fedora
378 ------------------------------------------------------------------------------
380 .(Fedora) Postgres initialization
382 Installing Postgres on Fedora also requires you to initialize the PostgreSQL
383 cluster and start the service. Issue the following commands as the *root* user:
386 ------------------------------------------------------------------------------
387 postgresql-setup initdb
388 systemctl start postgresql
389 ------------------------------------------------------------------------------
391 For a standalone PostgreSQL server, install the following Perl modules for your
392 distribution as the *root* Linux account:
396 ---------------------------------------------------------------------------------
397 apt-get install gcc libxml-libxml-perl libxml-libxslt-perl libbusiness-isbn-perl
398 apt-get install libjson-xs-perl liblibrary-callnumber-lc-perl libmarc-record-perl
399 apt-get install libmarc-xml-perl libuuid-tiny-perl
401 ---------------------------------------------------------------------------------
403 .(Debian "wheezy" and Ubuntu Trusty)
404 standalone PostgreSQL 9 server
406 ---------------------------------------------------------------------------------
407 apt-get install gcc libxml-libxml-perl libxml-libxslt-perl libbusiness-isbn-perl
408 apt-get install libjson-xs-perl liblibrary-callnumber-lc-perl libmarc-record-perl
409 apt-get install libmarc-xml-perl libuuid-tiny-perl librose-uri-perl
410 ---------------------------------------------------------------------------------
414 ------------------------------------------------------------------------------
415 yum install gcc perl-XML-LibXML perl-XML-LibXSLT perl-Business-ISBN
416 yum install perl-Library-CallNumber-LC perl-MARC-Record perl-MARC-Charset
417 yum install perl-MARC-File-XML perl-UUID-Tiny
418 ------------------------------------------------------------------------------
420 You need to create a PostgreSQL superuser to create and access the database.
421 Issue the following command as the *postgres* Linux account to create a new
422 PostgreSQL superuser named `evergreen`. When prompted, enter the new user's
426 ------------------------------------------------------------------------------
427 createuser -s -P evergreen
428 ------------------------------------------------------------------------------
430 .Enabling connections to the PostgreSQL database
432 Your PostgreSQL database may be configured by default to prevent connections,
433 for example, it might reject attempts to connect via TCP/IP or from other
434 servers. To enable TCP/IP connections from localhost, check your `pg_hba.conf`
435 file, found in the `/etc/postgresql/` directory on Debian and Ubuntu, and in
436 the `/var/lib/pgsql/data/` directory on Fedora. A simple way to enable TCP/IP
437 connections from localhost to all databases with password authentication, which
438 would be suitable for a test install of Evergreen on a single server, is to
439 ensure the file contains the following entries _before_ any "host ... ident"
442 ------------------------------------------------------------------------------
443 host all all ::1/128 md5
444 host all all 127.0.0.1/32 md5
445 ------------------------------------------------------------------------------
447 When you change the `pg_hba.conf` file, you will need to reload PostgreSQL to
448 make the changes take effect. For more information on configuring connectivity
450 http://www.postgresql.org/docs/devel/static/auth-pg-hba-conf.html
452 Creating the Evergreen database and schema
453 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
455 Once you have created the *evergreen* PostgreSQL account, you also need to
456 create the database and schema, and configure your configuration files to point
457 at the database server. Issue the following command as the *root* Linux account
458 from inside the Evergreen source directory, replacing <user>, <password>,
459 <hostname>, <port>, and <dbname> with the appropriate values for your
460 PostgreSQL database (where <user> and <password> are for the *evergreen*
461 PostgreSQL account you just created), and replace <admin-user> and <admin-pass>
462 with the values you want for the *egadmin* Evergreen administrator account:
465 ------------------------------------------------------------------------------
466 perl Open-ILS/src/support-scripts/eg_db_config --update-config \
467 --service all --create-database --create-schema --create-offline \
468 --user <user> --password <password> --hostname <hostname> --port <port> \
469 --database <dbname> --admin-user <admin-user> --admin-pass <admin-pass>
470 ------------------------------------------------------------------------------
472 This creates the database and schema and configures all of the services in
473 your `/openils/conf/opensrf.xml` configuration file to point to that database.
474 It also creates the configuration files required by the Evergreen `cgi-bin`
475 administration scripts, and sets the user name and password for the *egadmin*
476 Evergreen administrator account to your requested values.
478 You can get a complete set of options for `eg_db_config.pl` by passing the
483 If you add the `--load-all-sample` parameter to the `eg_db_config` command,
484 a set of authority and bibliographic records, call numbers, copies, staff
485 and regular users, and transactions will be loaded into your target
486 database. This sample dataset is commonly referred to as the _concerto_
487 sample data, and can be useful for testing out Evergreen functionality and
488 for creating problem reports that developers can easily recreate with their
489 own copy of the _concerto_ sample data.
491 Creating the database on a remote server
492 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
493 In a production instance of Evergreen, your PostgreSQL server should be
494 installed on a dedicated server.
496 PostgreSQL 9.1 and later
497 ^^^^^^^^^^^^^^^^^^^^^^^^
498 To create the database instance on a remote database server running PostgreSQL
499 9.1 or later, simply use the `--create-database` flag on `eg_db_config`.
503 1. As the *root* Linux account, start the `memcached` and `ejabberd` services
504 (if they aren't already running):
507 ------------------------------------------------------------------------------
508 /etc/init.d/ejabberd start
509 /etc/init.d/memcached start
510 ------------------------------------------------------------------------------
512 2. As the *opensrf* Linux account, start Evergreen. The `-l` flag in the
513 following command is only necessary if you want to force Evergreen to treat the
514 hostname as `localhost`; if you configured `opensrf.xml` using the real
515 hostname of your machine as returned by `perl -ENet::Domain 'print
516 Net::Domain::hostfqdn() . "\n";'`, you should not use the `-l` flag.
519 ------------------------------------------------------------------------------
520 osrf_control -l --start-all
521 ------------------------------------------------------------------------------
523 ** If you receive the error message `bash: osrf_control: command not found`,
524 then your environment variable `PATH` does not include the `/openils/bin`
525 directory; this should have been set in the *opensrf* Linux account's
526 `.bashrc` configuration file. To manually set the `PATH` variable, edit the
527 configuration file `~/.bashrc` as the *opensrf* Linux account and add the
531 ------------------------------------------------------------------------------
532 export PATH=$PATH:/openils/bin
533 ------------------------------------------------------------------------------
535 3. As the *opensrf* Linux account, generate the Web files needed by the staff
536 client and catalogue and update the organization unit proximity (you need to do
537 this the first time you start Evergreen, and after that each time you change
538 the library hierarchy in `config.cgi`):
541 ------------------------------------------------------------------------------
543 ------------------------------------------------------------------------------
545 4. As the *root* Linux account, restart the Apache Web server:
548 ------------------------------------------------------------------------------
549 /etc/init.d/apache2 restart
550 ------------------------------------------------------------------------------
552 If the Apache Web server was running when you started the OpenSRF services, you
553 might not be able to successfully log in to the OPAC or staff client until the
554 Apache Web server is restarted.
556 Testing connections to Evergreen
557 --------------------------------
559 Once you have installed and started Evergreen, test your connection to
560 Evergreen via `srfsh`. As the *opensrf* Linux account, issue the following
561 commands to start `srfsh` and try to log onto the Evergreen server using the
562 *egadmin* Evergreen administrator user name and password that you set using the
563 `eg_db_config` command:
566 ------------------------------------------------------------------------------
568 srfsh% login <admin-user> <admin-pass>
569 ------------------------------------------------------------------------------
571 You should see a result like:
573 Received Data: "250bf1518c7527a03249858687714376"
574 ------------------------------------
575 Request Completed Successfully
576 Request Time in seconds: 0.045286
577 ------------------------------------
581 "textcode":"SUCCESS",
584 "stacktrace":"oils_auth.c:304",
586 "authtoken":"e5f9827cc0f93b503a1cc66bee6bdd1a",
592 ------------------------------------
593 Request Completed Successfully
594 Request Time in seconds: 1.336568
595 ------------------------------------
597 If this does not work, it's time to do some troubleshooting.
599 * As the *opensrf* Linux account, run the `settings-tester.pl` script to see
600 if it finds any system configuration problems. The script is found at
601 `Open-ILS/src/support-scripts/settings-tester.pl` in the Evergreen source
603 * Follow the steps in the http://evergreen-ils.org/dokuwiki/doku.php?id=troubleshooting:checking_for_errors[troubleshooting guide].
604 * If you have faithfully followed the entire set of installation steps
605 listed here, you are probably extremely close to a working system.
606 Gather your configuration files and log files and contact the
607 http://evergreen-ils.org/communicate/mailing-lists/[Evergreen development
608 mailing list] for assistance before making any drastic changes to your system
614 Need help installing or using Evergreen? Join the mailing lists at
615 http://evergreen-ils.org/communicate/mailing-lists/ or contact us on the Freenode
616 IRC network on the #evergreen channel.
620 This work is licensed under the Creative Commons Attribution-ShareAlike 3.0
621 Unported License. To view a copy of this license, visit
622 http://creativecommons.org/licenses/by-sa/3.0/ or send a letter to Creative
623 Commons, 444 Castro Street, Suite 900, Mountain View, California, 94041, USA.