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 After running `make install`, developers also need to install the Dojo Toolkit
61 set of JavaScript libraries. The appropriate version of Dojo is included
62 in Evergreen release tarballs. Developers should install the Dojo 1.3.3
63 version of Dojo by issuing the following commands as the *opensrf* Linux
67 ------------------------------------------------------------------------------
68 wget http://download.dojotoolkit.org/release-1.3.3/dojo-release-1.3.3.tar.gz
69 tar -C /openils/var/web/js -xzf dojo-release-1.3.3.tar.gz
70 cp -r /openils/var/web/js/dojo-release-1.3.3/* /openils/var/web/js/dojo/.
71 ------------------------------------------------------------------------------
73 Installing prerequisites
74 ------------------------
76 Evergreen has a number of prerequisite packages that must be installed
77 before you can successfully configure, compile, and install Evergreen.
79 1. Begin by installing the most recent version of OpenSRF (2.2.1 or later).
80 You can download OpenSRF releases from http://evergreen-ils.org/opensrf-downloads/
81 2. On many distributions, it is necessary to install PostgreSQL 9 from external
84 * On Debian Squeeze, open `/etc/apt/sources.list` in a text editor as the
85 *root* Linux account and add the following line:
88 ------------------------------------------------------------------------------
89 deb http://backports.debian.org/debian-backports squeeze-backports main contrib
90 ------------------------------------------------------------------------------
92 * On Ubuntu Lucid, you can use a PPA (personal package archive), which are
93 package sources hosted on Launchpad. The one most commonly used by Evergreen
94 Community members is maintained by Martin Pitt, who also maintains the
95 official PostgreSQL packages for Ubuntu. As the *root* Linux account, issue
96 the following commands to add the PPA source:
99 ------------------------------------------------------------------------------
100 apt-get install python-software-properties
101 add-apt-repository ppa:pitti/postgresql
102 ------------------------------------------------------------------------------
104 * Ubuntu Precise comes with PostgreSQL 9, so no additional steps are required.
106 * Fedora comes with PostgreSQL 9, so no additional steps are required.
108 3. On Debian and Ubuntu, run `aptitude update` as the *root* Linux account to
109 retrieve the new packages from the backports repository.
110 4. Issue the following commands as the *root* Linux account to install
111 prerequisites using the `Makefile.install` prerequisite installer,
112 substituting `debian-squeeze`, `fedora`, `ubuntu-lucid`, or
113 `ubuntu-precise` for <osname> below:
116 ------------------------------------------------------------------------------
117 make -f Open-ILS/src/extras/Makefile.install <osname>
118 ------------------------------------------------------------------------------
120 5. Add the libdbi-libdbd libraries to the system dynamic library path by
121 issuing the following commands as the *root* Linux account:
124 You should skip this step if installing on Ubuntu Precise. The ubuntu-precise
125 target uses libdbd-pgsql from packages.
127 .Debian / Ubuntu Lucid
129 ------------------------------------------------------------------------------
130 echo "/usr/local/lib/dbd" > /etc/ld.so.conf.d/eg.conf
132 ------------------------------------------------------------------------------
136 ------------------------------------------------------------------------------
137 echo "/usr/lib64/dbd" > /etc/ld.so.conf.d/eg.conf
139 ------------------------------------------------------------------------------
141 Configuration and compilation instructions
142 ------------------------------------------
144 For the time being, we are still installing everything in the `/openils/`
145 directory. From the Evergreen source directory, issue the following commands as
146 the *user* Linux account to configure and build Evergreen:
149 ------------------------------------------------------------------------------
150 PATH=/openils/bin:$PATH ./configure --prefix=/openils --sysconfdir=/openils/conf
152 ------------------------------------------------------------------------------
154 These instructions assume that you have also installed OpenSRF under `/openils/`.
155 If not, please adjust PATH as needed so that the Evergreen `configure` script
156 can find `osrf_config`.
158 Installation instructions
159 -------------------------
161 1. Once you have configured and compiled Evergreen, issue the following
162 command as the *root* Linux account to install Evergreen, build the server
163 portion of the staff client, and copy example configuration files to
165 Change the value of the `STAFF_CLIENT_STAMP_ID` variable to match the version
166 of the staff client that you will use to connect to the Evergreen server.
169 ------------------------------------------------------------------------------
170 make STAFF_CLIENT_STAMP_ID=rel_name install
171 ------------------------------------------------------------------------------
173 2. The server portion of the staff client expects `http://hostname/xul/server`
174 to resolve. Issue the following commands as the *root* Linux account to
175 create a symbolic link pointing to the `server` subdirectory of the server
176 portion of the staff client that we just built using the staff client ID
180 ------------------------------------------------------------------------------
181 cd /openils/var/web/xul
182 ln -sf rel_name/server server
183 ------------------------------------------------------------------------------
185 Change ownership of the Evergreen files
186 ---------------------------------------
188 All files in the `/openils/` directory and subdirectories must be owned by the
189 `opensrf` user. Issue the following command as the *root* Linux account to
190 change the ownership on the files:
193 ------------------------------------------------------------------------------
194 chown -R opensrf:opensrf /openils
195 ------------------------------------------------------------------------------
197 Configure the Apache Web server
198 -------------------------------
200 1. Use the example configuration files in `Open-ILS/examples/apache/` (for
201 Apache versions below 2.4) or `Open-ILS/examples/apache_24/` (for Apache
202 versions 2.4 or greater) to configure your Web server for the Evergreen
203 catalog, staff client, Web services, and administration interfaces. Issue the
204 following commands as the *root* Linux account:
208 ------------------------------------------------------------------------------
209 cp Open-ILS/examples/apache/eg.conf /etc/apache2/sites-available/
210 cp Open-ILS/examples/apache/eg_vhost.conf /etc/apache2/
211 cp Open-ILS/examples/apache/eg_startup /etc/apache2/
213 mkdir /etc/apache2/ssl
215 ------------------------------------------------------------------------------
219 ------------------------------------------------------------------------------
220 cp Open-ILS/examples/apache_24/eg_24.conf /etc/httpd/conf.d/
221 cp Open-ILS/examples/apache_24/eg_vhost_24.conf /etc/httpd/eg_vhost.conf
222 cp Open-ILS/examples/apache/eg_startup /etc/httpd/
226 ------------------------------------------------------------------------------
228 2. The `openssl` command cuts a new SSL key for your Apache server. For a
229 production server, you should purchase a signed SSL certificate, but you can
230 just use a self-signed certificate and accept the warnings in the staff client
231 and browser during testing and development. Create an SSL key for the Apache
232 server by issuing the following command as the *root* Linux account:
235 ------------------------------------------------------------------------------
236 openssl req -new -x509 -days 365 -nodes -out server.crt -keyout server.key
237 ------------------------------------------------------------------------------
239 3. As the *root* Linux account, edit the `eg.conf` file that you copied into
241 a. To enable access to the offline upload / execute interface from any
242 workstation on any network, make the following change (and note that
243 you *must* secure this for a production instance):
244 * (Apache 2.2): Replace `Allow from 10.0.0.0/8` with `Allow from all`
245 * (Apache 2.4): Replace `Require host 10.0.0.0/8` with `Require all granted`
246 b. (Fedora): Change references from the non-existent `/etc/apache2/` directory
248 4. Change the user for the Apache server.
249 * (Debian and Ubuntu): As the *root* Linux account, edit
250 `/etc/apache2/envvars`. Change `export APACHE_RUN_USER=www-data` to
251 `export APACHE_RUN_USER=opensrf`.
252 * (Fedora): As the *root* Linux account , edit `/etc/httpd/conf/httpd.conf`.
253 Change `User apache` to `User opensrf`.
254 5. Configure Apache with performance settings appropriate for Evergreen:
255 * (Debian and Ubuntu): As the *root* Linux account, edit
256 `/etc/apache2/apache2.conf`:
257 * (Fedora): As the *root* Linux account, edit `/etc/httpd/conf/httpd.conf`:
258 a. Change `KeepAliveTimeout` to `1`. Higher values reduce the chance of
259 a request timing out unexpectedly, but increase the risk of using up
260 all available Apache child processes.
261 b. 'Optional': Change `MaxKeepAliveRequests` to `100`
262 c. Update the prefork configuration section to suit your environment. The
263 following settings apply to a busy system:
266 ------------------------------------------------------------------------------
267 <IfModule mpm_prefork_module>
272 MaxRequestsPerChild 10000
274 ------------------------------------------------------------------------------
276 6. (Fedora): As the *root* Linux account, edit the `/etc/httpd/eg_vhost.conf`
277 file to change references from the non-existent `/etc/apache2/` directory
279 7. (Debian and Ubuntu): As the *root* Linux account, enable the Evergreen site:
282 ------------------------------------------------------------------------------
283 a2dissite default # OPTIONAL: disable the default site (the "It Works" page)
285 ------------------------------------------------------------------------------
286 8. (Ubuntu): As the *root* Linux account, enable Apache to write
287 to the lock directory; this is currently necessary because Apache
288 is running as the `opensrf` user:
291 ------------------------------------------------------------------------------
292 chown opensrf /var/lock/apache2
293 ------------------------------------------------------------------------------
295 Configure OpenSRF for the Evergreen application
296 -----------------------------------------------
297 There are a number of example OpenSRF configuration files in `/openils/conf/`
298 that you can use as a template for your Evergreen installation. Issue the
299 following commands as the *opensrf* Linux account:
302 ------------------------------------------------------------------------------
303 cp -b /openils/conf/opensrf_core.xml.example /openils/conf/opensrf_core.xml
304 cp -b /openils/conf/opensrf.xml.example /openils/conf/opensrf.xml
305 ------------------------------------------------------------------------------
307 When you installed OpenSRF, you created four Jabber users on two
308 separate domains and edited the `opensrf_core.xml` file accordingly. Please
309 refer back to the OpenSRF README and, as the *opensrf* Linux account, edit the
310 Evergreen version of the `opensrf_core.xml` file using the same Jabber users
311 and domains as you used while installing and testing OpenSRF.
314 The `-b` flag tells the `cp` command to create a backup version of the
315 destination file. The backup version of the destination file has a tilde (`~`)
316 appended to the file name, so if you have forgotten the Jabber users and
317 domains, you can retrieve the settings from the backup version of the files.
319 `eg_db_config`, described in the following section, sets the database
320 connection information in `opensrf.xml` for you.
322 Creating the Evergreen database
323 -------------------------------
325 Setting up the PostgreSQL server
326 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
328 For production use, most libraries install the PostgreSQL database server on a
329 dedicated machine. Therefore, by default, the `Makefile.install` prerequisite
330 installer does *not* install the PostgreSQL 9 database server that is required
331 by every Evergreen system. You can install the packages required by Debian or
332 Ubuntu Lucid on the machine of your choice using the following commands as the
333 *root* Linux account:
335 .(Debian / Ubuntu / Fedora) Installing PostgreSQL server packages
337 Each OS build target provides the postgres server installation packages
338 required for each operating system. To install Postgres server packages,
339 use the make target 'postgres-server-<OSTYPE>'. Choose the most appropriate
340 command below based on your operating system.
343 ------------------------------------------------------------------------------
344 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-wheezy
345 make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-squeeze
346 make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-lucid
347 make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-precise
348 make -f Open-ILS/src/extras/Makefile.install postgres-server-fedora
349 ------------------------------------------------------------------------------
351 .(Fedora) Postgres initialization
353 Installing Postgres on Fedora also requires you to initialize the PostgreSQL
354 cluster and start the service. Issue the following commands as the *root* user:
357 ------------------------------------------------------------------------------
358 postgresql-setup initdb
359 systemctl start postgresql
360 ------------------------------------------------------------------------------
362 For a standalone PostgreSQL server, install the following Perl modules as the
363 *root* Linux account:
365 .(Debian / Ubuntu) Installing additional Perl modules on a standalone PostgreSQL 9 server
367 ------------------------------------------------------------------------------
368 aptitude install gcc libxml-libxml-perl libxml-libxslt-perl
371 cpan Library::CallNumber::LC
376 ------------------------------------------------------------------------------
378 .(Fedora) Installing additional Perl modules on a standalone PostgreSQL 9 server
380 ------------------------------------------------------------------------------
381 yum install gcc perl-XML-LibXML perl-XML-LibXSLT perl-Business-ISBN
382 yum install perl-Library-CallNumber-LC perl-MARC-Record perl-MARC-Charset
383 yum install perl-MARC-File-XML perl-UUID-Tiny
384 ------------------------------------------------------------------------------
386 You need to create a PostgreSQL superuser to create and access the database.
387 Issue the following command as the *postgres* Linux account to create a new
388 PostgreSQL superuser named `evergreen`. When prompted, enter the new user's
392 ------------------------------------------------------------------------------
393 createuser -s -P evergreen
394 ------------------------------------------------------------------------------
396 .Enabling connections to the PostgreSQL database
398 Your PostgreSQL database may be configured by default to prevent connections,
399 for example, it might reject attempts to connect via TCP/IP or from other
400 servers. To enable TCP/IP connections from localhost, check your `pg_hba.conf`
401 file, found in the `/etc/postgresql/` directory on Debian and Ubuntu, and in
402 the `/var/lib/pgsql/data/` directory on Fedora. A simple way to enable TCP/IP
403 connections from localhost to all databases with password authentication, which
404 would be suitable for a test install of Evergreen on a single server, is to
405 ensure the file contains the following entries _before_ any "host ... ident"
408 ------------------------------------------------------------------------------
409 host all all ::1/128 md5
410 host all all 127.0.0.1/32 md5
411 ------------------------------------------------------------------------------
413 When you change the `pg_hba.conf` file, you will need to reload PostgreSQL to
414 make the changes take effect. For more information on configuring connectivity
416 http://www.postgresql.org/docs/devel/static/auth-pg-hba-conf.html
418 Creating the Evergreen database and schema
419 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
421 Once you have created the *evergreen* PostgreSQL account, you also need to
422 create the database and schema, and configure your configuration files to point
423 at the database server. Issue the following command as the *root* Linux account
424 from inside the Evergreen source directory, replacing <user>, <password>,
425 <hostname>, <port>, and <dbname> with the appropriate values for your
426 PostgreSQL database (where <user> and <password> are for the *evergreen*
427 PostgreSQL account you just created), and replace <admin-user> and <admin-pass>
428 with the values you want for the *egadmin* Evergreen administrator account:
431 ------------------------------------------------------------------------------
432 perl Open-ILS/src/support-scripts/eg_db_config --update-config \
433 --service all --create-database --create-schema --create-offline \
434 --user <user> --password <password> --hostname <hostname> --port <port> \
435 --database <dbname> --admin-user <admin-user> --admin-pass <admin-pass>
436 ------------------------------------------------------------------------------
438 This creates the database and schema and configures all of the services in
439 your `/openils/conf/opensrf.xml` configuration file to point to that database.
440 It also creates the configuration files required by the Evergreen `cgi-bin`
441 administration scripts, and sets the user name and password for the *egadmin*
442 Evergreen administrator account to your requested values.
444 You can get a complete set of options for `eg_db_config.pl` by passing the
449 If you add the `--load-all-sample` parameter to the `eg_db_config` command,
450 a set of authority and bibliographic records, call numbers, copies, staff
451 and regular users, and transactions will be loaded into your target
452 database. This sample dataset is commonly referred to as the _concerto_
453 sample data, and can be useful for testing out Evergreen functionality and
454 for creating problem reports that developers can easily recreate with their
455 own copy of the _concerto_ sample data.
457 Creating the database on a remote server
458 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
459 In a production instance of Evergreen, your PostgreSQL server should be
460 installed on a dedicated server.
462 PostgreSQL 9.1 and later
463 ^^^^^^^^^^^^^^^^^^^^^^^^
464 To create the database instance on a remote database server running PostgreSQL
465 9.1 or later, simply use the `--create-database` flag on `eg_db_config`.
469 1. As the *root* Linux account, start the `memcached` and `ejabberd` services
470 (if they aren't already running):
473 ------------------------------------------------------------------------------
474 /etc/init.d/ejabberd start
475 /etc/init.d/memcached start
476 ------------------------------------------------------------------------------
478 2. As the *opensrf* Linux account, start Evergreen. The `-l` flag in the
479 following command is only necessary if you want to force Evergreen to treat the
480 hostname as `localhost`; if you configured `opensrf.xml` using the real
481 hostname of your machine as returned by `perl -ENet::Domain 'print
482 Net::Domain::hostfqdn() . "\n";'`, you should not use the `-l` flag.
485 ------------------------------------------------------------------------------
486 osrf_control -l --start-all
487 ------------------------------------------------------------------------------
489 ** If you receive the error message `bash: osrf_control: command not found`,
490 then your environment variable `PATH` does not include the `/openils/bin`
491 directory; this should have been set in the *opensrf* Linux account's
492 `.bashrc` configuration file. To manually set the `PATH` variable, edit the
493 configuration file `~/.bashrc` as the *opensrf* Linux account and add the
497 ------------------------------------------------------------------------------
498 export PATH=$PATH:/openils/bin
499 ------------------------------------------------------------------------------
501 3. As the *opensrf* Linux account, generate the Web files needed by the staff
502 client and catalogue and update the organization unit proximity (you need to do
503 this the first time you start Evergreen, and after that each time you change
504 the library hierarchy in `config.cgi`):
507 ------------------------------------------------------------------------------
509 ------------------------------------------------------------------------------
511 4. As the *root* Linux account, restart the Apache Web server:
514 ------------------------------------------------------------------------------
515 /etc/init.d/apache2 restart
516 ------------------------------------------------------------------------------
518 If the Apache Web server was running when you started the OpenSRF services, you
519 might not be able to successfully log in to the OPAC or staff client until the
520 Apache Web server is restarted.
522 Testing connections to Evergreen
523 --------------------------------
525 Once you have installed and started Evergreen, test your connection to
526 Evergreen via `srfsh`. As the *opensrf* Linux account, issue the following
527 commands to start `srfsh` and try to log onto the Evergreen server using the
528 *egadmin* Evergreen administrator user name and password that you set using the
529 `eg_db_config` command:
532 ------------------------------------------------------------------------------
534 srfsh% login <admin-user> <admin-pass>
535 ------------------------------------------------------------------------------
537 You should see a result like:
539 Received Data: "250bf1518c7527a03249858687714376"
540 ------------------------------------
541 Request Completed Successfully
542 Request Time in seconds: 0.045286
543 ------------------------------------
547 "textcode":"SUCCESS",
550 "stacktrace":"oils_auth.c:304",
552 "authtoken":"e5f9827cc0f93b503a1cc66bee6bdd1a",
558 ------------------------------------
559 Request Completed Successfully
560 Request Time in seconds: 1.336568
561 ------------------------------------
563 If this does not work, it's time to do some troubleshooting.
565 * As the *opensrf* Linux account, run the `settings-tester.pl` script to see
566 if it finds any system configuration problems. The script is found at
567 `Open-ILS/src/support-scripts/settings-tester.pl` in the Evergreen source
569 * Follow the steps in the http://evergreen-ils.org/dokuwiki/doku.php?id=troubleshooting:checking_for_errors[troubleshooting guide].
570 * If you have faithfully followed the entire set of installation steps
571 listed here, you are probably extremely close to a working system.
572 Gather your configuration files and log files and contact the
573 http://evergreen-ils.org/communicate/mailing-lists/[Evergreen development
574 mailing list] for assistance before making any drastic changes to your system
580 Need help installing or using Evergreen? Join the mailing lists at
581 http://evergreen-ils.org/communicate/mailing-lists/ or contact us on the Freenode
582 IRC network on the #evergreen channel.
586 This work is licensed under the Creative Commons Attribution-ShareAlike 3.0
587 Unported License. To view a copy of this license, visit
588 http://creativecommons.org/licenses/by-sa/3.0/ or send a letter to Creative
589 Commons, 444 Castro Street, Suite 900, Mountain View, California, 94041, USA.