Bumping version numbers, adding Upgrade Script and Changelog user/csharp/rel_3_0_7
authorChris Sharp <csharp@georgialibraries.org>
Thu, 19 Apr 2018 02:45:31 +0000 (22:45 -0400)
committerChris Sharp <csharp@georgialibraries.org>
Thu, 19 Apr 2018 02:45:31 +0000 (22:45 -0400)
Signed-off-by: Chris Sharp <csharp@georgialibraries.org>
ChangeLog
Open-ILS/src/perlmods/lib/OpenILS/Application.pm
Open-ILS/src/sql/Pg/002.schema.config.sql
Open-ILS/src/sql/Pg/version-upgrade/3.0.6-3.0.7-upgrade-db.sql [new file with mode: 0644]
Open-ILS/xul/staff_client/chrome/content/main/about.html
Open-ILS/xul/staff_client/defaults/preferences/prefs.js
Open-ILS/xul/staff_client/windowssetup.nsi
README [changed from symlink to file mode: 0644]
configure.ac

index 1f72b2c..ac4becc 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,348 @@
-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 7f5fdd41f63f2b4555d61f92c77ecdba0bc31a6d
+Author: Chris Sharp <csharp@georgialibraries.org>
+Date:   Wed Apr 18 22:45:27 2018 -0400
+
+    Updating upgrade docs for 3.0.7.
+    
+    Signed-off-by: Chris Sharp <csharp@georgialibraries.org>
+
+18     16      docs/installation/server_upgrade.adoc
+
+commit b9fd9ca20554ad2318e77325a7615c92eaa8c53b
+Author: Chris Sharp <csharp@georgialibraries.org>
+Date:   Wed Apr 18 17:43:18 2018 -0400
+
+    Bumping Perl version string for 3.0.7
+    
+    Signed-off-by: Chris Sharp <csharp@georgialibraries.org>
+
+1      1       Open-ILS/src/perlmods/lib/OpenILS.pm
+
+commit ca858b998faca770332b0b67a4b4969fbafd8a69
+Author: Dan Wells <dbw2@calvin.edu>
+Date:   Wed Apr 18 16:25:34 2018 -0400
+
+    Touch up release notes for 3.0.7
+    
+    Signed-off-by: Dan Wells <dbw2@calvin.edu>
+
+5      0       docs/RELEASE_NOTES_3_0.adoc
+
+commit 228aba9d6bfca23888d9632e987f6462bdf37705
+Author: Jason Stephenson <jason@sigio.com>
+Date:   Mon Apr 2 16:14:43 2018 -0400
+
+    LP1760662: Item Status Holdable Field Display Follow-up
+    
+    Remove the boolText filter because it was always return false.
+    
+    Signed-off-by: Jason Stephenson <jason@sigio.com>
+    Signed-off-by: Dan Wells <dbw2@calvin.edu>
+
+1      1       Open-ILS/src/templates/staff/cat/item/t_summary_pane.tt2
+
+commit f525699f90b715c239cb1f20b92f12dc859b5db2
+Author: Jason Boyer <jboyer@library.in.gov>
+Date:   Mon Apr 2 13:55:02 2018 -0400
+
+    LP1760662: Item Status Holdable Field Display
+    
+    The Holdable field on the Summary tab of the Detail View
+    of Item Status was displaying the value for OPAC Visible.
+    Let's change that from opac_visible() to holdable().
+    
+    Signed-off-by: Jason Boyer <jboyer@library.in.gov>
+    Signed-off-by: Jason Stephenson <jason@sigio.com>
+    Signed-off-by: Dan Wells <dbw2@calvin.edu>
+
+1      1       Open-ILS/src/templates/staff/cat/item/t_summary_pane.tt2
+
+commit e9e0b4e0998ea304b55b1fa5e974880a76c5f01e
+Author: Jason Stephenson <jason@sigio.com>
+Date:   Thu Apr 12 10:47:40 2018 -0400
+
+    Lp 1735539: Fix Item Status ability to delete multiple copies.
+    
+    Use the notify handler instead of the resolve handler to collect our
+    copies.  This ensures we get them all instead of just the last one.
+    
+    To reproduce the bug:
+       1. Open Item Status in the web staff client.
+       2. Load multiple items, perhaps by uploading a file of barcodes.
+       3. Select more than 1 item from the list.
+       4. Choose "Delete Items" from the Actions menu.
+       5. Note that the dialog indicates that you will delete 1 copy.
+       6. Click the Cancel button in the dialog.
+    
+    To test, after applying the fix branch:
+       1. Open Item Status in the web staff client.
+       2. Load multiple items, perhaps by uploading a file of barcodes.
+       3. Select more than 1 item from the list.
+       4. Choose "Delete Items" from the Actions menu.
+       5. Note that that the dialog indicates you will delete X copies,
+          where X is the number of items selected.
+       6. Click OK and confirm that all copies were deleted.
+       7. You can confirm 6 by reloading the interface and uploading the
+          file of barcodes again.
+    
+    Signed-off-by: Jason Stephenson <jason@sigio.com>
+    Signed-off-by: Jason Boyer <jboyer@library.in.gov>
+    Signed-off-by: Dan Wells <dbw2@calvin.edu>
+
+5      3       Open-ILS/web/js/ui/default/staff/circ/services/item.js
+
+commit f8e98c9d481e603971e854b094dd3e9f2bd38e8b
+Author: Jane Sandberg <sandbej@linnbenton.edu>
+Date:   Tue Apr 17 11:52:24 2018 -0700
+
+    Docs: starting release notes for 3.0.7
+    
+    Signed-off-by: Jane Sandberg <sandbej@linnbenton.edu>
+
+23     0       docs/RELEASE_NOTES_3_0.adoc
+
+commit e0b6c83cd09af656b0b7d0d2101b05e1e099a279
+Author: Morkor Quarshie <msq2@students.calvin.edu>
+Date:   Tue Apr 10 16:14:49 2018 -0400
+
+    Docs: Minor updates in Ordering_materials.adoc
+    
+      - A menu item was slightly incorrect. This fixes it.
+      - Added a missing step to click "New" button.
+    
+    Signed-off-by: Remington Steed <rjs7@calvin.edu>
+
+3      3       docs/admin_initial_setup/ordering_materials.adoc
+
+commit 246a7b1bdbf03030da12703b00fb7cb4287d8ad0
+Author: Bill Erickson <berickxx@gmail.com>
+Date:   Thu Mar 29 17:06:16 2018 -0400
+
+    LP#1729934 Webstaff display org-scoped penalties
+    
+    Consistent with the XUL client, only display patron standing penalties
+    (AKA Messages) that are linked to an org unit which is an ancestor,
+    matching, or descendant org unit of the workstation (e.g. the full
+    path).
+    
+    To test:
+    
+    [1] Create a patron Message which applies to a branch using a branch or
+    null-depth penalty (e.g. at BR1).
+    
+    [2] Create a second message that links to the root org unit (e.g. CONS)
+    via depth=0 penalty.
+    
+    [2] Log out and back in to the browser client at a workstation under a
+    different section of the org unit tree (e.g. BR3) and confirm the
+    Messages created at BR1 do not display, but the messages created at CONS
+    do.
+    
+    Signed-off-by: Bill Erickson <berickxx@gmail.com>
+    Signed-off-by: Kathy Lussier <klussier@masslnc.org>
+
+3      0       Open-ILS/web/js/ui/default/staff/circ/patron/app.js
+
+commit 24b3dc1d16c887bfe0e9a5ad4dcb6e1c4ba704a5
+Author: Bill Erickson <berickxx@gmail.com>
+Date:   Fri Jan 5 14:55:56 2018 -0500
+
+    LP#1729934 Webstaff penalty create org/depth repair
+    
+    Apply correct org unit to patron penalties created in the web staff
+    client.  Specifically, be sure the standing penalty depth value is
+    honored when set.
+    
+    Commit replaces manual pcrud creation with the XUL-tested API, which
+    calculates the correct org unit by depth for us.
+    
+    Signed-off-by: Bill Erickson <berickxx@gmail.com>
+    Signed-off-by: Cesar Velez <cesar.velez@equinoxinitiative.org>
+    Signed-off-by: Kathy Lussier <klussier@masslnc.org>
+
+6      1       Open-ILS/web/js/ui/default/staff/circ/services/circ.js
+
+commit 828832b916223a4c4cb765163fba5a2b88f27169
+Author: Remington Steed <rjs7@calvin.edu>
+Date:   Tue Apr 10 14:00:31 2018 -0400
+
+    Docs: Update "Ordering materials" for web client
+    
+      - Update menu names to match web client
+    
+    Signed-off-by: Remington Steed <rjs7@calvin.edu>
+
+6      6       docs/admin_initial_setup/ordering_materials.adoc
+
+commit f5f711f8d39d6c49060f4947321d8191c87b57bb
+Author: Remington Steed <rjs7@calvin.edu>
+Date:   Tue Apr 10 10:43:27 2018 -0400
+
+    Docs: Update "Acquisitions Admin" for web client
+    
+      - Change menu names to match web client ("Admin" to "Administration", and
+        "Server Admin -> Acq" becomes "Acq Admin")
+      - Fix list formatting where images were breaking a numbered list into
+        two lists
+    
+    Signed-off-by: Remington Steed <rjs7@calvin.edu>
+
+40     45      docs/admin/acquisitions_admin.adoc
+
+commit 71d6594ce721b1d12908c5366bf28e555b2d3145
+Author: Dan Wells <dbw2@calvin.edu>
+Date:   Fri Mar 2 12:54:46 2018 -0500
+
+    LP#1738488 Optimize Flattener join logic
+    
+    The current Flattener.pm autogenerates necessary joins for sorting
+    and filtering, but in doing so, it gives every intermediate table a
+    unique alias, even if the path to that table is exactly the same as
+    another member in the map we are flattening.
+    
+    Instead, let's reuse joins whenever the path is identical, even for
+    intermediate tables.  We do so by tracking every path to each core
+    type, then reusing as much of that join path as we can.  In cases
+    where we have different paths to the same type, we still necessarily
+    provide a new unique alias.
+    
+    This problem was first noticed in the web staff billing history
+    interface, where the particular stacking of joins resulted (for one
+    specific library) in 17 joins and 44,575,740,147,225,592,344,870,912
+    potential rows.
+    
+    Signed-off-by: Dan Wells <dbw2@calvin.edu>
+    Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>
+    Signed-off-by: Jason Stephenson <jason@sigio.com>
+
+41     13      Open-ILS/src/perlmods/lib/OpenILS/Application/Flattener.pm
+
+commit edae2423cc5f20fdd3cdcf05cae8a3b04ff268a3
+Author: Remington Steed <rjs7@calvin.edu>
+Date:   Thu Mar 29 17:12:19 2018 -0400
+
+    Docs: Update "User Activity Types" for web client
+    
+      - Update screenshot, provided by Kevin Tran
+    
+    Signed-off-by: Remington Steed <rjs7@calvin.edu>
+
+-      -       docs/media/User_Activity_Types2A.jpg
+
+commit 05f505b438b7d9c36ffec8c3c7b34c99bf75710a
+Author: Remington Steed <rjs7@calvin.edu>
+Date:   Thu Mar 29 16:58:19 2018 -0400
+
+    Docs: Update "Z39.50 Servers" for web client
+    
+      - Switch incorrectly placed screenshots
+      - Update first screenshot for web client
+    
+    Signed-off-by: Remington Steed <rjs7@calvin.edu>
+
+2      2       docs/admin/restrict_Z39.50_sources_by_perm_group.adoc
+-      -       docs/media/Restrict_Z39_50_Sources_by_Permission_Group2.png
+ create mode 100644 docs/media/Restrict_Z39_50_Sources_by_Permission_Group2.png
+
+commit 1aef84c5ae63008726386c49a31db4a2073714a8
+Author: Kevin Tran <kdt8@students.calvin.edu>
+Date:   Thu Mar 1 11:34:10 2018 -0500
+
+    Docs: Update circulation_limit_groups.adoc for web client
+    
+      - Updated menu label to "Circ Limit Sets".
+    
+    Signed-off-by: Remington Steed <rjs7@calvin.edu>
+
+1      1       docs/admin/circulation_limit_groups.adoc
+
+commit 3070af8b68433e642763d9546540e7b13ff91e98
+Author: Remington Steed <rjs7@calvin.edu>
+Date:   Thu Mar 29 09:55:08 2018 -0400
+
+    Docs: Add screenshots to "Load MARC Order Records"
+    
+    Thanks to Morkor Quarshie for the screenshots.
+    
+    Signed-off-by: Remington Steed <rjs7@calvin.edu>
+
+9      0       docs/acquisitions/vandelay_acquisitions_integration.adoc
+-      -       docs/media/acq_upload_library_settings.png
+-      -       docs/media/load_marc_order_records.png
+ create mode 100644 docs/media/acq_upload_library_settings.png
+ create mode 100644 docs/media/load_marc_order_records.png
+
+commit 9533f8cd466ea61fd38674f63d28913a1e9ed16f
+Author: Remington Steed <rjs7@calvin.edu>
+Date:   Wed Mar 21 17:01:05 2018 -0400
+
+    Docs: Update "User and Group Permissions" for web client
+    
+      - Update instructions for web client
+      - New screenshot shows menu path from patron screen. Thanks to Kevin
+        Tran for the screenshot.
+    
+    Signed-off-by: Remington Steed <rjs7@calvin.edu>
+
+5      2       docs/admin/permissions.adoc
+-      -       docs/media/permissions_1.png
+ create mode 100644 docs/media/permissions_1.png
+
+commit 1bd29bc500bd8530556e632a7eab08de9cf0ae35
+Author: Kevin Tran <kdt8@students.calvin.edu>
+Date:   Thu Mar 15 10:48:09 2018 -0400
+
+    Docs: Update MARC_RAD_MVF_CRA.adoc for web client
+    
+      - Updated instructions for web client
+      - Narrower screenshot (with arrow) for Coded Value Map section
+    
+    Signed-off-by: Remington Steed <rjs7@calvin.edu>
+
+4      4       docs/admin/MARC_RAD_MVF_CRA.adoc
+-      -       docs/media/cvmpage_4.jpg
+
+commit f5a6c9f22e99dfd010bc87de653f2004d41f54d0
+Author: Remington Steed <rjs7@calvin.edu>
+Date:   Wed Mar 21 16:20:50 2018 -0400
+
+    Docs: New screenshot for "MARC Import Remove Fields"
+    
+      - New screenshot for "MARC Import Remove Fields", which still showed
+        small amount of XUL client. Thanks to Kevin Tran for the screenshot.
+    
+    Signed-off-by: Remington Steed <rjs7@calvin.edu>
+
+1      1       docs/admin/MARC_Import_Remove_Fields.adoc
+-      -       docs/media/marc_import_remove_fields3.png
+ create mode 100644 docs/media/marc_import_remove_fields3.png
+
+commit 9f5a512616aa8f21faec1ef32df0899860094279
+Author: Remington Steed <rjs7@calvin.edu>
+Date:   Thu Mar 29 08:51:28 2018 -0400
+
+    Docs: Update "Selection Lists" and "Invoices" for web client
+    
+      - Update references to Acq Admin menu
+      - Make menu name formatting more consistent (should be bold or
+        italics)
+      - Remove outdated reference to old Evergreen version under "Activate
+        Purchase Order with Zero Copies"
+    
+    Signed-off-by: Remington Steed <rjs7@calvin.edu>
+
+7      7       docs/acquisitions/invoices.adoc
+26     22      docs/acquisitions/selection_lists_po.adoc
+
+commit 5d56da85e18961e55bbb1f230f451047ce397ea4
+Author: Remington Steed <rjs7@calvin.edu>
+Date:   Wed Mar 28 15:53:18 2018 -0400
+
+    Docs: Update "Hold-driven recalls" for web client
+    
+      - Update reference to "Admin" menu
+      - Remove old note about when feature was added to Evergreen
+    
+    Signed-off-by: Remington Steed <rjs7@calvin.edu>
+
+1      3       docs/admin/hold_driven_recalls.adoc
index d750216..777b1a0 100644 (file)
@@ -7,7 +7,7 @@ use OpenILS::Utils::Fieldmapper;
 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 "HEAD";
+    return "3-0-7";
 }
 
 __PACKAGE__->register_method(
index d1285ea..4f615db 100644 (file)
@@ -93,6 +93,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 ('1107', :eg_version); --rhamby/kmlussier
+INSERT INTO config.upgrade_log (version, applied_to) VALUES ('3.0.7', :eg_version);
 
 CREATE TABLE config.bib_source (
        id              SERIAL  PRIMARY KEY,
diff --git a/Open-ILS/src/sql/Pg/version-upgrade/3.0.6-3.0.7-upgrade-db.sql b/Open-ILS/src/sql/Pg/version-upgrade/3.0.6-3.0.7-upgrade-db.sql
new file mode 100644 (file)
index 0000000..35452b7
--- /dev/null
@@ -0,0 +1,5 @@
+--Upgrade Script for 3.0.6 to 3.0.7
+\set eg_version '''3.0.7'''
+BEGIN;
+INSERT INTO config.upgrade_log (version, applied_to) VALUES ('3.0.7', :eg_version);
+COMMIT;
index b2b87b6..8aaa3f4 100644 (file)
@@ -1,7 +1,7 @@
 <html><head><script></script></head><body onload="var x = document.getElementById('version'); var version ='/xul/server/'.split(/\//)[2]; if (version == 'server') { version = 'versionless debug build'; } x.appendChild(document.createTextNode(version));">
 <h1 style="text-decoration: underline">Evergreen</h1>
 <p>Target Server ID: <span id="version"></span></p>
-<p>$HeadURL$</p>
+<p>http://git.evergreen-ils.org/?p=Evergreen.git;a=shortlog;h=refs/heads/tags/rel_3_0_7</p>
 <h2>What is Evergreen?</h2>
 <blockquote>
 <p>
index 0613a13..2f1ceb0 100644 (file)
@@ -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","$HeadURL$");
+pref("open-ils.repository.headURL","http://git.evergreen-ils.org/?p=Evergreen.git;a=shortlog;h=refs/heads/tags/rel_3_0_7");
 pref("open-ils.repository.author","$Author$");
 pref("open-ils.repository.revision","$Revision$");
 pref("open-ils.repository.date","$Date$");
index a954357..93eb47a 100644 (file)
@@ -3,7 +3,7 @@
 ; HM NIS Edit Wizard helper defines
 ; Old versions of makensis don't like this, moved to Makefile
 ;!define /file PRODUCT_VERSION "client/VERSION"
-!define PRODUCT_TAG "Master"
+!define PRODUCT_TAG "3.0"
 !define PRODUCT_INSTALL_TAG "${PRODUCT_TAG}"
 !define UI_IMAGESET "beta"
 ;!define UI_IMAGESET "release"
diff --git a/README b/README
deleted file mode 120000 (symlink)
index 1ee2103e6f619066236accc1c094d89f7ab3ff97..0000000000000000000000000000000000000000
--- a/README
+++ /dev/null
@@ -1 +0,0 @@
-docs/installation/server_installation.adoc
\ No newline at end of file
diff --git a/README b/README
new file mode 100644 (file)
index 0000000000000000000000000000000000000000..7380e811eb608e73d1533a9cb43e2929b9b9cbd6
--- /dev/null
+++ b/README
@@ -0,0 +1,692 @@
+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 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/egdownloads
+
+Developers working directly with the source code from the Git repository,
+rather than an official release tarball, must perform one step before they 
+can proceed with the `./configure` step.
+
+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
+------------------------------------------------------------------------------
+
+Installing prerequisites
+------------------------
+
+  * **PostgreSQL**: The minimum supported version is 9.4.
+  * **Linux**: Evergreen has been tested on Debian Stretch (9), 
+    Debian Jessie (8), Debian Wheezy (7), Ubuntu Xenial Xerus (16.04), 
+    and Ubuntu Trusty Tahr (14.04).
+    If you are running an older version of these distributions, you may want 
+    to upgrade before upgrading Evergreen. For instructions on upgrading these
+    distributions, visit the Debian or Ubuntu websites.
+  * **OpenSRF**: The minimum supported version of OpenSRF is 3.0.0.
+
+
+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 (3.0.0 or later).
+   You can download OpenSRF releases from http://evergreen-ils.org/opensrf-downloads/
+2. On some distributions, it is necessary to install PostgreSQL 9.4+ from external
+   repositories.
++
+  * Debian (Wheezy) and Ubuntu (Trusty) comes with older versions of 
+    PostgreSQL, so steps are taken to automatically utilize the 
+    PostgreSQL community's apt sources. 
+    (For complete details, see: https://wiki.postgresql.org/wiki/Apt)
+  * Debian (Jessie/Stretch) and Ubuntu (Xenial) comes with PostgreSQL 9.4+,
+    so no additional steps are required.
++
+3. Issue the following commands as the *root* Linux account to install
+   prerequisites using the `Makefile.install` prerequisite installer,
+   substituting `debian-stretch`, `debian-jessie`, `debian-wheezy`,
+   `ubuntu-xenial`, or `ubuntu-trusty` for <osname> below:
++
+[source, bash]
+------------------------------------------------------------------------------
+make -f Open-ILS/src/extras/Makefile.install <osname>
+------------------------------------------------------------------------------
++
+4. 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 Trusty/Xenial or Debian Jessie/Stretch. The Ubuntu
+and Debian Jessie/Stretch targets use libdbd-pgsql from packages.
++
+.Debian Wheezy
+[source, bash]
+------------------------------------------------------------------------------
+echo "/usr/local/lib/dbd" > /etc/ld.so.conf.d/eg.conf
+ldconfig
+------------------------------------------------------------------------------
+
+[[optional_developer_additions]]
+5. OPTIONAL: Developer additions
++
+To perform certain developer tasks from a Git source code checkout, 
+additional packages may be required.  As the *root* Linux account:
++
+ * To install packages needed for retrieving and managing web dependencies,
+   use the <osname>-developer Makefile.install target.  Currently, 
+   this is only needed for building and installing the (preview) browser 
+   staff client.
++
+[source, bash]
+------------------------------------------------------------------------------
+make -f Open-ILS/src/extras/Makefile.install <osname>-developer
+------------------------------------------------------------------------------
++
+ * To install packages required for building Evergreen translations, use
+   the <osname>-translator Makefile.install target.
++
+[source, bash]
+------------------------------------------------------------------------------
+make -f Open-ILS/src/extras/Makefile.install <osname>-translator
+------------------------------------------------------------------------------
++
+ * To install packages required for building Evergreen release bundles, use
+   the <osname>-packager Makefile.install target.
++
+[source, bash]
+------------------------------------------------------------------------------
+make -f Open-ILS/src/extras/Makefile.install <osname>-packager
+------------------------------------------------------------------------------
+
+Extra steps for web staff client
+--------------------------------
+
+[NOTE]
+Skip this entire section if you are using an official release tarball downloaded
+from http://evergreen-ils.org/downloads
+
+Install dependencies for web staff client
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+[NOTE]
+You may skip this section if you have installed the
+<<optional_developer_additions,optional developer additions>>.  You will still need to do the following
+steps in <<install_files_for_web_staff_client,Install files for web staff client>>.
+
+1. Install the long-term stability (LTS) release of
+https://nodejs.org[Node.js]. Add the Node.js `/bin` directory to your
+environment variable `PATH`.
++
+2. Install Grunt CLI
++
+[source,sh]
+------------------------------------------------------------------------------
+% sudo npm install -g grunt-cli
+------------------------------------------------------------------------------
+
+[[install_files_for_web_staff_client]]
+Install files for web staff client
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+1. Building, Testing, Minification: The remaining steps all take place within
+   the staff JS web root:
++
+[source,sh]
+------------------------------------------------------------------------------
+cd $EVERGREEN_ROOT/Open-ILS/web/js/ui/default/staff/
+------------------------------------------------------------------------------
++
+2. Install Project-local Dependencies. npm inspects the 'package.json' file
+   for dependencies and fetches them from the Node package network.
++
+[source,sh]
+------------------------------------------------------------------------------
+npm install   # fetch JS dependencies
+------------------------------------------------------------------------------
++
+3. Run the build script.
++
+[source,sh]
+------------------------------------------------------------------------------
+# build, run tests, concat+minify
+grunt all
+------------------------------------------------------------------------------
+
+
+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]
+------------------------------------------------------------------------------
+PATH=/openils/bin:$PATH ./configure --prefix=/openils --sysconfdir=/openils/conf
+make
+------------------------------------------------------------------------------
+
+These instructions assume that you have also installed OpenSRF under `/openils/`.
+If not, please adjust PATH as needed so that the Evergreen `configure` script
+can find `osrf_config`.
+
+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_3_0_7 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
+------------------------------------------------------------------------------
+
+Run ldconfig
+------------
+
+On Debian Stretch, run the following command as the root user:
+
+[source, bash]
+------------------------------------------------------------------------------
+ldconfig
+------------------------------------------------------------------------------
+
+Additional Instructions for Developers
+--------------------------------------
+
+[NOTE]
+Skip this section if you are using an official release tarball downloaded
+from http://evergreen-ils.org/egdownloads
+
+Developers working directly with the source code from the Git repository,
+rather than an official release tarball, 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/.
+------------------------------------------------------------------------------
+
+
+Configure the Apache Web server
+-------------------------------
+
+. Use the example configuration files in `Open-ILS/examples/apache/` (for
+Apache versions below 2.4) or `Open-ILS/examples/apache_24/` (for Apache
+versions 2.4 or greater) 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 Wheezy
+[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/eg_startup    /etc/apache2/
+# Now set up SSL
+mkdir /etc/apache2/ssl
+cd /etc/apache2/ssl
+------------------------------------------------------------------------------
++
+.Ubuntu Trusty/Xenial and Debian Jessie/Stretch
+[source,bash]
+------------------------------------------------------------------------------------
+cp Open-ILS/examples/apache_24/eg_24.conf       /etc/apache2/sites-available/eg.conf
+cp Open-ILS/examples/apache_24/eg_vhost_24.conf /etc/apache2/eg_vhost.conf
+cp Open-ILS/examples/apache/eg_startup         /etc/apache2/
+# Now set up SSL
+mkdir /etc/apache2/ssl
+cd /etc/apache2/ssl
+------------------------------------------------------------------------------------
++
+. 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
+------------------------------------------------------------------------------
++
+. As the *root* Linux account, edit the `eg.conf` file that you copied into
+place.
+  a. To enable access to the offline upload / execute interface from any
+     workstation on any network, make the following change (and note that
+     you *must* secure this for a production instance):
+     * (Apache 2.2): Replace `Allow from 10.0.0.0/8` with `Allow from all`
+     * (Apache 2.4): Replace `Require host 10.0.0.0/8` with `Require all granted`
+. 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`.
+. As the *root* Linux account, configure Apache with KeepAlive settings
+  appropriate for Evergreen. Higher values can improve the performance of a
+  single client by allowing multiple requests to be sent over the same TCP
+  connection, but increase the risk of using up all available Apache child
+  processes and memory.
+  * (Debian and Ubuntu): Edit `/etc/apache2/apache2.conf`.
+    a. Change `KeepAliveTimeout` to `1`.
+    b. Change `MaxKeepAliveRequests` to `100`.
+. As the *root* Linux account, configure the prefork module to start and keep
+  enough Apache servers available to provide quick responses to clients without
+  running out of memory. The following settings are a good starting point for a
+  site that exposes the default Evergreen catalogue to the web:
++
+.Debian Wheezy (`/etc/apache2/apache2.conf`)
+[source,bash]
+------------------------------------------------------------------------------
+<IfModule mpm_prefork_module>
+   StartServers         15
+   MinSpareServers       5
+   MaxSpareServers      15
+   MaxClients           75
+   MaxRequestsPerChild 500
+</IfModule>
+------------------------------------------------------------------------------
++
+.Ubuntu Trusty/Xenial, Debian Jessie/Stretch (`/etc/apache2/mods-available/mpm_prefork.conf`)
+[source,bash]
+------------------------------------------------------------------------------
+<IfModule mpm_prefork_module>
+   StartServers            15
+   MinSpareServers          5
+   MaxSpareServers         15
+   MaxRequestWorkers       75
+   MaxConnectionsPerChild 500
+</IfModule>
+------------------------------------------------------------------------------
++
+. (Ubuntu Trusty/Xenial, Debian Jessie/Stretch) As the *root* user,
+    enable the mpm_prefork module:
++
+[source,bash]
+------------------------------------------------------------------------------
+a2dismod mpm_event
+a2enmod mpm_prefork
+------------------------------------------------------------------------------
++
+. (Debian Wheezy): 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
+------------------------------------------------------------------------------
++
+(Ubuntu Trusty/Xenial, Debian Jessie/Stretch):
++
+[source,bash]
+------------------------------------------------------------------------------
+a2dissite 000-default  # OPTIONAL: disable the default site (the "It Works" page)
+a2ensite eg.conf
+------------------------------------------------------------------------------
++
+. (Debian and Ubuntu): As the *root* Linux account, enable Apache to write
+   to the lock directory; this is currently necessary because Apache
+   is running as the `opensrf` user:
++
+[source,bash]
+------------------------------------------------------------------------------
+chown opensrf /var/lock/apache2
+------------------------------------------------------------------------------
+
+Learn more about additional Apache options in the following sections:
+
+  * <<_apache_rewrite_tricks,Apache Rewrite Tricks>>
+  * <<_apache_access_handler_perl_module,Apache Access Handler Perl Module>>
+
+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`, described in <<_creating_the_evergreen_database,Creating the Evergreen
+database>>, sets the database connection information in `opensrf.xml` for you.
+
+Configure action triggers for the Evergreen application
+-------------------------------------------------------
+_Action Triggers_ provide hooks for the system to perform actions when a given
+event occurs; for example, to generate reminder or overdue notices, the
+`checkout.due` hook is processed and events are triggered for potential actions
+if there is no checkin time.
+
+To enable the default set of hooks, issue the following command as the
+*opensrf* Linux account:
+
+[source, bash]
+------------------------------------------------------------------------------
+cp -b /openils/conf/action_trigger_filters.json.example /openils/conf/action_trigger_filters.json
+------------------------------------------------------------------------------
+
+For more information about configuring and running action triggers, see
+<<_processing_action_triggers,Notifications / Action Triggers>>.
+
+Creating the Evergreen database
+-------------------------------
+
+Setting up the PostgreSQL server
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+For production use, most libraries install the PostgreSQL database server on a
+dedicated machine. Therefore, by default, the `Makefile.install` prerequisite
+installer does *not* install the PostgreSQL 9 database server that is required
+by every Evergreen system. You can install the packages required by Debian or
+Ubuntu on the machine of your choice using the following commands as the
+*root* Linux account:
+
+.(Debian / Ubuntu) Installing PostgreSQL server packages
+
+Each OS build target provides the postgres server installation packages
+required for each operating system.  To install Postgres server packages, 
+use the make target 'postgres-server-<OSTYPE>'.  Choose the most appropriate 
+command below based on your operating system.
+
+[source, bash]
+------------------------------------------------------------------------------
+make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-stretch
+make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-jessie
+make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-wheezy
+make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-trusty
+make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-xenial
+------------------------------------------------------------------------------
+
+For a standalone PostgreSQL server, install the following Perl modules for your
+distribution as the *root* Linux account:
+
+.(Debian and Ubuntu) 
+No extra modules required for these distributions.
+
+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
+------------------------------------------------------------------------------
+
+.Enabling connections to the PostgreSQL database
+
+Your PostgreSQL database may be configured by default to prevent connections,
+for example, it might reject attempts to connect via TCP/IP or from other
+servers. To enable TCP/IP connections from localhost, check your `pg_hba.conf`
+file, found in the `/etc/postgresql/` directory on Debian and Ubuntu.
+A simple way to enable TCP/IP
+connections from localhost to all databases with password authentication, which
+would be suitable for a test install of Evergreen on a single server, is to
+ensure the file contains the following entries _before_ any "host ... ident"
+entries:
+
+------------------------------------------------------------------------------
+host    all             all             ::1/128                 md5
+host    all             all             127.0.0.1/32            md5
+------------------------------------------------------------------------------
+
+When you change the `pg_hba.conf` file, you will need to reload PostgreSQL to
+make the changes take effect.  For more information on configuring connectivity
+to PostgreSQL, see
+http://www.postgresql.org/docs/devel/static/auth-pg-hba-conf.html
+
+Creating the Evergreen database and schema
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+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 <user>, <password>,
+<hostname>, <port>, and <dbname> with the appropriate values for your
+PostgreSQL database (where <user> and <password> are for the *evergreen*
+PostgreSQL account you just created), and replace <admin-user> and <admin-pass>
+with the values you want for the *egadmin* Evergreen administrator account:
+
+[source, bash]
+------------------------------------------------------------------------------
+perl Open-ILS/src/support-scripts/eg_db_config --update-config \
+       --service all --create-database --create-schema --create-offline \
+       --user <user> --password <password> --hostname <hostname> --port <port> \
+       --database <dbname> --admin-user <admin-user> --admin-pass <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.
+
+You can get a complete set of options for `eg_db_config` by passing the
+`--help` parameter.
+
+Loading sample data
+~~~~~~~~~~~~~~~~~~~
+If you add the `--load-all-sample` parameter to the `eg_db_config` command,
+a set of authority and bibliographic records, call numbers, copies, staff
+and regular users, and transactions will be loaded into your target
+database. This sample dataset is commonly referred to as the _concerto_
+sample data, and can be useful for testing out Evergreen functionality and
+for creating problem reports that developers can easily recreate with their
+own copy of the _concerto_ sample data.
+
+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.4 and later
+^^^^^^^^^^^^^^^^^^^^^^^^
+To create the database instance on a remote database server running PostgreSQL
+9.4 or later, simply use the `--create-database` flag on `eg_db_config`.
+
+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_control -l --start-all
+------------------------------------------------------------------------------
++
+  ** If you receive the error message `bash: osrf_control: 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 org unit configuration.
+):
++
+[source, bash]
+------------------------------------------------------------------------------
+autogen.sh
+------------------------------------------------------------------------------
++
+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` command:
+
+[source, bash]
+------------------------------------------------------------------------------
+/openils/bin/srfsh
+srfsh% login <admin-user> <admin-pass>
+------------------------------------------------------------------------------
+
+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
+    ------------------------------------
+[[install-troubleshooting-1]]
+If this does not work, it's time to do some troubleshooting.
+
+  * As the *opensrf* Linux account, 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://evergreen-ils.org/communicate/mailing-lists/[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/communicate/mailing-lists/ 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.
index dacb5a3..71e6b3b 100644 (file)
@@ -20,8 +20,8 @@
 
 export PATH=${PATH}:/usr/sbin
 AC_PREREQ(2.61)
-AC_INIT(Open-ILS, trunk, open-ils-dev@list.georgialibraries.org)
-AM_INIT_AUTOMAKE([OpenILS], [trunk])
+AC_INIT(Open-ILS, 3.0.7, open-ils-dev@list.georgialibraries.org)
+AM_INIT_AUTOMAKE([OpenILS], [3.0.7])
 AC_REVISION($Revision: 0.1 $)
 AC_CONFIG_SRCDIR([configure.ac])
 AC_CONFIG_SUBDIRS([Open-ILS/xul/staff_client/external/libmar])