1 README for Evergreen master
2 ===========================
4 Preamble: referenced user accounts
5 ----------------------------------
7 In subsequent sections, we will refer to a number of different accounts, as
10 * Linux user accounts:
11 ** The *user* Linux account is the account that you use to log onto the
12 Linux system as a regular user.
13 ** The *root* Linux account is an account that has system administrator
14 privileges. On Debian and Fedora you can switch to this account from
15 your *user* account by issuing the `su -` command and entering the
16 password for the *root* account when prompted. On Ubuntu you can switch
17 to this account from your *user* account using the `sudo su -` command
18 and entering the password for your *user* account when prompted.
19 ** The *opensrf* Linux account is an account that you create when installing
20 OpenSRF. You can switch to this account from the *root* account by
21 issuing the `su - opensrf` command.
22 ** The *postgres* Linux account is created automatically when you install
23 the PostgreSQL database server. You can switch to this account from the
24 *root* account by issuing the `su - postgres` command.
25 * PostgreSQL user accounts:
26 ** The *evergreen* PostgreSQL account is a superuser account that you will
27 create to connect to the PostgreSQL database server.
28 * Evergreen administrator account:
29 ** The *egadmin* Evergreen account is an administrator account for
30 Evergreen that you will use to test connectivity and configure your
33 Preamble: Developer instructions
34 --------------------------------
37 Skip this section if you are using an official release tarball downloaded
38 from http://evergreen-ils.org/downloads
40 Developers working directly with the source code from the Git repository,
41 rather than an official release tarball, must install some extra packages
42 and perform one step before they can proceed with the `./configure` step.
44 As the *root* Linux account, install the following packages:
50 As the *user* Linux account, issue the following command in the Evergreen
51 source directory to generate the configure script and Makefiles:
54 ------------------------------------------------------------------------------
56 ------------------------------------------------------------------------------
58 After running `make install`, developers also need to install the Dojo Toolkit
59 set of JavaScript libraries. The appropriate version of Dojo is included
60 in Evergreen release tarballs. Developers should install the Dojo 1.3.3
61 version of Dojo by issuing the following commands as the *opensrf* Linux
65 ------------------------------------------------------------------------------
66 wget http://download.dojotoolkit.org/release-1.3.3/dojo-release-1.3.3.tar.gz
67 tar -C /openils/var/web/js -xzf dojo-release-1.3.3.tar.gz
68 cp -r /openils/var/web/js/dojo-release-1.3.3/* /openils/var/web/js/dojo/.
69 ------------------------------------------------------------------------------
71 Installing prerequisites
72 ------------------------
74 Evergreen has a number of prerequisite packages that must be installed
75 before you can successfully configure, compile, and install Evergreen.
77 1. Begin by installing the most recent version of OpenSRF (2.0 or later).
78 You can download OpenSRF releases from http://evergreen-ils.org/opensrf.php
79 2. On many distributions, it is necessary to install PostgreSQL 9 from external
82 * On Debian Squeeze, open `/etc/apt/sources.list` in a text editor as the
83 *root* Linux account and add the following line:
86 ------------------------------------------------------------------------------
87 deb http://backports.debian.org/debian-backports squeeze-backports main contrib
88 ------------------------------------------------------------------------------
90 * On Ubuntu Lucid, you can use a PPA (personal package archive), which are
91 package sources hosted on Launchpad. The one most commonly used by Evergreen
92 Community members is maintained by Martin Pitt, who also maintains the
93 official PostgreSQL packages for Ubuntu. As the *root* Linux account, issue
94 the following commands to add the PPA source:
97 ------------------------------------------------------------------------------
98 apt-get install python-software-properties
99 add-apt-repository ppa:pitti/postgresql
100 ------------------------------------------------------------------------------
102 * Ubuntu Precise comes with PostgreSQL 9, so no additional steps are required.
104 * Fedora 16 comes with PostgreSQL 9, so no additional steps are required.
106 3. On Debian and Ubuntu, run `aptitude update` as the *root* Linux account to
107 retrieve the new packages from the backports repository.
108 4. Issue the following commands as the *root* Linux account to install
109 prerequisites using the `Makefile.install` prerequisite installer,
110 substituting `debian-squeeze`, `fedora16`, `ubuntu-lucid`, `ubuntu-precise`,
111 `centos`, or `rhel` for <osname> below:
114 ------------------------------------------------------------------------------
115 make -f Open-ILS/src/extras/Makefile.install <osname>
116 ------------------------------------------------------------------------------
119 `centos` and `rhel` are less tested than the `debian`, `fedora`, `ubuntu-lucid`,
120 and `ubuntu-precise` options. Your patches and suggestions for improvement are
123 5. Add the libdbi-libdbd libraries to the system dynamic library path by
124 issuing the following commands as the *root* Linux account:
127 You should skip this step if installing on Ubuntu Precise. The ubuntu-precise
128 target uses libdbd-pgsql from packages.
130 .Debian / Ubuntu Lucid
132 ------------------------------------------------------------------------------
133 echo "/usr/local/lib/dbd" > /etc/ld.so.conf.d/eg.conf
135 ------------------------------------------------------------------------------
139 ------------------------------------------------------------------------------
140 echo "/usr/lib64/dbd" > /etc/ld.so.conf.d/eg.conf
142 ------------------------------------------------------------------------------
144 Configuration and compilation instructions
145 ------------------------------------------
147 For the time being, we are still installing everything in the `/openils/`
148 directory. From the Evergreen source directory, issue the following commands as
149 the *user* Linux account to configure and build Evergreen:
152 ------------------------------------------------------------------------------
153 ./configure --prefix=/openils --sysconfdir=/openils/conf
155 ------------------------------------------------------------------------------
157 Installation instructions
158 -------------------------
160 1. Once you have configured and compiled Evergreen, issue the following
161 command as the *root* Linux account to install Evergreen, build the server
162 portion of the staff client, and copy example configuration files to
164 Change the value of the `STAFF_CLIENT_STAMP_ID` variable to match the version
165 of the staff client that you will use to connect to the Evergreen server.
168 ------------------------------------------------------------------------------
169 make STAFF_CLIENT_STAMP_ID=rel_name install
170 ------------------------------------------------------------------------------
172 2. The server portion of the staff client expects `http://hostname/xul/server`
173 to resolve. Issue the following commands as the *root* Linux account to
174 create a symbolic link pointing to the `server` subdirectory of the server
175 portion of the staff client that we just built using the staff client ID
179 ------------------------------------------------------------------------------
180 cd /openils/var/web/xul
181 ln -sf rel_name/server server
182 ------------------------------------------------------------------------------
184 Change ownership of the Evergreen files
185 ---------------------------------------
187 All files in the `/openils/` directory and subdirectories must be owned by the
188 `opensrf` user. Issue the following command as the *root* Linux account to
189 change the ownership on the files:
192 ------------------------------------------------------------------------------
193 chown -R opensrf:opensrf /openils
194 ------------------------------------------------------------------------------
196 Configure the Apache Web server
197 -------------------------------
199 1. Use the example configuration files in `Open-ILS/examples/apache/` to
200 configure your Web server for the Evergreen catalog, staff client, Web
201 services, and administration interfaces. Issue the following commands as the
202 *root* Linux account:
206 ------------------------------------------------------------------------------
207 cp Open-ILS/examples/apache/eg.conf /etc/apache2/sites-available/
208 cp Open-ILS/examples/apache/eg_vhost.conf /etc/apache2/
209 cp Open-ILS/examples/apache/startup.pl /etc/apache2/
211 mkdir /etc/apache2/ssl
213 ------------------------------------------------------------------------------
217 ------------------------------------------------------------------------------
218 cp Open-ILS/examples/apache/eg.conf /etc/httpd/conf.d/
219 cp Open-ILS/examples/apache/eg_vhost.conf /etc/httpd/
220 cp Open-ILS/examples/apache/startup.pl /etc/httpd/
224 ------------------------------------------------------------------------------
226 2. The `openssl` command cuts a new SSL key for your Apache server. For a
227 production server, you should purchase a signed SSL certificate, but you can
228 just use a self-signed certificate and accept the warnings in the staff client
229 and browser during testing and development. Create an SSL key for the Apache
230 server by issuing the following command as the *root* Linux account:
233 ------------------------------------------------------------------------------
234 openssl req -new -x509 -days 365 -nodes -out server.crt -keyout server.key
235 ------------------------------------------------------------------------------
237 3. As the *root* Linux account, edit the `eg.conf` file that you copied into
239 a. Replace `Allow from 10.0.0.0/8` with `Allow from all` (to enable
240 access to the offline upload / execute interface from any workstation on
241 any network - note that you must secure this for a production instance)
242 b. (Fedora): Change references from the non-existent `/etc/apache2/` directory
244 4. Change the user for the Apache server.
245 * (Debian and Ubuntu): As the *root* Linux account, edit
246 `/etc/apache2/envvars`. Change `export APACHE_RUN_USER=www-data` to
247 `export APACHE_RUN_USER=opensrf`.
248 * (Fedora): As the *root* Linux account , edit `/etc/httpd/conf/httpd.conf`.
249 Change `User apache` to `User opensrf`.
250 5. Configure Apache with performance settings appropriate for Evergreen:
251 * (Debian and Ubuntu): As the *root* Linux account, edit
252 `/etc/apache2/apache2.conf`:
253 * (Fedora): As the *root* Linux account, edit `/etc/httpd/conf/httpd.conf`:
254 a. Change `KeepAliveTimeout` to `1`. Higher values reduce the chance of
255 a request timing out unexpectedly, but increase the risk of using up
256 all available Apache child processes.
257 b. 'Optional': Change `MaxKeepAliveRequests` to `100`
258 c. Update the prefork configuration section to suit your environment. The
259 following settings apply to a busy system:
262 ------------------------------------------------------------------------------
263 <IfModule mpm_prefork_module>
268 MaxRequestsPerChild 10000
270 ------------------------------------------------------------------------------
272 6. (Fedora): As the *root* Linux account, edit the `/etc/httpd/eg_vhost.conf`
273 file to change references from the non-existent `/etc/apache2/` directory
275 7. (Debian and Ubuntu): As the *root* Linux account, enable the Evergreen site:
278 ------------------------------------------------------------------------------
279 a2dissite default # OPTIONAL: disable the default site (the "It Works" page)
281 ------------------------------------------------------------------------------
283 Configure OpenSRF for the Evergreen application
284 -----------------------------------------------
285 There are a number of example OpenSRF configuration files in `/openils/conf/`
286 that you can use as a template for your Evergreen installation. Issue the
287 following commands as the *opensrf* Linux account:
290 ------------------------------------------------------------------------------
291 cp -b /openils/conf/opensrf_core.xml.example /openils/conf/opensrf_core.xml
292 cp -b /openils/conf/opensrf.xml.example /openils/conf/opensrf.xml
293 ------------------------------------------------------------------------------
295 When you installed OpenSRF, you created four Jabber users on two
296 separate domains and edited the `opensrf_core.xml` file accordingly. Please
297 refer back to the OpenSRF README and, as the *opensrf* Linux account, edit the
298 Evergreen version of the `opensrf_core.xml` file using the same Jabber users
299 and domains as you used while installing and testing OpenSRF.
302 The `-b` flag tells the `cp` command to create a backup version of the
303 destination file. The backup version of the destination file has a tilde (`~`)
304 appended to the file name, so if you have forgotten the Jabber users and
305 domains, you can retrieve the settings from the backup version of the files.
307 `eg_db_config.pl`, described in the following section, sets the database
308 connection information in `opensrf.xml` for you.
310 Creating the Evergreen database
311 -------------------------------
313 By default, the `Makefile.install` prerequisite installer does not install
314 the PostgreSQL 9 database server required by every Evergreen system;
315 for production use, most libraries install the PostgreSQL database server on a
316 dedicated machine. You can install the packages required by Debian or Ubuntu Lucid
317 on the machine of your choice using the following commands as the *root*
320 .(Debian and Ubuntu Lucid) Installing PostgreSQL 9.1 server packages
322 ------------------------------------------------------------------------------
323 make -f Open-ILS/src/extras/Makefile.install install_pgsql_server_backport_debs_91
324 ------------------------------------------------------------------------------
326 .(Ubuntu Precise) Installing PostgreSQL 9.1 server packages
328 ------------------------------------------------------------------------------
329 make -f Open-ILS/src/extras/Makefile.install install_pgsql_server_debs_91
330 ------------------------------------------------------------------------------
332 You can install the packages required by Fedora on the machine of your choice
333 using the following commands as the *root* Linux account:
335 .(Fedora 16) Installing PostgreSQL server packages
337 ------------------------------------------------------------------------------
338 make -f Open-ILS/src/extras/Makefile.install install_fedora_pgsql_server
339 postgresql-setup initdb
340 ------------------------------------------------------------------------------
342 For a standalone PostgreSQL server, install the following Perl modules as the
343 *root* Linux account:
345 .(Debian / Ubuntu) Installing additional Perl modules on a standalone PostgreSQL 9 server
347 ------------------------------------------------------------------------------
348 aptitude install gcc libxml-libxml-perl libxml-libxslt-perl
351 cpan Library::CallNumber::LC
355 ------------------------------------------------------------------------------
357 .(Fedora 16) Installing additional Perl modules on a standalone PostgreSQL 9 server
359 ------------------------------------------------------------------------------
360 yum install gcc perl-XML-LibXML perl-XML-LibXSLT perl-Business-ISBN
361 cpan Library::CallNumber::LC
365 ------------------------------------------------------------------------------
367 You need to create a PostgreSQL superuser to create and access the database.
368 Issue the following command as the *postgres* Linux account to create a new
369 PostgreSQL superuser named `evergreen`. When prompted, enter the new user's
373 ------------------------------------------------------------------------------
374 createuser -s -P evergreen
375 ------------------------------------------------------------------------------
377 Once you have created the *evergreen* PostgreSQL account, you also need to
378 create the database and schema, and configure your configuration files to point
379 at the database server. Issue the following command as the *root* Linux account
380 from inside the Evergreen source directory, replacing <user>, <password>,
381 <hostname>, <port>, and <dbname> with the appropriate values for your
382 PostgreSQL database (where <user> and <password> are for the *evergreen*
383 PostgreSQL account you just created), and replace <admin-user> and <admin-pass>
384 with the values you want for the *egadmin* Evergreen administrator account:
387 ------------------------------------------------------------------------------
388 perl Open-ILS/src/support-scripts/eg_db_config.pl --update-config \
389 --service all --create-database --create-schema --create-offline \
390 --user <user> --password <password> --hostname <hostname> --port <port> \
391 --database <dbname> --admin-user <admin-user> --admin-pass <admin-pass>
392 ------------------------------------------------------------------------------
394 This creates the database and schema and configures all of the services in
395 your `/openils/conf/opensrf.xml` configuration file to point to that database.
396 It also creates the configuration files required by the Evergreen `cgi-bin`
397 administration scripts, and sets the user name and password for the *egadmin*
398 Evergreen administrator account to your requested values.
400 Creating the database on a remote server
401 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
402 In a production instance of Evergreen, your PostgreSQL server should be
403 installed on a dedicated server. For PostgreSQL 9.1 and later you should be
404 able to continue to use the --create-database flag on eg_db_config.pl, without
405 needing to install any server modules on your application machine. For
406 PostgreSQL 9.0 you can either:
408 * Install the PostgreSQL contrib modules on the machine on which you
409 are installing the Evergreen code, and use the --create-database
410 option from that machine, or
411 * Copy the `Open-ILS/src/sql/Pg/create_database.sql` script to your
412 PostgreSQL server and invoke it as the *postgres* Linux account:
415 ------------------------------------------------------------------------------
416 psql -vdb_name=<dbname> -vcontrib_dir=`pg_config --sharedir`/contrib -f create_database.sql
417 ------------------------------------------------------------------------------
419 Then you can issue the `eg_db_config.pl` command as above _without_ the
420 `--create-database` argument to create your schema and configure your
425 1. As the *root* Linux account, start the `memcached` and `ejabberd` services
426 (if they aren't already running):
429 ------------------------------------------------------------------------------
430 /etc/init.d/ejabberd start
431 /etc/init.d/memcached start
432 ------------------------------------------------------------------------------
434 2. As the *opensrf* Linux account, start Evergreen. The `-l` flag in the
435 following command is only necessary if you want to force Evergreen to treat the
436 hostname as `localhost`; if you configured `opensrf.xml` using the real
437 hostname of your machine as returned by `perl -ENet::Domain 'print
438 Net::Domain::hostfqdn() . "\n";'`, you should not use the `-l` flag.
441 ------------------------------------------------------------------------------
442 osrf_ctl.sh -l -a start_all
443 ------------------------------------------------------------------------------
445 ** If you receive the error message `bash: osrf_ctl.sh: command not found`,
446 then your environment variable `PATH` does not include the `/openils/bin`
447 directory; this should have been set in the *opensrf* Linux account's
448 `.bashrc` configuration file. To manually set the `PATH` variable, edit the
449 configuration file `~/.bashrc` as the *opensrf* Linux account and add the
453 ------------------------------------------------------------------------------
454 export PATH=$PATH:/openils/bin
455 ------------------------------------------------------------------------------
457 3. As the *opensrf* Linux account, generate the Web files needed by the staff
458 client and catalogue and update the organization unit proximity (you need to do
459 this the first time you start Evergreen, and after that each time you change
460 the library hierarchy in `config.cgi`):
463 ------------------------------------------------------------------------------
465 ------------------------------------------------------------------------------
467 4. As the *root* Linux account, restart the Apache Web server:
470 ------------------------------------------------------------------------------
471 /etc/init.d/apache2 restart
472 ------------------------------------------------------------------------------
474 If the Apache Web server was running when you started the OpenSRF services, you
475 might not be able to successfully log in to the OPAC or staff client until the
476 Apache Web server is restarted.
478 Testing connections to Evergreen
479 --------------------------------
481 Once you have installed and started Evergreen, test your connection to
482 Evergreen via `srfsh`. As the *opensrf* Linux account, issue the following
483 commands to start `srfsh` and try to log onto the Evergreen server using the
484 *egadmin* Evergreen administrator user name and password that you set using the
485 `eg_db_config.pl` command:
488 ------------------------------------------------------------------------------
490 srfsh% login <admin-user> <admin-pass>
491 ------------------------------------------------------------------------------
493 You should see a result like:
495 Received Data: "250bf1518c7527a03249858687714376"
496 ------------------------------------
497 Request Completed Successfully
498 Request Time in seconds: 0.045286
499 ------------------------------------
503 "textcode":"SUCCESS",
506 "stacktrace":"oils_auth.c:304",
508 "authtoken":"e5f9827cc0f93b503a1cc66bee6bdd1a",
514 ------------------------------------
515 Request Completed Successfully
516 Request Time in seconds: 1.336568
517 ------------------------------------
519 If this does not work, it's time to do some troubleshooting.
521 * As the *opensrf* Linux acccount, run the `settings-tester.pl` script to see
522 if it finds any system configuration problems. The script is found at
523 `Open-ILS/src/support-scripts/settings-tester.pl` in the Evergreen source
525 * Follow the steps in the http://evergreen-ils.org/dokuwiki/doku.php?id=troubleshooting:checking_for_errors[troubleshooting guide].
526 * If you have faithfully followed the entire set of installation steps
527 listed here, you are probably extremely close to a working system.
528 Gather your configuration files and log files and contact the
529 http://open-ils.org/listserv.php[Evergreen development mailing list]
530 for assistance before making any drastic changes to your system
536 Need help installing or using Evergreen? Join the mailing lists at
537 http://evergreen-ils.org/listserv.php or contact us on the Freenode
538 IRC network on the #evergreen channel.