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 * Fedora 15 comes with PostgreSQL 9, so no additional steps are required.
104 3. On Debian and Ubuntu, run `aptitude update` as the *root* Linux account to
105 retrieve the new packages from the backports repository.
106 4. Issue the following commands as the *root* Linux account to install
107 prerequisites using the `Makefile.install` prerequisite installer,
108 substituting `debian-squeeze`, `fedora15`, `ubuntu-lucid`, `centos`, or
109 `rhel` for <osname> below:
112 ------------------------------------------------------------------------------
113 make -f Open-ILS/src/extras/Makefile.install <osname>
114 ------------------------------------------------------------------------------
117 `centos` and `rhel` are less tested than the `debian`, `fedora`,
118 and `ubuntu` options. Your patches and suggestions for improvement are
121 5. Add the libdbi-libdbd libraries to the system dynamic library path by
122 issuing the following commands as the *root* Linux account:
126 ------------------------------------------------------------------------------
127 echo "/usr/local/lib/dbd" > /etc/ld.so.conf.d/eg.conf
129 ------------------------------------------------------------------------------
133 ------------------------------------------------------------------------------
134 echo "/usr/lib64/dbd" > /etc/ld.so.conf.d/eg.conf
136 ------------------------------------------------------------------------------
138 Configuration and compilation instructions
139 ------------------------------------------
141 For the time being, we are still installing everything in the `/openils/`
142 directory. From the Evergreen source directory, issue the following commands as
143 the *user* Linux account to configure and build Evergreen:
146 ------------------------------------------------------------------------------
147 ./configure --prefix=/openils --sysconfdir=/openils/conf
149 ------------------------------------------------------------------------------
151 Installation instructions
152 -------------------------
154 1. Once you have configured and compiled Evergreen, issue the following
155 command as the *root* Linux account to install Evergreen, build the server
156 portion of the staff client, and copy example configuration files to
158 Change the value of the `STAFF_CLIENT_STAMP_ID` variable to match the version
159 of the staff client that you will use to connect to the Evergreen server.
162 ------------------------------------------------------------------------------
163 make STAFF_CLIENT_STAMP_ID=rel_name install
164 ------------------------------------------------------------------------------
166 2. The server portion of the staff client expects `http://hostname/xul/server`
167 to resolve. Issue the following commands as the *root* Linux account to
168 create a symbolic link pointing to the `server` subdirectory of the server
169 portion of the staff client that we just built using the staff client ID
173 ------------------------------------------------------------------------------
174 cd /openils/var/web/xul
175 ln -sf rel_name/server server
176 ------------------------------------------------------------------------------
178 Change ownership of the Evergreen files
179 ---------------------------------------
181 All files in the `/openils/` directory and subdirectories must be owned by the
182 `opensrf` user. Issue the following command as the *root* Linux account to
183 change the ownership on the files:
186 ------------------------------------------------------------------------------
187 chown -R opensrf:opensrf /openils
188 ------------------------------------------------------------------------------
190 Configure the Apache Web server
191 -------------------------------
193 1. Use the example configuration files in `Open-ILS/examples/apache/` to
194 configure your Web server for the Evergreen catalog, staff client, Web
195 services, and administration interfaces. Issue the following commands as the
196 *root* Linux account:
200 ------------------------------------------------------------------------------
201 cp Open-ILS/examples/apache/eg.conf /etc/apache2/sites-available/
202 cp Open-ILS/examples/apache/eg_vhost.conf /etc/apache2/
203 cp Open-ILS/examples/apache/startup.pl /etc/apache2/
205 mkdir /etc/apache2/ssl
207 ------------------------------------------------------------------------------
211 ------------------------------------------------------------------------------
212 cp Open-ILS/examples/apache/eg.conf /etc/httpd/sites-available/
213 cp Open-ILS/examples/apache/eg_vhost.conf /etc/httpd/
214 cp Open-ILS/examples/apache/startup.pl /etc/httpd/
218 ------------------------------------------------------------------------------
220 2. The `openssl` command cuts a new SSL key for your Apache server. For a
221 production server, you should purchase a signed SSL certificate, but you can
222 just use a self-signed certificate and accept the warnings in the staff client
223 and browser during testing and development. Create an SSL key for the Apache
224 server by issuing the following command as the *root* Linux account:
227 ------------------------------------------------------------------------------
228 openssl req -new -x509 -days 365 -nodes -out server.crt -keyout server.key
229 ------------------------------------------------------------------------------
231 3. As the *root* Linux account, edit the `eg.conf` file that you copied into
233 a. Replace `Allow from 10.0.0.0/8` with `Allow from all` (to enable
234 access to the offline upload / execute interface from any workstation on
235 any network - note that you must secure this for a production instance)
236 4. Change the user for the Apache server.
237 * (Debian and Ubuntu): As the *root* Linux account, edit
238 `/etc/apache2/envvars`. Change `export APACHE_RUN_USER=www-data` to
239 `export APACHE_RUN_USER=opensrf`.
240 * (Fedora): As the *root* Linux account , edit `/etc/httpd/conf/httpd.conf`.
241 Change `User apache` to `User opensrf`.
242 5. Configure Apache with performance settings appropriate for Evergreen:
243 * (Debian and Ubuntu): As the *root* Linux account, edit
244 `/etc/apache2/apache2.conf`:
245 * (Fedora): As the *root* Linux account, edit `/etc/httpd/conf/httpd.conf`:
246 a. Change `KeepAliveTimeout` to `1`. Higher values reduce the chance of
247 a request timing out unexpectedly, but increase the risk of using up
248 all available Apache child processes.
249 b. 'Optional': Change `MaxKeepAliveRequests` to `100`
250 c. Update the prefork configuration section to suit your environment. The
251 following settings apply to a busy system:
254 ------------------------------------------------------------------------------
255 <IfModule mpm_prefork_module>
260 MaxRequestsPerChild 10000
262 ------------------------------------------------------------------------------
264 6. (Debian and Ubuntu): As the *root* Linux account, enable the Evergreen site:
267 ------------------------------------------------------------------------------
268 a2dissite default # OPTIONAL: disable the default site (the "It Works" page)
270 ------------------------------------------------------------------------------
272 Configure OpenSRF for the Evergreen application
273 -----------------------------------------------
274 There are a number of example OpenSRF configuration files in `/openils/conf/`
275 that you can use as a template for your Evergreen installation. Issue the
276 following commands as the *opensrf* Linux account:
279 ------------------------------------------------------------------------------
280 cp -b /openils/conf/opensrf_core.xml.example /openils/conf/opensrf_core.xml
281 cp -b /openils/conf/opensrf.xml.example /openils/conf/opensrf.xml
282 ------------------------------------------------------------------------------
284 When you installed OpenSRF, you created four Jabber users on two
285 separate domains and edited the `opensrf_core.xml` file accordingly. Please
286 refer back to the OpenSRF README and, as the *opensrf* Linux account, edit the
287 Evergreen version of the `opensrf_core.xml` file using the same Jabber users
288 and domains as you used while installing and testing OpenSRF.
291 The `-b` flag tells the `cp` command to create a backup version of the
292 destination file. The backup version of the destination file has a tilde (`~`)
293 appended to the file name, so if you have forgotten the Jabber users and
294 domains, you can retrieve the settings from the backup version of the files.
296 `eg_db_config.pl`, described in the following section, sets the database
297 connection information in `opensrf.xml` for you.
299 Creating the Evergreen database
300 -------------------------------
302 By default, the `Makefile.install` prerequisite installer does not install
303 the PostgreSQL 9 database server required by every Evergreen system;
304 for production use, most libraries install the PostgreSQL database server on a
305 dedicated machine. You can install the packages required by Debian or Ubuntu
306 on the machine of your choice using the following commands as the *root*
309 .(Debian / Ubuntu) Installing PostgreSQL 9.1 server packages
311 ------------------------------------------------------------------------------
312 make -f Open-ILS/src/extras/Makefile.install install_pgsql_server_debs_91
313 ------------------------------------------------------------------------------
315 You can install the packages required by Fedora on the machine of your choice
316 using the following commands as the *root* Linux account:
318 .(Fedora 15) Installing PostgreSQL 9.0 server packages
320 ------------------------------------------------------------------------------
321 make -f Open-ILS/src/extras/Makefile.install install_fedora_pgsql_server
322 ------------------------------------------------------------------------------
324 For a standalone PostgreSQL server, install the following Perl modules as the
325 *root* Linux account:
327 .(Debian / Ubuntu) Installing additional Perl modules on a standalone PostgreSQL 9 server
329 ------------------------------------------------------------------------------
330 aptitude install gcc libxml-libxml-perl libxml-libxslt-perl
333 cpan Library::CallNumber::LC
337 ------------------------------------------------------------------------------
339 .(Fedora 15) Installing additional Perl modules on a standalone PostgreSQL 9 server
341 ------------------------------------------------------------------------------
342 yum install gcc perl-XML-LibXML perl-XML-LibXSLT perl-Business-ISBN
344 cpan Library::CallNumber::LC
348 ------------------------------------------------------------------------------
350 You need to create a PostgreSQL superuser to create and access the database.
351 Issue the following command as the *postgres* Linux account to create a new
352 PostgreSQL superuser named `evergreen`. When prompted, enter the new user's
356 ------------------------------------------------------------------------------
357 createuser -s -P evergreen
358 ------------------------------------------------------------------------------
360 Once you have created the *evergreen* PostgreSQL account, you also need to
361 create the database and schema, and configure your configuration files to point
362 at the database server. Issue the following command as the *root* Linux account
363 from inside the Evergreen source directory, replacing <user>, <password>,
364 <hostname>, <port>, and <dbname> with the appropriate values for your
365 PostgreSQL database (where <user> and <password> are for the *evergreen*
366 PostgreSQL account you just created), and replace <admin-user> and <admin-pass>
367 with the values you want for the *egadmin* Evergreen administrator account:
370 ------------------------------------------------------------------------------
371 perl Open-ILS/src/support-scripts/eg_db_config.pl --update-config \
372 --service all --create-database --create-schema --create-offline \
373 --user <user> --password <password> --hostname <hostname> --port <port> \
374 --database <dbname> --admin-user <admin-user> --admin-pass <admin-pass>
375 ------------------------------------------------------------------------------
377 This creates the database and schema and configures all of the services in
378 your `/openils/conf/opensrf.xml` configuration file to point to that database.
379 It also creates the configuration files required by the Evergreen `cgi-bin`
380 administration scripts, and sets the user name and password for the *egadmin*
381 Evergreen administrator account to your requested values.
383 Creating the database on a remote server
384 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
385 In a production instance of Evergreen, your PostgreSQL server should be
386 installed on a dedicated server. For PostgreSQL 9.1 and later you should be
387 able to continue to use the --create-database flag on eg_db_config.pl, without
388 needing to install any server modules on your application machine. For
389 PostgreSQL 9.0 you can either:
391 * Install the PostgreSQL contrib modules on the machine on which you
392 are installing the Evergreen code, and use the --create-database
393 option from that machine, or
394 * Copy the `Open-ILS/src/sql/Pg/create_database.sql` script to your
395 PostgreSQL server and invoke it as the *postgres* Linux account:
398 ------------------------------------------------------------------------------
399 psql -vdb_name=<dbname> -vcontrib_dir=`pg_config --sharedir`/contrib -f create_database.sql
400 ------------------------------------------------------------------------------
402 Then you can issue the `eg_db_config.pl` command as above _without_ the
403 `--create-database` argument to create your schema and configure your
408 1. As the *root* Linux account, start the `memcached` and `ejabberd` services
409 (if they aren't already running):
412 ------------------------------------------------------------------------------
413 /etc/init.d/ejabberd start
414 /etc/init.d/memcached start
415 ------------------------------------------------------------------------------
417 2. As the *opensrf* Linux account, start Evergreen. The `-l` flag in the
418 following command is only necessary if you want to force Evergreen to treat the
419 hostname as `localhost`; if you configured `opensrf.xml` using the real
420 hostname of your machine as returned by `perl -ENet::Domain 'print
421 Net::Domain::hostfqdn() . "\n";'`, you should not use the `-l` flag.
424 ------------------------------------------------------------------------------
425 osrf_ctl.sh -l -a start_all
426 ------------------------------------------------------------------------------
428 ** If you receive the error message `bash: osrf_ctl.sh: command not found`,
429 then your environment variable `PATH` does not include the `/openils/bin`
430 directory; this should have been set in the *opensrf* Linux account's
431 `.bashrc` configuration file. To manually set the `PATH` variable, edit the
432 configuration file `~/.bashrc` as the *opensrf* Linux account and add the
436 ------------------------------------------------------------------------------
437 export PATH=$PATH:/openils/bin
438 ------------------------------------------------------------------------------
440 3. As the *opensrf* Linux account, generate the Web files needed by the staff
441 client and catalogue and update the organization unit proximity (you need to do
442 this the first time you start Evergreen, and after that each time you change
443 the library hierarchy in `config.cgi`):
446 ------------------------------------------------------------------------------
448 ------------------------------------------------------------------------------
450 4. As the *root* Linux account, restart the Apache Web server:
453 ------------------------------------------------------------------------------
454 /etc/init.d/apache2 restart
455 ------------------------------------------------------------------------------
457 If the Apache Web server was running when you started the OpenSRF services, you
458 might not be able to successfully log in to the OPAC or staff client until the
459 Apache Web server is restarted.
461 Testing connections to Evergreen
462 --------------------------------
464 Once you have installed and started Evergreen, test your connection to
465 Evergreen via `srfsh`. As the *opensrf* Linux account, issue the following
466 commands to start `srfsh` and try to log onto the Evergreen server using the
467 *egadmin* Evergreen administrator user name and password that you set using the
468 `eg_db_config.pl` command:
471 ------------------------------------------------------------------------------
473 srfsh% login <admin-user> <admin-pass>
474 ------------------------------------------------------------------------------
476 You should see a result like:
478 Received Data: "250bf1518c7527a03249858687714376"
479 ------------------------------------
480 Request Completed Successfully
481 Request Time in seconds: 0.045286
482 ------------------------------------
486 "textcode":"SUCCESS",
489 "stacktrace":"oils_auth.c:304",
491 "authtoken":"e5f9827cc0f93b503a1cc66bee6bdd1a",
497 ------------------------------------
498 Request Completed Successfully
499 Request Time in seconds: 1.336568
500 ------------------------------------
502 If this does not work, it's time to do some troubleshooting.
504 * As the *opensrf* Linux acccount, run the `settings-tester.pl` script to see
505 if it finds any system configuration problems. The script is found at
506 `Open-ILS/src/support-scripts/settings-tester.pl` in the Evergreen source
508 * Follow the steps in the http://evergreen-ils.org/dokuwiki/doku.php?id=troubleshooting:checking_for_errors[troubleshooting guide].
509 * If you have faithfully followed the entire set of installation steps
510 listed here, you are probably extremely close to a working system.
511 Gather your configuration files and log files and contact the
512 http://open-ils.org/listserv.php[Evergreen development mailing list]
513 for assistance before making any drastic changes to your system
519 Need help installing or using Evergreen? Join the mailing lists at
520 http://evergreen-ils.org/listserv.php or contact us on the Freenode
521 IRC network on the #evergreen channel.