1 README for Evergreen master
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.0 or later).
80 You can download OpenSRF releases from http://evergreen-ils.org/opensrf.php
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 16 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`, `fedora16`, `ubuntu-lucid`, `ubuntu-precise`,
113 `centos`, or `rhel` for <osname> below:
116 ------------------------------------------------------------------------------
117 make -f Open-ILS/src/extras/Makefile.install <osname>
118 ------------------------------------------------------------------------------
121 `centos` and `rhel` are less tested than the `debian`, `fedora`, `ubuntu-lucid`,
122 and `ubuntu-precise` options. Your patches and suggestions for improvement are
125 5. Add the libdbi-libdbd libraries to the system dynamic library path by
126 issuing the following commands as the *root* Linux account:
129 You should skip this step if installing on Ubuntu Precise. The ubuntu-precise
130 target uses libdbd-pgsql from packages.
132 .Debian / Ubuntu Lucid
134 ------------------------------------------------------------------------------
135 echo "/usr/local/lib/dbd" > /etc/ld.so.conf.d/eg.conf
137 ------------------------------------------------------------------------------
141 ------------------------------------------------------------------------------
142 echo "/usr/lib64/dbd" > /etc/ld.so.conf.d/eg.conf
144 ------------------------------------------------------------------------------
146 Configuration and compilation instructions
147 ------------------------------------------
149 For the time being, we are still installing everything in the `/openils/`
150 directory. From the Evergreen source directory, issue the following commands as
151 the *user* Linux account to configure and build Evergreen:
154 ------------------------------------------------------------------------------
155 ./configure --prefix=/openils --sysconfdir=/openils/conf
157 ------------------------------------------------------------------------------
159 Installation instructions
160 -------------------------
162 1. Once you have configured and compiled Evergreen, issue the following
163 command as the *root* Linux account to install Evergreen, build the server
164 portion of the staff client, and copy example configuration files to
166 Change the value of the `STAFF_CLIENT_STAMP_ID` variable to match the version
167 of the staff client that you will use to connect to the Evergreen server.
170 ------------------------------------------------------------------------------
171 make STAFF_CLIENT_STAMP_ID=rel_name install
172 ------------------------------------------------------------------------------
174 2. The server portion of the staff client expects `http://hostname/xul/server`
175 to resolve. Issue the following commands as the *root* Linux account to
176 create a symbolic link pointing to the `server` subdirectory of the server
177 portion of the staff client that we just built using the staff client ID
181 ------------------------------------------------------------------------------
182 cd /openils/var/web/xul
183 ln -sf rel_name/server server
184 ------------------------------------------------------------------------------
186 Change ownership of the Evergreen files
187 ---------------------------------------
189 All files in the `/openils/` directory and subdirectories must be owned by the
190 `opensrf` user. Issue the following command as the *root* Linux account to
191 change the ownership on the files:
194 ------------------------------------------------------------------------------
195 chown -R opensrf:opensrf /openils
196 ------------------------------------------------------------------------------
198 Configure the Apache Web server
199 -------------------------------
201 1. Use the example configuration files in `Open-ILS/examples/apache/` to
202 configure your Web server for the Evergreen catalog, staff client, Web
203 services, and administration interfaces. Issue the following commands as the
204 *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/startup.pl /etc/apache2/
213 mkdir /etc/apache2/ssl
215 ------------------------------------------------------------------------------
219 ------------------------------------------------------------------------------
220 cp Open-ILS/examples/apache/eg.conf /etc/httpd/conf.d/
221 cp Open-ILS/examples/apache/eg_vhost.conf /etc/httpd/
222 cp Open-ILS/examples/apache/startup.pl /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. Replace `Allow from 10.0.0.0/8` with `Allow from all` (to enable
242 access to the offline upload / execute interface from any workstation on
243 any network - note that you must secure this for a production instance)
244 b. (Fedora): Change references from the non-existent `/etc/apache2/` directory
246 4. Change the user for the Apache server.
247 * (Debian and Ubuntu): As the *root* Linux account, edit
248 `/etc/apache2/envvars`. Change `export APACHE_RUN_USER=www-data` to
249 `export APACHE_RUN_USER=opensrf`.
250 * (Fedora): As the *root* Linux account , edit `/etc/httpd/conf/httpd.conf`.
251 Change `User apache` to `User opensrf`.
252 5. Configure Apache with performance settings appropriate for Evergreen:
253 * (Debian and Ubuntu): As the *root* Linux account, edit
254 `/etc/apache2/apache2.conf`:
255 * (Fedora): As the *root* Linux account, edit `/etc/httpd/conf/httpd.conf`:
256 a. Change `KeepAliveTimeout` to `1`. Higher values reduce the chance of
257 a request timing out unexpectedly, but increase the risk of using up
258 all available Apache child processes.
259 b. 'Optional': Change `MaxKeepAliveRequests` to `100`
260 c. Update the prefork configuration section to suit your environment. The
261 following settings apply to a busy system:
264 ------------------------------------------------------------------------------
265 <IfModule mpm_prefork_module>
270 MaxRequestsPerChild 10000
272 ------------------------------------------------------------------------------
274 6. (Fedora): As the *root* Linux account, edit the `/etc/httpd/eg_vhost.conf`
275 file to change references from the non-existent `/etc/apache2/` directory
277 7. (Debian and Ubuntu): As the *root* Linux account, enable the Evergreen site:
280 ------------------------------------------------------------------------------
281 a2dissite default # OPTIONAL: disable the default site (the "It Works" page)
283 ------------------------------------------------------------------------------
285 Configure OpenSRF for the Evergreen application
286 -----------------------------------------------
287 There are a number of example OpenSRF configuration files in `/openils/conf/`
288 that you can use as a template for your Evergreen installation. Issue the
289 following commands as the *opensrf* Linux account:
292 ------------------------------------------------------------------------------
293 cp -b /openils/conf/opensrf_core.xml.example /openils/conf/opensrf_core.xml
294 cp -b /openils/conf/opensrf.xml.example /openils/conf/opensrf.xml
295 ------------------------------------------------------------------------------
297 When you installed OpenSRF, you created four Jabber users on two
298 separate domains and edited the `opensrf_core.xml` file accordingly. Please
299 refer back to the OpenSRF README and, as the *opensrf* Linux account, edit the
300 Evergreen version of the `opensrf_core.xml` file using the same Jabber users
301 and domains as you used while installing and testing OpenSRF.
304 The `-b` flag tells the `cp` command to create a backup version of the
305 destination file. The backup version of the destination file has a tilde (`~`)
306 appended to the file name, so if you have forgotten the Jabber users and
307 domains, you can retrieve the settings from the backup version of the files.
309 `eg_db_config.pl`, described in the following section, sets the database
310 connection information in `opensrf.xml` for you.
312 Creating the Evergreen database
313 -------------------------------
315 By default, the `Makefile.install` prerequisite installer does not install
316 the PostgreSQL 9 database server required by every Evergreen system;
317 for production use, most libraries install the PostgreSQL database server on a
318 dedicated machine. You can install the packages required by Debian or Ubuntu Lucid
319 on the machine of your choice using the following commands as the *root*
322 .(Debian and Ubuntu Lucid) Installing PostgreSQL 9.1 server packages
324 ------------------------------------------------------------------------------
325 make -f Open-ILS/src/extras/Makefile.install install_pgsql_server_backport_debs_91
326 ------------------------------------------------------------------------------
328 .(Ubuntu Precise) Installing PostgreSQL 9.1 server packages
330 ------------------------------------------------------------------------------
331 make -f Open-ILS/src/extras/Makefile.install install_pgsql_server_debs_91
332 ------------------------------------------------------------------------------
334 You can install the packages required by Fedora on the machine of your choice
335 using the following commands as the *root* Linux account:
337 .(Fedora 16) Installing PostgreSQL server packages
339 ------------------------------------------------------------------------------
340 make -f Open-ILS/src/extras/Makefile.install install_fedora_pgsql_server
341 postgresql-setup initdb
342 ------------------------------------------------------------------------------
344 For a standalone PostgreSQL server, install the following Perl modules as the
345 *root* Linux account:
347 .(Debian / Ubuntu) Installing additional Perl modules on a standalone PostgreSQL 9 server
349 ------------------------------------------------------------------------------
350 aptitude install gcc libxml-libxml-perl libxml-libxslt-perl
353 cpan Library::CallNumber::LC
357 ------------------------------------------------------------------------------
359 .(Fedora 16) Installing additional Perl modules on a standalone PostgreSQL 9 server
361 ------------------------------------------------------------------------------
362 yum install gcc perl-XML-LibXML perl-XML-LibXSLT perl-Business-ISBN
363 cpan Library::CallNumber::LC
367 ------------------------------------------------------------------------------
369 You need to create a PostgreSQL superuser to create and access the database.
370 Issue the following command as the *postgres* Linux account to create a new
371 PostgreSQL superuser named `evergreen`. When prompted, enter the new user's
375 ------------------------------------------------------------------------------
376 createuser -s -P evergreen
377 ------------------------------------------------------------------------------
379 Once you have created the *evergreen* PostgreSQL account, you also need to
380 create the database and schema, and configure your configuration files to point
381 at the database server. Issue the following command as the *root* Linux account
382 from inside the Evergreen source directory, replacing <user>, <password>,
383 <hostname>, <port>, and <dbname> with the appropriate values for your
384 PostgreSQL database (where <user> and <password> are for the *evergreen*
385 PostgreSQL account you just created), and replace <admin-user> and <admin-pass>
386 with the values you want for the *egadmin* Evergreen administrator account:
389 ------------------------------------------------------------------------------
390 perl Open-ILS/src/support-scripts/eg_db_config.pl --update-config \
391 --service all --create-database --create-schema --create-offline \
392 --user <user> --password <password> --hostname <hostname> --port <port> \
393 --database <dbname> --admin-user <admin-user> --admin-pass <admin-pass>
394 ------------------------------------------------------------------------------
396 This creates the database and schema and configures all of the services in
397 your `/openils/conf/opensrf.xml` configuration file to point to that database.
398 It also creates the configuration files required by the Evergreen `cgi-bin`
399 administration scripts, and sets the user name and password for the *egadmin*
400 Evergreen administrator account to your requested values.
402 Creating the database on a remote server
403 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
404 In a production instance of Evergreen, your PostgreSQL server should be
405 installed on a dedicated server. For PostgreSQL 9.1 and later you should be
406 able to continue to use the --create-database flag on eg_db_config.pl, without
407 needing to install any server modules on your application machine. For
408 PostgreSQL 9.0 you can either:
410 * Install the PostgreSQL contrib modules on the machine on which you
411 are installing the Evergreen code, and use the --create-database
412 option from that machine, or
413 * Copy the `Open-ILS/src/sql/Pg/create_database.sql` script to your
414 PostgreSQL server and invoke it as the *postgres* Linux account:
417 ------------------------------------------------------------------------------
418 psql -vdb_name=<dbname> -vcontrib_dir=`pg_config --sharedir`/contrib -f create_database.sql
419 ------------------------------------------------------------------------------
421 Then you can issue the `eg_db_config.pl` command as above _without_ the
422 `--create-database` argument to create your schema and configure your
427 1. As the *root* Linux account, start the `memcached` and `ejabberd` services
428 (if they aren't already running):
431 ------------------------------------------------------------------------------
432 /etc/init.d/ejabberd start
433 /etc/init.d/memcached start
434 ------------------------------------------------------------------------------
436 2. As the *opensrf* Linux account, start Evergreen. The `-l` flag in the
437 following command is only necessary if you want to force Evergreen to treat the
438 hostname as `localhost`; if you configured `opensrf.xml` using the real
439 hostname of your machine as returned by `perl -ENet::Domain 'print
440 Net::Domain::hostfqdn() . "\n";'`, you should not use the `-l` flag.
443 ------------------------------------------------------------------------------
444 osrf_ctl.sh -l -a start_all
445 ------------------------------------------------------------------------------
447 ** If you receive the error message `bash: osrf_ctl.sh: command not found`,
448 then your environment variable `PATH` does not include the `/openils/bin`
449 directory; this should have been set in the *opensrf* Linux account's
450 `.bashrc` configuration file. To manually set the `PATH` variable, edit the
451 configuration file `~/.bashrc` as the *opensrf* Linux account and add the
455 ------------------------------------------------------------------------------
456 export PATH=$PATH:/openils/bin
457 ------------------------------------------------------------------------------
459 3. As the *opensrf* Linux account, generate the Web files needed by the staff
460 client and catalogue and update the organization unit proximity (you need to do
461 this the first time you start Evergreen, and after that each time you change
462 the library hierarchy in `config.cgi`):
465 ------------------------------------------------------------------------------
467 ------------------------------------------------------------------------------
469 4. As the *root* Linux account, restart the Apache Web server:
472 ------------------------------------------------------------------------------
473 /etc/init.d/apache2 restart
474 ------------------------------------------------------------------------------
476 If the Apache Web server was running when you started the OpenSRF services, you
477 might not be able to successfully log in to the OPAC or staff client until the
478 Apache Web server is restarted.
480 Testing connections to Evergreen
481 --------------------------------
483 Once you have installed and started Evergreen, test your connection to
484 Evergreen via `srfsh`. As the *opensrf* Linux account, issue the following
485 commands to start `srfsh` and try to log onto the Evergreen server using the
486 *egadmin* Evergreen administrator user name and password that you set using the
487 `eg_db_config.pl` command:
490 ------------------------------------------------------------------------------
492 srfsh% login <admin-user> <admin-pass>
493 ------------------------------------------------------------------------------
495 You should see a result like:
497 Received Data: "250bf1518c7527a03249858687714376"
498 ------------------------------------
499 Request Completed Successfully
500 Request Time in seconds: 0.045286
501 ------------------------------------
505 "textcode":"SUCCESS",
508 "stacktrace":"oils_auth.c:304",
510 "authtoken":"e5f9827cc0f93b503a1cc66bee6bdd1a",
516 ------------------------------------
517 Request Completed Successfully
518 Request Time in seconds: 1.336568
519 ------------------------------------
521 If this does not work, it's time to do some troubleshooting.
523 * As the *opensrf* Linux acccount, run the `settings-tester.pl` script to see
524 if it finds any system configuration problems. The script is found at
525 `Open-ILS/src/support-scripts/settings-tester.pl` in the Evergreen source
527 * Follow the steps in the http://evergreen-ils.org/dokuwiki/doku.php?id=troubleshooting:checking_for_errors[troubleshooting guide].
528 * If you have faithfully followed the entire set of installation steps
529 listed here, you are probably extremely close to a working system.
530 Gather your configuration files and log files and contact the
531 http://open-ils.org/listserv.php[Evergreen development mailing list]
532 for assistance before making any drastic changes to your system
538 Need help installing or using Evergreen? Join the mailing lists at
539 http://evergreen-ils.org/listserv.php or contact us on the Freenode
540 IRC network on the #evergreen channel.