From 558f792d98a9b68e372f0bbdd7283b4691800ab2 Mon Sep 17 00:00:00 2001 From: Lebbeous Fogle-Weekley Date: Thu, 16 May 2013 16:27:51 -0400 Subject: [PATCH] ChangeLog, version numbers, README for 2.2.9 release Signed-off-by: Lebbeous Fogle-Weekley --- ChangeLog | 355 ++++++++++++- Open-ILS/src/perlmods/lib/OpenILS.pm | 2 +- Open-ILS/src/perlmods/lib/OpenILS/Application.pm | 2 +- Open-ILS/src/sql/Pg/002.schema.config.sql | 1 + .../staff_client/chrome/content/main/about.html | 2 +- .../xul/staff_client/defaults/preferences/prefs.js | 2 +- README | 550 ++++++++++++++++++++- configure.ac | 4 +- 8 files changed, 908 insertions(+), 10 deletions(-) mode change 120000 => 100644 README diff --git a/ChangeLog b/ChangeLog index 1f72b2c73e..7e8373c0ca 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,352 @@ -Evergreen doesn't keep a GNU-style ChangeLog except in release tarballs. -Those seeking a change log are encouraged to run 'git log -v', or read -it online at: http://git.evergreen-ils.org/?p=Evergreen.git;a=log +commit 5a63b7f91bbe1c59ad94fafd04c1c336c2be6a94 +Author: Lebbeous Fogle-Weekley +Date: Thu May 16 14:52:01 2013 -0400 + + Translations import / newpot for 2.2.9 + + Signed-off-by: Lebbeous Fogle-Weekley + +5 5 build/i18n/po/cat.properties/en-GB.po +6 4 build/i18n/po/circ.properties/cs-CZ.po +17 13 build/i18n/po/circ.properties/en-GB.po +6 4 build/i18n/po/circ.properties/hy-AM.po +8 8 build/i18n/po/conify.js/cs-CZ.po +9 9 build/i18n/po/conify.js/en-GB.po +8 8 build/i18n/po/conify.js/hy-AM.po +4 4 build/i18n/po/db.seed/cs-CZ.po +8 8 build/i18n/po/db.seed/en-GB.po +5 5 build/i18n/po/db.seed/hy-AM.po +32 32 build/i18n/po/fm_IDL.dtd/cs-CZ.po +6 6 build/i18n/po/fm_IDL.dtd/en-GB.po +1020 1020 build/i18n/po/fm_IDL.dtd/fm_IDL.dtd.pot +24 24 build/i18n/po/fm_IDL.dtd/hy-AM.po +7 4 build/i18n/po/ils_events.xml/cs-CZ.po +18 11 build/i18n/po/ils_events.xml/en-GB.po +7 4 build/i18n/po/ils_events.xml/hy-AM.po +41 41 build/i18n/po/lang.dtd/cs-CZ.po +8 5 build/i18n/po/lang.dtd/en-GB.po +42 42 build/i18n/po/lang.dtd/hy-AM.po +4 4 build/i18n/po/offline.properties/cs-CZ.po +17 17 build/i18n/po/offline.properties/en-GB.po +4 4 build/i18n/po/offline.properties/hy-AM.po +16 4 build/i18n/po/opac.dtd/en-GB.po +7 7 build/i18n/po/patron.properties/en-GB.po +4 4 build/i18n/po/patron.properties/hy-AM.po +5 5 build/i18n/po/reservation.js/en-GB.po +6 6 build/i18n/po/serial.properties/cs-CZ.po +7 7 build/i18n/po/serial.properties/en-GB.po +6 6 build/i18n/po/serial.properties/hy-AM.po +19 19 build/i18n/po/tpac/tpac.pot + +commit bc46b75cc56674e264f8005cd160f68ddf3326ea +Author: Mike Rylander +Date: Fri Apr 19 16:14:13 2013 -0400 + + Correct subfield format for authority lookup + + The Authority Control Set code expects the format of subfields + that it will be used to build a MARC.Field object to be of the + form: [[code,value],...] This commit makes that true. + + Additionally, dojo.filter over a list of lists can cause the + nested array set to be flattened. So, instead, we loop directly. + + Signed-off-by: Mike Rylander + Signed-off-by: Lebbeous Fogle-Weekley + +10 5 Open-ILS/web/js/dojo/openils/AuthorityControlSet.js +1 2 Open-ILS/xul/staff_client/server/cat/marcedit.js + +commit f32375f6d719048329e631c621138db1335f3537 +Author: Bill Erickson +Date: Thu May 16 09:11:50 2013 -0400 + + Repair faulty MARC editor authority validation + + Repair how the JS inspects the results of + open-ils.search.authority.simple_heading.from_xml.batch.atomic, which is + used to look up matches for authority validation. It returns a more + complex structure in the brave new world of authority control sets. + + Signed-off-by: Bill Erickson + Signed-off-by: Mike Rylander + Signed-off-by: Lebbeous Fogle-Weekley + +19 2 Open-ILS/xul/staff_client/server/cat/marcedit.js + +commit 815f5e2dfd49019b9962d5a9e28eda3677f8e8dd +Author: Dan Wells +Date: Wed Apr 3 15:30:40 2013 -0400 + + stamping upgrade for field 264 reporter view + + Signed-off-by: Dan Wells + Signed-off-by: Ben Shum + Signed-off-by: Lebbeous Fogle-Weekley + +1 1 Open-ILS/src/sql/Pg/002.schema.config.sql +37 0 Open-ILS/src/sql/Pg/upgrade/0788.schema.reporter_264_pubinfo.sql +0 37 Open-ILS/src/sql/Pg/upgrade/XXXX.schema.reporter_264_pubinfo.sql + create mode 100644 Open-ILS/src/sql/Pg/upgrade/0788.schema.reporter_264_pubinfo.sql + delete mode 100644 Open-ILS/src/sql/Pg/upgrade/XXXX.schema.reporter_264_pubinfo.sql + +commit 1b7a2d1d14838f2a196d09cb1fa2bbcdbc044b03 +Author: Ben Shum +Date: Thu Jan 31 12:20:20 2013 -0500 + + LP1071505 - Add 264 RDA tag to reporter views + + Some reports draw from reporter.materialized_simple_record table and these + were not made aware of the new 264 tag which contains publisher related + information. + + Change the view for reporter.old_super_simple_record, which feeds into the + other reporter table. + + The included upgrade SQL will update this view and then update the table using + the new view. + + Signed-off-by: Ben Shum + Signed-off-by: Dan Wells + Signed-off-by: Lebbeous Fogle-Weekley + +2 2 Open-ILS/src/sql/Pg/reporter-schema.sql +37 0 Open-ILS/src/sql/Pg/upgrade/XXXX.schema.reporter_264_pubinfo.sql + create mode 100644 Open-ILS/src/sql/Pg/upgrade/XXXX.schema.reporter_264_pubinfo.sql + +commit b610f9ab1ae0b14c2927a27e5537a8ce9eecb755 +Author: Ben Shum +Date: Wed Oct 10 17:00:54 2012 -0400 + + LP1071505 - Add 264 RDA tag to TPAC pubinfo display + + Prior to this, TPAC only retrieved the 260 tag for publication info. Allow for + the possibility that the 264 tag might exist and contain relevant information. + Special note: the 264 tag must have a second indicator value of 1 to be meant + for publication statement. + + Also, this only picks out the first 260 or 264 tags in any given bib record. + + Approach inspired by Dan Scott's approach taken for finding edition statements. + + Signed-off-by: Ben Shum + Signed-off-by: Dan Wells + + Conflicts: + Open-ILS/src/templates/opac/parts/misc_util.tt2 + + Signed-off-by: Lebbeous Fogle-Weekley + +9 3 Open-ILS/src/templates/opac/parts/misc_util.tt2 + +commit 879c459db9d50a5e7b6e41061a996bd04e3429a8 +Author: Dan Scott +Date: Wed Sep 12 12:59:53 2012 -0400 + + TPAC: Results - don't show the pubdate if we're showing full pubinfo + + In the "show few details" mode, we show just the pubdate; in the "show + full details" mode, we're showing the full pubinfo and therefore do not + need to show the stubby pubdate. + + Signed-off-by: Dan Scott + Signed-off-by: Lebbeous Fogle-Weekley + +5 0 Open-ILS/src/templates/opac/parts/result/table.tt2 + +commit a0ea0311956079a4f56b8342f5841df3795f3890 +Author: Dan Scott +Date: Wed Sep 12 11:50:03 2012 -0400 + + TPAC: Display full publication info + + In both the results table and record summary, we were failing to display + the place of publication - which is critical information for people + trying to track down the right edition or constructing a bibliography. + + Grab the place of publication, and then reconstruct 260abc (avoiding + another XPath iteration and giving ourselves the ability to enhance the + schema.org microdata at the same time). + + Signed-off-by: Dan Scott + Signed-off-by: Lebbeous Fogle-Weekley + +9 0 Open-ILS/src/templates/opac/parts/misc_util.tt2 +9 6 Open-ILS/src/templates/opac/parts/record/summary.tt2 +2 4 Open-ILS/src/templates/opac/parts/result/table.tt2 + +commit af1a7ccf5a82e2fbf03f4a8e366502148afb4ef1 +Author: Mike Rylander +Date: Tue Apr 30 11:26:00 2013 -0400 + + Make sure the "running" indicator goes away + + Signed-off-by: Mike Rylander + Signed-off-by: Jason Etheridge + Signed-off-by: Lebbeous Fogle-Weekley + +8 1 Open-ILS/src/perlmods/lib/OpenILS/Application/Search/Biblio.pm + +commit 7b4849c92c6bab2a7dc3615390efc323c9a50712 +Author: Mike Rylander +Date: Fri Apr 26 11:28:38 2013 -0400 + + Add a $cache_timeout-based backstop for infinite loops + + Signed-off-by: Mike Rylander + Signed-off-by: Jason Etheridge + Signed-off-by: Lebbeous Fogle-Weekley + +2 1 Open-ILS/src/perlmods/lib/OpenILS/Application/Search/Biblio.pm + +commit 447d859b0f391d041300d35002ecd7a36a595233 +Author: Mike Rylander +Date: Fri Apr 26 10:49:17 2013 -0400 + + "Queue Compression" -- let one do the work for all identical, concurrent searches + + Signed-off-by: Mike Rylander + Signed-off-by: Jason Etheridge + Signed-off-by: Lebbeous Fogle-Weekley + +17 0 Open-ILS/src/perlmods/lib/OpenILS/Application/Search/Biblio.pm + +commit 7107d94b28dd5f70dc64fb6876dcebe609454170 +Author: Lebbeous Fogle-Weekley +Date: Mon May 6 14:15:18 2013 -0400 + + Serials: MFHD::get_compressed_holdings() can reach infinite loop + + Even controlled serials holdings involve the internal creation of MFHD + fields, upon which caculations are performed for such purposes as the + display of holdings summaries in the OPAC. + + There are too many ways that incorrect MFHD (or MFHD that our code just + can't yet handle) can lead our MFHD routines to crash. We can't address + all these possibilities in a single bug fix. But we can avoid this + infinite loop. + + A subroutine within open-ils.serial (_summarize_contents()) relies on + MFHD::get_compressed_holdings(). When the latter went into an infinite + loop the result would be an open-il.serial drone process consuming CPU + time indefinitely and, depending on the data that provoked the loop, + potentially writing repeating messages to stderr indefinitely. + + End users will still see the item receiving fail in these cases, and be + obliged to work around the issue as before until more robust + holdings summarization code can be written, but at least the overall + condition of the running Evergreen system won't be affected, and there + will be better information in the error logs. + + Signed-off-by: Lebbeous Fogle-Weekley + Signed-off-by: Remington Steed + Signed-off-by: Dan Wells + +22 5 Open-ILS/src/perlmods/lib/OpenILS/Application/Serial.pm +15 3 Open-ILS/src/perlmods/lib/OpenILS/Utils/MFHD.pm + +commit 188e0bf1d5328b7a69eb70b50a2cabd5510f9a7f +Author: Lebbeous Fogle-Weekley +Date: Mon May 6 14:13:13 2013 -0400 + + Serials: Test method to identify holdings that lead to summarization bugs + + This adds a simple test method that allows testing of problem holdings. + See the next commit. + + Signed-off-by: Lebbeous Fogle-Weekley + Signed-off-by: Remington Steed + Signed-off-by: Dan Wells + +31 0 Open-ILS/src/perlmods/lib/OpenILS/Application/Serial.pm + +commit 0400e3f88e490b78ee116c0924e9a3cba73423d0 +Author: Bill Erickson +Date: Fri Mar 29 09:41:44 2013 -0400 + + LP1076411 Return updated circ object from checkin + + Retrieve an updated copy of the circulation object to return to the + caller during checkin. This ensures the data in the circ object, in + particular date fields, are consistent with the database. + + Signed-off-by: Bill Erickson + Signed-off-by: Ben Shum + +11 5 Open-ILS/src/perlmods/lib/OpenILS/Application/Circ/Circulate.pm + +commit 7eed14fed8e2a37cb6b360015aab7a99360e897b +Author: Remington Steed +Date: Thu Mar 14 14:37:17 2013 -0400 + + Add accepting_usr to IDL to fix reporter field + + In the reporter interface, the view 'Payments: Brick-and-mortar' is + missing the 'Accepting User' field, which is present in the similar view + 'Payments: Desk'. This field is already present in the database view and + is simply missing from the IDL. Since it is needed for certain kinds of + reports, this commit adds the missing IDL fields. It also adds the + missing 'reporter:datatype' to an existing instance of the IDL field. + + Signed-off-by: Remington Steed + Signed-off-by: Ben Shum + +3 1 Open-ILS/examples/fm_IDL.xml + +commit 2797b1974c4f0877cc31e4fd9e5766c9891b852f +Author: Kyle Tomita +Date: Tue Apr 9 13:51:14 2013 -0700 + + LP1104823 - OPAC search results "Limit to available items" toggles + off "Show more details" + + Added a hidden input to the form when "Show more details" is selected + so that when the form is reloaded, "Show more details" will be still + selected. + + Signed-off-by: Kyle Tomita + Signed-off-by: Ben Shum + +3 0 Open-ILS/src/templates/opac/results.tt2 + +commit 607028ba527b037cb85c89832678c530292ee174 +Author: Dan Scott +Date: Fri Apr 5 01:53:55 2013 -0400 + + Prevent compiler warning about unused numtype var + + There was a dangling variable left around that was making noise in the + compiler. Credit to Jeff Godin for the heads-up. + + Signed-off-by: Dan Scott + Signed-off-by: Mike Rylander + +1 2 Open-ILS/src/c-apps/oils_sql.c + +commit c7c13b2fb698bb8fb36c8041e05f4711ef0dc4c1 +Author: Mike Rylander +Date: Fri Apr 5 01:52:16 2013 -0400 + + Address SQL injection vulnerability in SQL ORM layer + + If the user-supplied value and the db column are both numbers + (jsonObject->type == JSON_NUMBER, get_primitive(field) == "number") then + don't quote. Otherwise, quote. + + Signed-off-by: Mike Rylander + Signed-off-by: Dan Scott + Signed-off-by: Mike Rylander + +4 18 Open-ILS/src/c-apps/oils_sql.c + +commit fa462835c2c605fcc0fbe742a1ca1ba3bf18160d +Author: Lebbeous Fogle-Weekley +Date: Tue Apr 16 22:24:07 2013 -0400 + + 2.2.7-2.2.8 database upgrade script + + Signed-off-by: Lebbeous Fogle-Weekley + Signed-off-by: Bill Erickson + +124 0 Open-ILS/src/sql/Pg/version-upgrade/2.2.7-2.2.8-upgrade-db.sql + create mode 100644 Open-ILS/src/sql/Pg/version-upgrade/2.2.7-2.2.8-upgrade-db.sql diff --git a/Open-ILS/src/perlmods/lib/OpenILS.pm b/Open-ILS/src/perlmods/lib/OpenILS.pm index ead71e2e45..46fedbc385 100644 --- a/Open-ILS/src/perlmods/lib/OpenILS.pm +++ b/Open-ILS/src/perlmods/lib/OpenILS.pm @@ -6,6 +6,6 @@ OpenILS - Client and server support for the Evergreen open source library system =cut -our $VERSION = '2.00'; +our $VERSION = '2.0209'; 1; diff --git a/Open-ILS/src/perlmods/lib/OpenILS/Application.pm b/Open-ILS/src/perlmods/lib/OpenILS/Application.pm index 7e36e0e9d4..926d015af4 100644 --- a/Open-ILS/src/perlmods/lib/OpenILS/Application.pm +++ b/Open-ILS/src/perlmods/lib/OpenILS/Application.pm @@ -6,7 +6,7 @@ use base qw/OpenSRF::Application/; sub ils_version { # version format is "x-y-z", for example "2-0-0" for Evergreen 2.0.0 # For branches, format is "x-y" - return "2-2"; + return "2-2-9"; } __PACKAGE__->register_method( diff --git a/Open-ILS/src/sql/Pg/002.schema.config.sql b/Open-ILS/src/sql/Pg/002.schema.config.sql index dedbb43aaa..29c89ba76b 100644 --- a/Open-ILS/src/sql/Pg/002.schema.config.sql +++ b/Open-ILS/src/sql/Pg/002.schema.config.sql @@ -88,6 +88,7 @@ CREATE TRIGGER no_overlapping_deps FOR EACH ROW EXECUTE PROCEDURE evergreen.array_overlap_check ('deprecates'); INSERT INTO config.upgrade_log (version, applied_to) VALUES ('0788', :eg_version); -- bshum/dbwells +INSERT INTO config.upgrade_log (version, applied_to) VALUES ('2.2.9', :eg_version); CREATE TABLE config.bib_source ( id SERIAL PRIMARY KEY, diff --git a/Open-ILS/xul/staff_client/chrome/content/main/about.html b/Open-ILS/xul/staff_client/chrome/content/main/about.html index f157ac1687..c84e3c33b9 100644 --- a/Open-ILS/xul/staff_client/chrome/content/main/about.html +++ b/Open-ILS/xul/staff_client/chrome/content/main/about.html @@ -1,7 +1,7 @@

Evergreen

Target Server ID:

-

http://git.evergreen-ils.org/Evergreen.git?h=refs/heads/rel_2_2

+

http://git.evergreen-ils.org/Evergreen.git?h=refs/heads/rel_2_2_9

What is Evergreen?

diff --git a/Open-ILS/xul/staff_client/defaults/preferences/prefs.js b/Open-ILS/xul/staff_client/defaults/preferences/prefs.js index 97dbf01f77..6afbc33031 100644 --- a/Open-ILS/xul/staff_client/defaults/preferences/prefs.js +++ b/Open-ILS/xul/staff_client/defaults/preferences/prefs.js @@ -11,7 +11,7 @@ pref("toolkit.singletonWindowType", "eg_main"); pref("open-ils.enable_join_tabs", true); // We'll use this one to help brand some build information into the client, and rely on subversion keywords -pref("open-ils.repository.headURL","http://git.evergreen-ils.org/Evergreen.git?h=refs/heads/rel_2_2"); +pref("open-ils.repository.headURL","http://git.evergreen-ils.org/Evergreen.git?h=refs/heads/rel_2_2_9"); pref("open-ils.repository.author","$Author$"); pref("open-ils.repository.revision","$Revision$"); pref("open-ils.repository.date","$Date$"); diff --git a/README b/README deleted file mode 120000 index b57451acb4..0000000000 --- a/README +++ /dev/null @@ -1 +0,0 @@ -docs/installation/server_installation.txt \ No newline at end of file diff --git a/README b/README new file mode 100644 index 0000000000..066847f1ce --- /dev/null +++ b/README @@ -0,0 +1,549 @@ +Installing the Evergreen server +=============================== +:toc: +:numbered: + +Preamble: referenced user accounts +---------------------------------- + +In subsequent sections, we will refer to a number of different accounts, as +follows: + + * Linux user accounts: + ** The *user* Linux account is the account that you use to log onto the + Linux system as a regular user. + ** The *root* Linux account is an account that has system administrator + privileges. On Debian and Fedora you can switch to this account from + your *user* account by issuing the `su -` command and entering the + password for the *root* account when prompted. On Ubuntu you can switch + to this account from your *user* account using the `sudo su -` command + and entering the password for your *user* account when prompted. + ** The *opensrf* Linux account is an account that you create when installing + OpenSRF. You can switch to this account from the *root* account by + issuing the `su - opensrf` command. + ** The *postgres* Linux account is created automatically when you install + the PostgreSQL database server. You can switch to this account from the + *root* account by issuing the `su - postgres` command. + * PostgreSQL user accounts: + ** The *evergreen* PostgreSQL account is a superuser account that you will + create to connect to the PostgreSQL database server. + * Evergreen administrator account: + ** The *egadmin* Evergreen account is an administrator account for + Evergreen that you will use to test connectivity and configure your + Evergreen instance. + +Preamble: developer instructions +-------------------------------- + +[NOTE] +Skip this section if you are using an official release tarball downloaded +from http://evergreen-ils.org/downloads + +Developers working directly with the source code from the Git repository, +rather than an official release tarball, must install some extra packages +and perform one step before they can proceed with the `./configure` step. + +As the *root* Linux account, install the following packages: + + * autoconf + * automake + * libtool + +As the *user* Linux account, issue the following command in the Evergreen +source directory to generate the configure script and Makefiles: + +[source, bash] +------------------------------------------------------------------------------ +autoreconf -i +------------------------------------------------------------------------------ + +After running `make install`, developers also need to install the Dojo Toolkit +set of JavaScript libraries. The appropriate version of Dojo is included +in Evergreen release tarballs. Developers should install the Dojo 1.3.3 +version of Dojo by issuing the following commands as the *opensrf* Linux +account: + +[source, bash] +------------------------------------------------------------------------------ +wget http://download.dojotoolkit.org/release-1.3.3/dojo-release-1.3.3.tar.gz +tar -C /openils/var/web/js -xzf dojo-release-1.3.3.tar.gz +cp -r /openils/var/web/js/dojo-release-1.3.3/* /openils/var/web/js/dojo/. +------------------------------------------------------------------------------ + +Installing prerequisites +------------------------ + +Evergreen has a number of prerequisite packages that must be installed +before you can successfully configure, compile, and install Evergreen. + +1. Begin by installing the most recent version of OpenSRF (2.1 or later). + You can download OpenSRF releases from http://evergreen-ils.org/opensrf.php +2. On many distributions, it is necessary to install PostgreSQL 9 from external + repositories. ++ + * On Debian Squeeze, open `/etc/apt/sources.list` in a text editor as the + *root* Linux account and add the following line: ++ +[source, bash] +------------------------------------------------------------------------------ +deb http://backports.debian.org/debian-backports squeeze-backports main contrib +------------------------------------------------------------------------------ ++ + * On Ubuntu Lucid, you can use a PPA (personal package archive), which are + package sources hosted on Launchpad. The one most commonly used by Evergreen + Community members is maintained by Martin Pitt, who also maintains the + official PostgreSQL packages for Ubuntu. As the *root* Linux account, issue + the following commands to add the PPA source: ++ +[source, bash] +------------------------------------------------------------------------------ +apt-get install python-software-properties +add-apt-repository ppa:pitti/postgresql +------------------------------------------------------------------------------ ++ + * Ubuntu Precise comes with PostgreSQL 9, so no additional steps are required. ++ + * Fedora comes with PostgreSQL 9, so no additional steps are required. ++ +3. On Debian and Ubuntu, run `aptitude update` as the *root* Linux account to + retrieve the new packages from the backports repository. +4. Issue the following commands as the *root* Linux account to install + prerequisites using the `Makefile.install` prerequisite installer, + substituting `debian-squeeze`, `fedora`, `ubuntu-lucid`, or + `ubuntu-precise` for below: ++ +[source, bash] +------------------------------------------------------------------------------ +make -f Open-ILS/src/extras/Makefile.install +------------------------------------------------------------------------------ ++ +5. Add the libdbi-libdbd libraries to the system dynamic library path by + issuing the following commands as the *root* Linux account: ++ +[NOTE] +You should skip this step if installing on Ubuntu Precise. The ubuntu-precise +target uses libdbd-pgsql from packages. ++ +.Debian / Ubuntu Lucid +[source, bash] +------------------------------------------------------------------------------ +echo "/usr/local/lib/dbd" > /etc/ld.so.conf.d/eg.conf +ldconfig +------------------------------------------------------------------------------ ++ +.Fedora +[source, bash] +------------------------------------------------------------------------------ +echo "/usr/lib64/dbd" > /etc/ld.so.conf.d/eg.conf +ldconfig +------------------------------------------------------------------------------ + +Configuration and compilation instructions +------------------------------------------ + +For the time being, we are still installing everything in the `/openils/` +directory. From the Evergreen source directory, issue the following commands as +the *user* Linux account to configure and build Evergreen: + +[source, bash] +------------------------------------------------------------------------------ +./configure --prefix=/openils --sysconfdir=/openils/conf +make +------------------------------------------------------------------------------ + +Installation instructions +------------------------- + +1. Once you have configured and compiled Evergreen, issue the following + command as the *root* Linux account to install Evergreen, build the server + portion of the staff client, and copy example configuration files to + `/openils/conf`. + Change the value of the `STAFF_CLIENT_STAMP_ID` variable to match the version + of the staff client that you will use to connect to the Evergreen server. ++ +[source, bash] +------------------------------------------------------------------------------ +make STAFF_CLIENT_STAMP_ID=rel_2_2_9 install +------------------------------------------------------------------------------ ++ +2. The server portion of the staff client expects `http://hostname/xul/server` + to resolve. Issue the following commands as the *root* Linux account to + create a symbolic link pointing to the `server` subdirectory of the server + portion of the staff client that we just built using the staff client ID + 'rel_name': ++ +[source, bash] +------------------------------------------------------------------------------ +cd /openils/var/web/xul +ln -sf rel_name/server server +------------------------------------------------------------------------------ + +Change ownership of the Evergreen files +--------------------------------------- + +All files in the `/openils/` directory and subdirectories must be owned by the +`opensrf` user. Issue the following command as the *root* Linux account to +change the ownership on the files: + +[source, bash] +------------------------------------------------------------------------------ +chown -R opensrf:opensrf /openils +------------------------------------------------------------------------------ + +Configure the Apache Web server +------------------------------- + +1. Use the example configuration files in `Open-ILS/examples/apache/` to +configure your Web server for the Evergreen catalog, staff client, Web +services, and administration interfaces. Issue the following commands as the +*root* Linux account: ++ +.Debian and Ubuntu +[source,bash] +------------------------------------------------------------------------------ +cp Open-ILS/examples/apache/eg.conf /etc/apache2/sites-available/ +cp Open-ILS/examples/apache/eg_vhost.conf /etc/apache2/ +cp Open-ILS/examples/apache/startup.pl /etc/apache2/ +# Now set up SSL +mkdir /etc/apache2/ssl +cd /etc/apache2/ssl +------------------------------------------------------------------------------ ++ +.Fedora +[source,bash] +------------------------------------------------------------------------------ +cp Open-ILS/examples/apache/eg.conf /etc/httpd/conf.d/ +cp Open-ILS/examples/apache/eg_vhost.conf /etc/httpd/ +cp Open-ILS/examples/apache/startup.pl /etc/httpd/ +# Now set up SSL +mkdir /etc/httpd/ssl +cd /etc/httpd/ssl +------------------------------------------------------------------------------ ++ +2. The `openssl` command cuts a new SSL key for your Apache server. For a +production server, you should purchase a signed SSL certificate, but you can +just use a self-signed certificate and accept the warnings in the staff client +and browser during testing and development. Create an SSL key for the Apache +server by issuing the following command as the *root* Linux account: ++ +[source,bash] +------------------------------------------------------------------------------ +openssl req -new -x509 -days 365 -nodes -out server.crt -keyout server.key +------------------------------------------------------------------------------ ++ +3. As the *root* Linux account, edit the `eg.conf` file that you copied into +place. + a. Replace `Allow from 10.0.0.0/8` with `Allow from all` (to enable + access to the offline upload / execute interface from any workstation on + any network - note that you must secure this for a production instance) + b. (Fedora): Change references from the non-existent `/etc/apache2/` directory + to `/etc/httpd/`. +4. Change the user for the Apache server. + * (Debian and Ubuntu): As the *root* Linux account, edit + `/etc/apache2/envvars`. Change `export APACHE_RUN_USER=www-data` to + `export APACHE_RUN_USER=opensrf`. + * (Fedora): As the *root* Linux account , edit `/etc/httpd/conf/httpd.conf`. + Change `User apache` to `User opensrf`. +5. Configure Apache with performance settings appropriate for Evergreen: + * (Debian and Ubuntu): As the *root* Linux account, edit + `/etc/apache2/apache2.conf`: + * (Fedora): As the *root* Linux account, edit `/etc/httpd/conf/httpd.conf`: + a. Change `KeepAliveTimeout` to `1`. Higher values reduce the chance of + a request timing out unexpectedly, but increase the risk of using up + all available Apache child processes. + b. 'Optional': Change `MaxKeepAliveRequests` to `100` + c. Update the prefork configuration section to suit your environment. The + following settings apply to a busy system: ++ +[source,bash] +------------------------------------------------------------------------------ + + StartServers 20 + MinSpareServers 5 + MaxSpareServers 15 + MaxClients 150 + MaxRequestsPerChild 10000 + +------------------------------------------------------------------------------ ++ +6. (Fedora): As the *root* Linux account, edit the `/etc/httpd/eg_vhost.conf` + file to change references from the non-existent `/etc/apache2/` directory + to `/etc/httpd/`. +7. (Debian and Ubuntu): As the *root* Linux account, enable the Evergreen site: ++ +[source,bash] +------------------------------------------------------------------------------ +a2dissite default # OPTIONAL: disable the default site (the "It Works" page) +a2ensite eg.conf +------------------------------------------------------------------------------ + +Configure OpenSRF for the Evergreen application +----------------------------------------------- +There are a number of example OpenSRF configuration files in `/openils/conf/` +that you can use as a template for your Evergreen installation. Issue the +following commands as the *opensrf* Linux account: + +[source, bash] +------------------------------------------------------------------------------ +cp -b /openils/conf/opensrf_core.xml.example /openils/conf/opensrf_core.xml +cp -b /openils/conf/opensrf.xml.example /openils/conf/opensrf.xml +------------------------------------------------------------------------------ + +When you installed OpenSRF, you created four Jabber users on two +separate domains and edited the `opensrf_core.xml` file accordingly. Please +refer back to the OpenSRF README and, as the *opensrf* Linux account, edit the +Evergreen version of the `opensrf_core.xml` file using the same Jabber users +and domains as you used while installing and testing OpenSRF. + +[NOTE] +The `-b` flag tells the `cp` command to create a backup version of the +destination file. The backup version of the destination file has a tilde (`~`) +appended to the file name, so if you have forgotten the Jabber users and +domains, you can retrieve the settings from the backup version of the files. + +`eg_db_config.pl`, described in the following section, sets the database +connection information in `opensrf.xml` for you. + +Creating the Evergreen database +------------------------------- + +By default, the `Makefile.install` prerequisite installer does not install +the PostgreSQL 9 database server required by every Evergreen system; +for production use, most libraries install the PostgreSQL database server on a +dedicated machine. You can install the packages required by Debian or Ubuntu Lucid +on the machine of your choice using the following commands as the *root* +Linux account: + +.(Debian and Ubuntu Lucid) Installing PostgreSQL 9.1 server packages +[source, bash] +------------------------------------------------------------------------------ +make -f Open-ILS/src/extras/Makefile.install install_pgsql_server_backport_debs_91 +------------------------------------------------------------------------------ + +.(Ubuntu Precise) Installing PostgreSQL 9.1 server packages +[source, bash] +------------------------------------------------------------------------------ +make -f Open-ILS/src/extras/Makefile.install install_pgsql_server_debs_91 +------------------------------------------------------------------------------ + +You can install the packages required by Fedora on the machine of your choice +using the following commands as the *root* Linux account: + +.(Fedora) Installing PostgreSQL server packages +[source, bash] +------------------------------------------------------------------------------ +make -f Open-ILS/src/extras/Makefile.install install_fedora_pgsql_server +postgresql-setup initdb +------------------------------------------------------------------------------ + +For a standalone PostgreSQL server, install the following Perl modules as the +*root* Linux account: + +.(Debian / Ubuntu) Installing additional Perl modules on a standalone PostgreSQL 9 server +[source, bash] +------------------------------------------------------------------------------ +aptitude install gcc libxml-libxml-perl libxml-libxslt-perl +cpan Business::ISBN +cpan JSON::XS +cpan Library::CallNumber::LC +cpan MARC::Record +cpan MARC::File::XML +cpan UUID::Tiny +------------------------------------------------------------------------------ + +.(Fedora) Installing additional Perl modules on a standalone PostgreSQL 9 server +[source, bash] +------------------------------------------------------------------------------ +yum install gcc perl-XML-LibXML perl-XML-LibXSLT perl-Business-ISBN +cpan Library::CallNumber::LC +cpan MARC::Record +cpan MARC::File::XML +cpan UUID::Tiny +------------------------------------------------------------------------------ + +You need to create a PostgreSQL superuser to create and access the database. +Issue the following command as the *postgres* Linux account to create a new +PostgreSQL superuser named `evergreen`. When prompted, enter the new user's +password: + +[source, bash] +------------------------------------------------------------------------------ +createuser -s -P evergreen +------------------------------------------------------------------------------ + +Once you have created the *evergreen* PostgreSQL account, you also need to +create the database and schema, and configure your configuration files to point +at the database server. Issue the following command as the *root* Linux account +from inside the Evergreen source directory, replacing , , +, , and with the appropriate values for your +PostgreSQL database (where and are for the *evergreen* +PostgreSQL account you just created), and replace and +with the values you want for the *egadmin* Evergreen administrator account: + +[source, bash] +------------------------------------------------------------------------------ +perl Open-ILS/src/support-scripts/eg_db_config.pl --update-config \ + --service all --create-database --create-schema --create-offline \ + --user --password --hostname --port \ + --database --admin-user --admin-pass +------------------------------------------------------------------------------ + +This creates the database and schema and configures all of the services in +your `/openils/conf/opensrf.xml` configuration file to point to that database. +It also creates the configuration files required by the Evergreen `cgi-bin` +administration scripts, and sets the user name and password for the *egadmin* +Evergreen administrator account to your requested values. + +Creating the database on a remote server +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +In a production instance of Evergreen, your PostgreSQL server should be +installed on a dedicated server. + +PostgreSQL 9.1 and later +^^^^^^^^^^^^^^^^^^^^^^^^ +To create the database instance on a remote database server running PostgreSQL +9.1 or later, simply use the `--create-database` flag on `eg_db_config.pl`. + +For PostgreSQL 9.0 +^^^^^^^^^^^^^^^^^^ +To create the database instance on a remote database server running PostgreSQL +9.0, you can either: + + * Install the PostgreSQL contrib modules on the machine on which you + are installing the Evergreen code, and use the `--create-database` + option from that machine, or + * Copy the `Open-ILS/src/sql/Pg/create_database.sql` script to your + PostgreSQL server and invoke it as the *postgres* Linux account: ++ +[source, bash] +------------------------------------------------------------------------------ +psql -vdb_name= -vcontrib_dir=`pg_config --sharedir`/contrib -f create_database.sql +------------------------------------------------------------------------------ + +Then you can issue the `eg_db_config.pl` command as above _without_ the +`--create-database` argument to create your schema and configure your +configuration files. + +Starting Evergreen +------------------ +1. As the *root* Linux account, start the `memcached` and `ejabberd` services +(if they aren't already running): ++ +[source, bash] +------------------------------------------------------------------------------ +/etc/init.d/ejabberd start +/etc/init.d/memcached start +------------------------------------------------------------------------------ ++ +2. As the *opensrf* Linux account, start Evergreen. The `-l` flag in the +following command is only necessary if you want to force Evergreen to treat the +hostname as `localhost`; if you configured `opensrf.xml` using the real +hostname of your machine as returned by `perl -ENet::Domain 'print +Net::Domain::hostfqdn() . "\n";'`, you should not use the `-l` flag. ++ +[source, bash] +------------------------------------------------------------------------------ +osrf_ctl.sh -l -a start_all +------------------------------------------------------------------------------ ++ + ** If you receive the error message `bash: osrf_ctl.sh: command not found`, + then your environment variable `PATH` does not include the `/openils/bin` + directory; this should have been set in the *opensrf* Linux account's + `.bashrc` configuration file. To manually set the `PATH` variable, edit the + configuration file `~/.bashrc` as the *opensrf* Linux account and add the + following line: ++ +[source, bash] +------------------------------------------------------------------------------ +export PATH=$PATH:/openils/bin +------------------------------------------------------------------------------ ++ +3. As the *opensrf* Linux account, generate the Web files needed by the staff + client and catalogue and update the organization unit proximity (you need to do + this the first time you start Evergreen, and after that each time you change + the library hierarchy in `config.cgi`): ++ +[source, bash] +------------------------------------------------------------------------------ +autogen.sh -u +------------------------------------------------------------------------------ ++ +4. As the *root* Linux account, restart the Apache Web server: ++ +[source, bash] +------------------------------------------------------------------------------ +/etc/init.d/apache2 restart +------------------------------------------------------------------------------ ++ +If the Apache Web server was running when you started the OpenSRF services, you +might not be able to successfully log in to the OPAC or staff client until the +Apache Web server is restarted. + +Testing connections to Evergreen +-------------------------------- + +Once you have installed and started Evergreen, test your connection to +Evergreen via `srfsh`. As the *opensrf* Linux account, issue the following +commands to start `srfsh` and try to log onto the Evergreen server using the +*egadmin* Evergreen administrator user name and password that you set using the +`eg_db_config.pl` command: + +[source, bash] +------------------------------------------------------------------------------ +/openils/bin/srfsh +srfsh% login +------------------------------------------------------------------------------ + +You should see a result like: + + Received Data: "250bf1518c7527a03249858687714376" + ------------------------------------ + Request Completed Successfully + Request Time in seconds: 0.045286 + ------------------------------------ + + Received Data: { + "ilsevent":0, + "textcode":"SUCCESS", + "desc":" ", + "pid":21616, + "stacktrace":"oils_auth.c:304", + "payload":{ + "authtoken":"e5f9827cc0f93b503a1cc66bee6bdd1a", + "authtime":420 + } + + } + + ------------------------------------ + Request Completed Successfully + Request Time in seconds: 1.336568 + ------------------------------------ + +If this does not work, it's time to do some troubleshooting. + + * As the *opensrf* Linux acccount, run the `settings-tester.pl` script to see + if it finds any system configuration problems. The script is found at + `Open-ILS/src/support-scripts/settings-tester.pl` in the Evergreen source + tree. + * Follow the steps in the http://evergreen-ils.org/dokuwiki/doku.php?id=troubleshooting:checking_for_errors[troubleshooting guide]. + * If you have faithfully followed the entire set of installation steps + listed here, you are probably extremely close to a working system. + Gather your configuration files and log files and contact the + http://open-ils.org/listserv.php[Evergreen development mailing list] + for assistance before making any drastic changes to your system + configuration. + +Getting help +------------ + +Need help installing or using Evergreen? Join the mailing lists at +http://evergreen-ils.org/listserv.php or contact us on the Freenode +IRC network on the #evergreen channel. + +License +------- +This work is licensed under the Creative Commons Attribution-ShareAlike 3.0 +Unported License. To view a copy of this license, visit +http://creativecommons.org/licenses/by-sa/3.0/ or send a letter to Creative +Commons, 444 Castro Street, Suite 900, Mountain View, California, 94041, USA. diff --git a/configure.ac b/configure.ac index d599a51622..20c442a6a7 100644 --- a/configure.ac +++ b/configure.ac @@ -20,8 +20,8 @@ export PATH=${PATH}:/usr/sbin AC_PREREQ(2.61) -AC_INIT(Open-ILS, 2.2, open-ils-dev@list.georgialibraries.org) -AM_INIT_AUTOMAKE([OpenILS], [2.2]) +AC_INIT(Open-ILS, 2.2.9, open-ils-dev@list.georgialibraries.org) +AM_INIT_AUTOMAKE([OpenILS], [2.2.9]) AC_REVISION($Revision: 0.1 $) AC_CONFIG_SRCDIR([configure.ac]) AC_PREFIX_DEFAULT([/openils/]) -- 2.11.0