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 * Ubuntu Precise and Trusty comes with PostgreSQL 9+, so no additional steps are required.
80 * Fedora comes with PostgreSQL 9, so no additional steps are required.
82 3. On Debian and Ubuntu, run `aptitude update` as the *root* Linux account to
83 retrieve the new packages from the backports repository.
84 4. Issue the following commands as the *root* Linux account to install
85 prerequisites using the `Makefile.install` prerequisite installer,
86 substituting `debian-jessie`, `debian-wheezy`, `debian-squeeze`, `fedora`,
87 `ubuntu-trusty`, or `ubuntu-precise` for <osname> below:
90 ------------------------------------------------------------------------------
91 make -f Open-ILS/src/extras/Makefile.install <osname>
92 ------------------------------------------------------------------------------
94 5. Add the libdbi-libdbd libraries to the system dynamic library path by
95 issuing the following commands as the *root* Linux account:
98 You should skip this step if installing on Ubuntu Precise or Trusty. The ubuntu
99 targets use libdbd-pgsql from packages.
103 ------------------------------------------------------------------------------
104 echo "/usr/local/lib/dbd" > /etc/ld.so.conf.d/eg.conf
106 ------------------------------------------------------------------------------
110 ------------------------------------------------------------------------------
111 echo "/usr/lib64/dbd" > /etc/ld.so.conf.d/eg.conf
113 ------------------------------------------------------------------------------
115 Configuration and compilation instructions
116 ------------------------------------------
118 For the time being, we are still installing everything in the `/openils/`
119 directory. From the Evergreen source directory, issue the following commands as
120 the *user* Linux account to configure and build Evergreen:
123 ------------------------------------------------------------------------------
124 PATH=/openils/bin:$PATH ./configure --prefix=/openils --sysconfdir=/openils/conf
126 ------------------------------------------------------------------------------
128 These instructions assume that you have also installed OpenSRF under `/openils/`.
129 If not, please adjust PATH as needed so that the Evergreen `configure` script
130 can find `osrf_config`.
132 Installation instructions
133 -------------------------
135 1. Once you have configured and compiled Evergreen, issue the following
136 command as the *root* Linux account to install Evergreen, build the server
137 portion of the staff client, and copy example configuration files to
139 Change the value of the `STAFF_CLIENT_STAMP_ID` variable to match the version
140 of the staff client that you will use to connect to the Evergreen server.
143 ------------------------------------------------------------------------------
144 make STAFF_CLIENT_STAMP_ID=rel_name install
145 ------------------------------------------------------------------------------
147 2. The server portion of the staff client expects `http://hostname/xul/server`
148 to resolve. Issue the following commands as the *root* Linux account to
149 create a symbolic link pointing to the `server` subdirectory of the server
150 portion of the staff client that we just built using the staff client ID
154 ------------------------------------------------------------------------------
155 cd /openils/var/web/xul
156 ln -sf rel_name/server server
157 ------------------------------------------------------------------------------
159 Change ownership of the Evergreen files
160 ---------------------------------------
162 All files in the `/openils/` directory and subdirectories must be owned by the
163 `opensrf` user. Issue the following command as the *root* Linux account to
164 change the ownership on the files:
167 ------------------------------------------------------------------------------
168 chown -R opensrf:opensrf /openils
169 ------------------------------------------------------------------------------
171 Additional Instructions for Developers
172 --------------------------------------
175 Skip this section if you are using an official release tarball downloaded
176 from http://evergreen-ils.org/downloads
178 Developers working directly with the source code from the Git repository,
179 rather than an official release tarball, need to install the Dojo Toolkit
180 set of JavaScript libraries. The appropriate version of Dojo is included in
181 Evergreen release tarballs. Developers should install the Dojo 1.3.3 version
182 of Dojo by issuing the following commands as the *opensrf* Linux account:
185 ------------------------------------------------------------------------------
186 wget http://download.dojotoolkit.org/release-1.3.3/dojo-release-1.3.3.tar.gz
187 tar -C /openils/var/web/js -xzf dojo-release-1.3.3.tar.gz
188 cp -r /openils/var/web/js/dojo-release-1.3.3/* /openils/var/web/js/dojo/.
189 ------------------------------------------------------------------------------
192 Configure the Apache Web server
193 -------------------------------
195 1. Use the example configuration files in `Open-ILS/examples/apache/` (for
196 Apache versions below 2.4) or `Open-ILS/examples/apache_24/` (for Apache
197 versions 2.4 or greater) to configure your Web server for the Evergreen
198 catalog, staff client, Web services, and administration interfaces. Issue the
199 following commands as the *root* Linux account:
201 .Debian and Ubuntu Precise
203 ------------------------------------------------------------------------------
204 cp Open-ILS/examples/apache/eg.conf /etc/apache2/sites-available/
205 cp Open-ILS/examples/apache/eg_vhost.conf /etc/apache2/
206 cp Open-ILS/examples/apache/eg_startup /etc/apache2/
208 mkdir /etc/apache2/ssl
210 ------------------------------------------------------------------------------
214 ------------------------------------------------------------------------------------
215 cp Open-ILS/examples/apache_24/eg_24.conf /etc/apache2/sites-available/eg.conf
216 cp Open-ILS/examples/apache_24/eg_vhost_24.conf /etc/apache2/eg_vhost.conf
217 cp Open-ILS/examples/apache/eg_startup /etc/apache2/
219 mkdir /etc/apache2/ssl
221 ------------------------------------------------------------------------------------
225 ------------------------------------------------------------------------------
226 cp Open-ILS/examples/apache_24/eg_24.conf /etc/httpd/conf.d/
227 cp Open-ILS/examples/apache_24/eg_vhost_24.conf /etc/httpd/eg_vhost.conf
228 cp Open-ILS/examples/apache/eg_startup /etc/httpd/
232 ------------------------------------------------------------------------------
234 2. The `openssl` command cuts a new SSL key for your Apache server. For a
235 production server, you should purchase a signed SSL certificate, but you can
236 just use a self-signed certificate and accept the warnings in the staff client
237 and browser during testing and development. Create an SSL key for the Apache
238 server by issuing the following command as the *root* Linux account:
241 ------------------------------------------------------------------------------
242 openssl req -new -x509 -days 365 -nodes -out server.crt -keyout server.key
243 ------------------------------------------------------------------------------
245 3. As the *root* Linux account, edit the `eg.conf` file that you copied into
247 a. To enable access to the offline upload / execute interface from any
248 workstation on any network, make the following change (and note that
249 you *must* secure this for a production instance):
250 * (Apache 2.2): Replace `Allow from 10.0.0.0/8` with `Allow from all`
251 * (Apache 2.4): Replace `Require host 10.0.0.0/8` with `Require all granted`
252 b. (Fedora): Change references from the non-existent `/etc/apache2/` directory
254 4. Change the user for the Apache server.
255 * (Debian and Ubuntu): As the *root* Linux account, edit
256 `/etc/apache2/envvars`. Change `export APACHE_RUN_USER=www-data` to
257 `export APACHE_RUN_USER=opensrf`.
258 * (Fedora): As the *root* Linux account , edit `/etc/httpd/conf/httpd.conf`.
259 Change `User apache` to `User opensrf`.
260 5. Configure Apache with performance settings appropriate for Evergreen:
261 * (Debian and Ubuntu): As the *root* Linux account, edit
262 `/etc/apache2/apache2.conf`:
263 * (Fedora): As the *root* Linux account, edit `/etc/httpd/conf/httpd.conf`:
264 a. Change `KeepAliveTimeout` to `1`. Higher values reduce the chance of
265 a request timing out unexpectedly, but increase the risk of using up
266 all available Apache child processes.
267 b. 'Optional': Change `MaxKeepAliveRequests` to `100`
268 c. (Debian, Ubuntu Precise, and Fedora) Update the prefork configuration
269 section to suit your environment. The following settings apply to a busy
273 ------------------------------------------------------------------------------
274 <IfModule mpm_prefork_module>
279 MaxRequestsPerChild 10000
281 ------------------------------------------------------------------------------
282 d. (Ubuntu Trusty) As the *root* user, edit
283 /etc/apache2/mods-available/mpm_prefork.conf to match the above values.
284 Then, also as the *root* user, enable the mpm_prefork module by doing:
287 ------------------------------------------------------------------------------
290 ------------------------------------------------------------------------------
292 6. (Fedora): As the *root* Linux account, edit the `/etc/httpd/eg_vhost.conf`
293 file to change references from the non-existent `/etc/apache2/` directory
295 7. (Debian and Ubuntu Precise): As the *root* Linux account, enable the Evergreen site:
298 ------------------------------------------------------------------------------
299 a2dissite default # OPTIONAL: disable the default site (the "It Works" page)
301 ------------------------------------------------------------------------------
306 ------------------------------------------------------------------------------
307 a2dissite 000-default # OPTIONAL: disable the default site (the "It Works" page)
309 ------------------------------------------------------------------------------
311 8. (Ubuntu): As the *root* Linux account, enable Apache to write
312 to the lock directory; this is currently necessary because Apache
313 is running as the `opensrf` user:
316 ------------------------------------------------------------------------------
317 chown opensrf /var/lock/apache2
318 ------------------------------------------------------------------------------
320 Configure OpenSRF for the Evergreen application
321 -----------------------------------------------
322 There are a number of example OpenSRF configuration files in `/openils/conf/`
323 that you can use as a template for your Evergreen installation. Issue the
324 following commands as the *opensrf* Linux account:
327 ------------------------------------------------------------------------------
328 cp -b /openils/conf/opensrf_core.xml.example /openils/conf/opensrf_core.xml
329 cp -b /openils/conf/opensrf.xml.example /openils/conf/opensrf.xml
330 ------------------------------------------------------------------------------
332 When you installed OpenSRF, you created four Jabber users on two
333 separate domains and edited the `opensrf_core.xml` file accordingly. Please
334 refer back to the OpenSRF README and, as the *opensrf* Linux account, edit the
335 Evergreen version of the `opensrf_core.xml` file using the same Jabber users
336 and domains as you used while installing and testing OpenSRF.
339 The `-b` flag tells the `cp` command to create a backup version of the
340 destination file. The backup version of the destination file has a tilde (`~`)
341 appended to the file name, so if you have forgotten the Jabber users and
342 domains, you can retrieve the settings from the backup version of the files.
344 `eg_db_config`, described in the following section, sets the database
345 connection information in `opensrf.xml` for you.
347 Creating the Evergreen database
348 -------------------------------
350 Setting up the PostgreSQL server
351 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
353 For production use, most libraries install the PostgreSQL database server on a
354 dedicated machine. Therefore, by default, the `Makefile.install` prerequisite
355 installer does *not* install the PostgreSQL 9 database server that is required
356 by every Evergreen system. You can install the packages required by Debian or
357 Ubuntu on the machine of your choice using the following commands as the
358 *root* Linux account:
360 .(Debian / Ubuntu / Fedora) Installing PostgreSQL server packages
362 Each OS build target provides the postgres server installation packages
363 required for each operating system. To install Postgres server packages,
364 use the make target 'postgres-server-<OSTYPE>'. Choose the most appropriate
365 command below based on your operating system.
368 ------------------------------------------------------------------------------
369 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-wheezy
370 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-squeeze
371 make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-precise
372 make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-trusty
373 make -f Open-ILS/src/extras/Makefile.install postgres-server-fedora
374 ------------------------------------------------------------------------------
376 .(Fedora) Postgres initialization
378 Installing Postgres on Fedora also requires you to initialize the PostgreSQL
379 cluster and start the service. Issue the following commands as the *root* user:
382 ------------------------------------------------------------------------------
383 postgresql-setup initdb
384 systemctl start postgresql
385 ------------------------------------------------------------------------------
387 For a standalone PostgreSQL server, install the following Perl modules for your
388 distribution as the *root* Linux account:
392 ---------------------------------------------------------------------------------
394 ---------------------------------------------------------------------------------
396 .(Debian "wheezy" and Ubuntu Trusty)
397 No extra modules required for these distributions.
401 ------------------------------------------------------------------------------
403 ------------------------------------------------------------------------------
405 You need to create a PostgreSQL superuser to create and access the database.
406 Issue the following command as the *postgres* Linux account to create a new
407 PostgreSQL superuser named `evergreen`. When prompted, enter the new user's
411 ------------------------------------------------------------------------------
412 createuser -s -P evergreen
413 ------------------------------------------------------------------------------
415 .Enabling connections to the PostgreSQL database
417 Your PostgreSQL database may be configured by default to prevent connections,
418 for example, it might reject attempts to connect via TCP/IP or from other
419 servers. To enable TCP/IP connections from localhost, check your `pg_hba.conf`
420 file, found in the `/etc/postgresql/` directory on Debian and Ubuntu, and in
421 the `/var/lib/pgsql/data/` directory on Fedora. A simple way to enable TCP/IP
422 connections from localhost to all databases with password authentication, which
423 would be suitable for a test install of Evergreen on a single server, is to
424 ensure the file contains the following entries _before_ any "host ... ident"
427 ------------------------------------------------------------------------------
428 host all all ::1/128 md5
429 host all all 127.0.0.1/32 md5
430 ------------------------------------------------------------------------------
432 When you change the `pg_hba.conf` file, you will need to reload PostgreSQL to
433 make the changes take effect. For more information on configuring connectivity
435 http://www.postgresql.org/docs/devel/static/auth-pg-hba-conf.html
437 Creating the Evergreen database and schema
438 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
440 Once you have created the *evergreen* PostgreSQL account, you also need to
441 create the database and schema, and configure your configuration files to point
442 at the database server. Issue the following command as the *root* Linux account
443 from inside the Evergreen source directory, replacing <user>, <password>,
444 <hostname>, <port>, and <dbname> with the appropriate values for your
445 PostgreSQL database (where <user> and <password> are for the *evergreen*
446 PostgreSQL account you just created), and replace <admin-user> and <admin-pass>
447 with the values you want for the *egadmin* Evergreen administrator account:
450 ------------------------------------------------------------------------------
451 perl Open-ILS/src/support-scripts/eg_db_config --update-config \
452 --service all --create-database --create-schema --create-offline \
453 --user <user> --password <password> --hostname <hostname> --port <port> \
454 --database <dbname> --admin-user <admin-user> --admin-pass <admin-pass>
455 ------------------------------------------------------------------------------
457 This creates the database and schema and configures all of the services in
458 your `/openils/conf/opensrf.xml` configuration file to point to that database.
459 It also creates the configuration files required by the Evergreen `cgi-bin`
460 administration scripts, and sets the user name and password for the *egadmin*
461 Evergreen administrator account to your requested values.
463 You can get a complete set of options for `eg_db_config` by passing the
468 If you add the `--load-all-sample` parameter to the `eg_db_config` command,
469 a set of authority and bibliographic records, call numbers, copies, staff
470 and regular users, and transactions will be loaded into your target
471 database. This sample dataset is commonly referred to as the _concerto_
472 sample data, and can be useful for testing out Evergreen functionality and
473 for creating problem reports that developers can easily recreate with their
474 own copy of the _concerto_ sample data.
476 Creating the database on a remote server
477 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
478 In a production instance of Evergreen, your PostgreSQL server should be
479 installed on a dedicated server.
481 PostgreSQL 9.1 and later
482 ^^^^^^^^^^^^^^^^^^^^^^^^
483 To create the database instance on a remote database server running PostgreSQL
484 9.1 or later, simply use the `--create-database` flag on `eg_db_config`.
488 1. As the *root* Linux account, start the `memcached` and `ejabberd` services
489 (if they aren't already running):
492 ------------------------------------------------------------------------------
493 /etc/init.d/ejabberd start
494 /etc/init.d/memcached start
495 ------------------------------------------------------------------------------
497 2. As the *opensrf* Linux account, start Evergreen. The `-l` flag in the
498 following command is only necessary if you want to force Evergreen to treat the
499 hostname as `localhost`; if you configured `opensrf.xml` using the real
500 hostname of your machine as returned by `perl -ENet::Domain 'print
501 Net::Domain::hostfqdn() . "\n";'`, you should not use the `-l` flag.
504 ------------------------------------------------------------------------------
505 osrf_control -l --start-all
506 ------------------------------------------------------------------------------
508 ** If you receive the error message `bash: osrf_control: command not found`,
509 then your environment variable `PATH` does not include the `/openils/bin`
510 directory; this should have been set in the *opensrf* Linux account's
511 `.bashrc` configuration file. To manually set the `PATH` variable, edit the
512 configuration file `~/.bashrc` as the *opensrf* Linux account and add the
516 ------------------------------------------------------------------------------
517 export PATH=$PATH:/openils/bin
518 ------------------------------------------------------------------------------
520 3. As the *opensrf* Linux account, generate the Web files needed by the staff
521 client and catalogue and update the organization unit proximity (you need to do
522 this the first time you start Evergreen, and after that each time you change the library org unit configuration.
526 ------------------------------------------------------------------------------
528 ------------------------------------------------------------------------------
530 4. As the *root* Linux account, restart the Apache Web server:
533 ------------------------------------------------------------------------------
534 /etc/init.d/apache2 restart
535 ------------------------------------------------------------------------------
537 If the Apache Web server was running when you started the OpenSRF services, you
538 might not be able to successfully log in to the OPAC or staff client until the
539 Apache Web server is restarted.
541 Testing connections to Evergreen
542 --------------------------------
544 Once you have installed and started Evergreen, test your connection to
545 Evergreen via `srfsh`. As the *opensrf* Linux account, issue the following
546 commands to start `srfsh` and try to log onto the Evergreen server using the
547 *egadmin* Evergreen administrator user name and password that you set using the
548 `eg_db_config` command:
551 ------------------------------------------------------------------------------
553 srfsh% login <admin-user> <admin-pass>
554 ------------------------------------------------------------------------------
556 You should see a result like:
558 Received Data: "250bf1518c7527a03249858687714376"
559 ------------------------------------
560 Request Completed Successfully
561 Request Time in seconds: 0.045286
562 ------------------------------------
566 "textcode":"SUCCESS",
569 "stacktrace":"oils_auth.c:304",
571 "authtoken":"e5f9827cc0f93b503a1cc66bee6bdd1a",
577 ------------------------------------
578 Request Completed Successfully
579 Request Time in seconds: 1.336568
580 ------------------------------------
582 If this does not work, it's time to do some troubleshooting.
584 * As the *opensrf* Linux account, run the `settings-tester.pl` script to see
585 if it finds any system configuration problems. The script is found at
586 `Open-ILS/src/support-scripts/settings-tester.pl` in the Evergreen source
588 * Follow the steps in the http://evergreen-ils.org/dokuwiki/doku.php?id=troubleshooting:checking_for_errors[troubleshooting guide].
589 * If you have faithfully followed the entire set of installation steps
590 listed here, you are probably extremely close to a working system.
591 Gather your configuration files and log files and contact the
592 http://evergreen-ils.org/communicate/mailing-lists/[Evergreen development
593 mailing list] for assistance before making any drastic changes to your system
599 Need help installing or using Evergreen? Join the mailing lists at
600 http://evergreen-ils.org/communicate/mailing-lists/ or contact us on the Freenode
601 IRC network on the #evergreen channel.
605 This work is licensed under the Creative Commons Attribution-ShareAlike 3.0
606 Unported License. To view a copy of this license, visit
607 http://creativecommons.org/licenses/by-sa/3.0/ or send a letter to Creative
608 Commons, 444 Castro Street, Suite 900, Mountain View, California, 94041, USA.