-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 1be47d0e43b92cd034fc0fbe99783dc5f830dac0
+Author: Dan Wells <dbw2@calvin.edu>
+Date: Thu Sep 19 14:06:28 2019 -0400
+
+ Update upgrade docs for 3.3.4
+
+ Signed-off-by: Dan Wells <dbw2@calvin.edu>
+
+16 16 docs/installation/server_upgrade.adoc
+
+commit 191a5147b8153952acf96da02ca88ae66f0bcdc6
+Author: Dan Wells <dbw2@calvin.edu>
+Date: Thu Sep 19 14:03:10 2019 -0400
+
+ Bump OpenILS.pm version
+
+ Signed-off-by: Dan Wells <dbw2@calvin.edu>
+
+1 1 Open-ILS/src/perlmods/lib/OpenILS.pm
+
+commit 3999b3b7fa06472ef9b10b4e47331ca6148bfa2c
+Author: Jane Sandberg <sandbej@linnbenton.edu>
+Date: Tue Sep 17 20:59:28 2019 -0700
+
+ Docs: adding release notes for 3.3.4
+
+ Signed-off-by: Jane Sandberg <sandbej@linnbenton.edu>
+ (cherry picked from commit 72e4ff788197b4a398a2b512590840cf2c56c53c)
+
+88 0 docs/RELEASE_NOTES_3_3.adoc
+
+commit 32489d301e32c78bf4250df201f047b610fc4010
+Author: Jeff Davis <jdavis@sitka.bclibraries.ca>
+Date: Mon Jun 10 09:53:44 2019 -0700
+
+ LP#1822630: fix sanitizing CGI params on place_hold_result
+
+ Signed-off-by: Jeff Davis <jdavis@sitka.bclibraries.ca>
+ Signed-off-by: Jason Stephenson <jason@sigio.com>
+ (cherry picked from commit 019118895c94f5cc810b3f1fb95b2634a1c993b6)
+
+2 2 Open-ILS/src/templates/opac/parts/place_hold_result.tt2
+
+commit a47e8d39f34298a6556ec7e3c2c5e250e1977979
+Author: Jeff Davis <jdavis@sitka.bclibraries.ca>
+Date: Mon Apr 1 15:13:09 2019 -0700
+
+ LP#1822630: further sanitizing of CGI params when embedded in HTML
+
+ Signed-off-by: Jeff Davis <jdavis@sitka.bclibraries.ca>
+ Signed-off-by: Chris Sharp <csharp@georgialibraries.org>
+ Signed-off-by: Jason Stephenson <jason@sigio.com>
+ (cherry picked from commit e2d401a9da3c70c1e56e518f40d0de928919990f)
+
+3 3 Open-ILS/src/templates/opac/parts/ebook_api/base_js.tt2
+1 1 Open-ILS/src/templates/opac/parts/header.tt2
+1 1 Open-ILS/src/templates/opac/parts/place_hold.tt2
+2 2 Open-ILS/src/templates/opac/parts/place_hold_result.tt2
+2 2 Open-ILS/src/templates/opac/parts/result/adv_filter.tt2
+
+commit 12b4a82d3927ae8d91d9128ceced88c07b94fa84
+Author: Jeff Davis <jdavis@sitka.bclibraries.ca>
+Date: Mon Apr 1 10:00:59 2019 -0700
+
+ LP#1822630: sanitize user input before display on browse results
+
+ Signed-off-by: Jeff Davis <jdavis@sitka.bclibraries.ca>
+ Signed-off-by: Chris Sharp <csharp@georgialibraries.org>
+ Signed-off-by: Jason Stephenson <jason@sigio.com>
+ (cherry picked from commit 4402695e80dbcee5187a35de46e5e314bab1231a)
+
+1 1 Open-ILS/src/templates/opac/browse.tt2
+
+commit bf00d6af3567230876d68fa92063c55863ffaa45
+Author: Jeff Davis <jdavis@sitka.bclibraries.ca>
+Date: Thu Sep 13 11:58:48 2018 -0700
+
+ LP#1559239: use rel="noopener" when opening external URLs in a new tab
+
+ Signed-off-by: Jeff Davis <jdavis@sitka.bclibraries.ca>
+ Signed-off-by: Jason Stephenson <jason@sigio.com>
+ (cherry picked from commit 1eccaeec88a99e9792b388e95732faa7576e7164)
+
+2 2 Open-ILS/src/templates/opac/parts/record/summary.tt2
+2 2 Open-ILS/src/templates/opac/parts/result/table.tt2
+
+commit 9d8cd55e5b080134648a2b62284432ad21178a0d
+Author: blake <blake@mobiusconsortium.org>
+Date: Fri Dec 1 16:32:22 2017 -0600
+
+ LP1735847: Remove patron info from default Hold Transit Slip
+
+ Removes most patron information from the Hold Transit Slip
+ in both the web and XUL client default definitions.
+
+ Signed-off-by: blake <blake@mobiusconsortium.org>
+ Signed-off-by: Dan Pearl <dpearl@cwmars.org>
+ Signed-off-by: Jason Boyer <jboyer@equinoxinitiative.org>
+
+1 8 Open-ILS/src/templates/staff/share/print_templates/t_hold_transit_slip.tt2
+1 1 Open-ILS/xul/staff_client/chrome/content/OpenILS/data.js
+
+commit 47c8186674966490f7b875ebecdd3cd3c2974706
+Author: Thomas Berezansky <tsbere@mvlc.org>
+Date: Wed Oct 15 11:32:58 2014 -0400
+
+ Ensure "Reshelved" copies are still reshelving
+
+ Rather than "were reshelving when the query started"
+
+ Signed-off-by: Thomas Berezansky <tsbere@mvlc.org>
+
+1 0 Open-ILS/src/perlmods/lib/OpenILS/Application/Storage/Publisher/action.pm
+
+commit a8fc2995beb62e33db732f15fc960c5216632500
+Author: Jason Etheridge <jason@EquinoxInitiative.org>
+Date: Thu Jun 27 18:15:50 2019 -0400
+
+ lp1790169 call compileSort after closing showColumnDialog
+
+ or in other words, make Sort Priority work right away after configuring it
+
+ Signed-off-by: Jason Etheridge <jason@EquinoxInitiative.org>
+ Signed-off-by: Remington Steed <rjs7@calvin.edu>
+ Signed-off-by: Chris Sharp <csharp@georgialibraries.org>
+
+7 0 Open-ILS/web/js/ui/default/staff/services/grid.js
+
+commit 896dccab7d39d64b3a8fd898896da159de269daa
+Author: Galen Charlton <gmc@equinoxinitiative.org>
+Date: Fri Sep 7 17:32:15 2018 -0400
+
+ LP#1790169: ensure that the sort priority actually gets saved
+
+ This is a WIP patch - there's still a problem with the saved
+ sort priorities actually getting used when a grid is initalized.
+
+ Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>
+ Signed-off-by: Jason Etheridge <jason@EquinoxInitiative.org>
+ Signed-off-by: Remington Steed <rjs7@calvin.edu>
+ Signed-off-by: Chris Sharp <csharp@georgialibraries.org>
+
+1 1 Open-ILS/src/eg2/src/app/share/grid/grid.ts
+2 1 Open-ILS/web/js/ui/default/staff/services/grid.js
+
+commit 52220e9875e1de7d5c7d5dfa9fabcd053a4068a5
+Author: Bill Erickson <berickxx@gmail.com>
+Date: Wed Jul 10 11:57:18 2019 -0400
+
+ LP1834665 Bib summary formats and jacket
+
+ Display the format icon and label along the top of the Angular bib
+ record summary.
+
+ Display the jacket image along the left of the bib summary when the
+ summary is in expaded mode.
+
+ Signed-off-by: Bill Erickson <berickxx@gmail.com>
+ Signed-off-by: Jane Sandberg <sandbej@linnbenton.edu>
+
+11 0 Open-ILS/src/eg2/src/app/staff/share/bib-summary/bib-summary.component.css
+74 48 Open-ILS/src/eg2/src/app/staff/share/bib-summary/bib-summary.component.html
+7 3 Open-ILS/src/eg2/src/app/staff/share/bib-summary/bib-summary.component.ts
+ create mode 100644 Open-ILS/src/eg2/src/app/staff/share/bib-summary/bib-summary.component.css
+
+commit 0a2082b3615954df919b52f1ff6f6f504b173bd2
+Author: Bill Erickson <berickxx@gmail.com>
+Date: Wed Jul 10 11:56:31 2019 -0400
+
+ LP1834665 MARC editor success/fail toasts
+
+ Indicate to the user when a MARC edit succeeds or fails via
+ toast in the Angular MARC editor component.
+
+ Signed-off-by: Bill Erickson <berickxx@gmail.com>
+ Signed-off-by: Jane Sandberg <sandbej@linnbenton.edu>
+
+3 0 Open-ILS/src/eg2/src/app/staff/share/marc-edit/editor.component.html
+9 3 Open-ILS/src/eg2/src/app/staff/share/marc-edit/editor.component.ts
+
+commit a2fb172de32ea15484c59565f052286e3e9e8b23
+Author: Bill Erickson <berickxx@gmail.com>
+Date: Wed Jul 10 11:51:53 2019 -0400
+
+ LP1834665 Flat text editor uses '$' delimiter
+
+ Consistent with the AngJS flat text MARC editor, use '$' as the subfield
+ delimiter instead of the default '‡'.
+
+ Signed-off-by: Bill Erickson <berickxx@gmail.com>
+ Signed-off-by: Jane Sandberg <sandbej@linnbenton.edu>
+
+6 2 Open-ILS/src/eg2/src/app/staff/share/marc-edit/marcrecord.ts
+
+commit 1732ea9971b5c917a595220bff1b65121f18bdf7
+Author: Bill Erickson <berickxx@gmail.com>
+Date: Fri Jun 28 12:29:07 2019 -0400
+
+ LP1834665 Angular catalog MARC flat text editor
+
+ Adds a set of components for editing MARC records. The main component
+ acts as a container with various actions (source selector, delete,
+ undelete, and save options). The body of this component is a tabbed
+ interface, one tab for the Enriched editor and one for the Flat Text
+ editor.
+
+ The Enriched editor tab directs the user to the AngJS version of the page.
+ the Flat Text editor tab implements the standard MARC flat text editor
+ interface.
+
+ Signed-off-by: Bill Erickson <berickxx@gmail.com>
+ Signed-off-by: Jane Sandberg <sandbej@linnbenton.edu>
+
+3 1 Open-ILS/src/eg2/src/app/staff/catalog/catalog.module.ts
+3 6 Open-ILS/src/eg2/src/app/staff/catalog/record/record.component.html
+5 0 Open-ILS/src/eg2/src/app/staff/catalog/record/record.component.ts
+73 0 Open-ILS/src/eg2/src/app/staff/share/marc-edit/editor.component.html
+182 0 Open-ILS/src/eg2/src/app/staff/share/marc-edit/editor.component.ts
+11 0 Open-ILS/src/eg2/src/app/staff/share/marc-edit/flat-editor.component.css
+7 0 Open-ILS/src/eg2/src/app/staff/share/marc-edit/flat-editor.component.html
+45 0 Open-ILS/src/eg2/src/app/staff/share/marc-edit/flat-editor.component.ts
+24 0 Open-ILS/src/eg2/src/app/staff/share/marc-edit/marc-edit.module.ts
+31 0 Open-ILS/src/eg2/src/app/staff/share/marc-edit/marcrecord.ts
+0 0 Open-ILS/src/eg2/src/app/staff/share/marc-edit/rich-editor.component.css
+0 0 Open-ILS/src/eg2/src/app/staff/share/marc-edit/rich-editor.component.html
+28 0 Open-ILS/src/eg2/src/app/staff/share/marc-edit/rich-editor.component.ts
+ create mode 100644 Open-ILS/src/eg2/src/app/staff/share/marc-edit/editor.component.html
+ create mode 100644 Open-ILS/src/eg2/src/app/staff/share/marc-edit/editor.component.ts
+ create mode 100644 Open-ILS/src/eg2/src/app/staff/share/marc-edit/flat-editor.component.css
+ create mode 100644 Open-ILS/src/eg2/src/app/staff/share/marc-edit/flat-editor.component.html
+ create mode 100644 Open-ILS/src/eg2/src/app/staff/share/marc-edit/flat-editor.component.ts
+ create mode 100644 Open-ILS/src/eg2/src/app/staff/share/marc-edit/marc-edit.module.ts
+ create mode 100644 Open-ILS/src/eg2/src/app/staff/share/marc-edit/marcrecord.ts
+ create mode 100644 Open-ILS/src/eg2/src/app/staff/share/marc-edit/rich-editor.component.css
+ create mode 100644 Open-ILS/src/eg2/src/app/staff/share/marc-edit/rich-editor.component.html
+ create mode 100644 Open-ILS/src/eg2/src/app/staff/share/marc-edit/rich-editor.component.ts
+
+commit b3578d8ae2f18803f444dcb40752f7df1a6a282b
+Author: Bill Erickson <berickxx@gmail.com>
+Date: Fri Jun 28 12:27:35 2019 -0400
+
+ LP1834665 Import marcrecord.js to Angular
+
+ Port the marcrecord.js file into the Angular build configuration so it
+ may be used by the MARC editor code.
+
+ Additionally, port jquery-dependent code to vanilla JS to avoid the
+ jquery dependency. As a part of this, some code from the source file
+ was removed since it was not needed (yet, anyway). Code added back will
+ need to be similarly ported (mostly changing XML parsing).
+
+ Note as-is, the JS is loaded on every Angular page. We could optimize
+ this and have it loaded only when needed if we port it to Typescript and
+ integrate it into the application instead of loading it as a 3rd-party
+ dependancy.
+
+ Signed-off-by: Bill Erickson <berickxx@gmail.com>
+ Signed-off-by: Jane Sandberg <sandbej@linnbenton.edu>
+
+3 1 Open-ILS/src/eg2/angular.json
+1317 0 Open-ILS/src/eg2/src/assets/js/marcrecord.js
+ create mode 100644 Open-ILS/src/eg2/src/assets/js/marcrecord.js
+
+commit 06e6d483c7423566e18a60fde12bd164ecefadff
+Author: Jane Sandberg <sandbej@linnbenton.edu>
+Date: Thu Aug 22 14:42:56 2019 -0700
+
+ Docs: adding alt text to MARC Editor chapter images
+
+ Signed-off-by: Jane Sandberg <sandbej@linnbenton.edu>
+
+4 4 docs/cataloging/MARC_Editor.adoc
+
+commit 5231eae93e63763f012ad801687ca322c56c91eb
+Author: Derek C. Zoladz <derek@derekzoladz.com>
+Date: Wed Apr 24 14:40:13 2019 -0400
+
+ Docs: LP #1803415: Location of MARC Editor 'Delete' Button
+
+ Signed-off-by: Derek C. Zoladz <derek@derekzoladz.com>
+ Signed-off-by: Jane Sandberg <sandbej@linnbenton.edu>
+
+13 0 docs/cataloging/MARC_Editor.adoc
+- - docs/media/marc_delete_record_3_3.png
+ create mode 100644 docs/media/marc_delete_record_3_3.png
+
+commit 8d03f75681981f9aa0fb3bfde3e9676074a93d66
+Author: Dan Wells <dbw2@calvin.edu>
+Date: Thu Aug 22 17:25:59 2019 -0400
+
+ Forward-port 3.3.3 upgrade script
+
+ Signed-off-by: Dan Wells <dbw2@calvin.edu>
+
+119 0 Open-ILS/src/sql/Pg/version-upgrade/3.3.2-3.3.3-upgrade-db.sql
+ create mode 100644 Open-ILS/src/sql/Pg/version-upgrade/3.3.2-3.3.3-upgrade-db.sql
+
+commit 7d3bb22520f3e7e5228aaeca497602fc18df99c9
+Author: dluchenbill <debbie@mobiusconsortium.org>
+Date: Wed Apr 24 13:41:11 2019 -0500
+
+ Docs: add checkin trigger holds and cancel transit
+
+ Signed-off-by: dluchenbill <debbie@mobiusconsortium.org>
+ Signed-off-by: Jane Sandberg <sandbej@linnbenton.edu>
+
+9 1 docs/circulation/circulating_items_web_client.adoc
+- - docs/media/Check_In-Cancel_Transit.png
+ create mode 100644 docs/media/Check_In-Cancel_Transit.png
+
+commit 30f59617de48186cac6ec8977d54cca0e3bf5852
+Author: April Durrence <49952522+adurrence@users.noreply.github.com>
+Date: Wed Apr 24 15:22:14 2019 -0400
+
+ Docs: add info about merge tracking
+
+ Signed-off-by: April Durrence <49952522+adurrence@users.noreply.github.com>
+ Signed-off-by: Jane Sandberg <sandbej@linnbenton.edu>
+
+9 0 docs/cataloging/merge_overlay_bibs.adoc
+- - docs/media/merge_tracking.png
+ create mode 100644 docs/media/merge_tracking.png
+
+commit 4e5fbcb1eca99aa58c1b9eaff957768c2a6c9280
+Author: Andrea Buntz Neiman <abneiman@equinoxinitiative.org>
+Date: Thu Aug 22 15:09:31 2019 -0400
+
+ docs: error correction to 3.1.14 release notes
+
+ corrected link for "Fixes display issue with menus at certain screen resolutions" - the link & bug number were incorrect.
+
+ Signed-off-by: Andrea Buntz Neiman <abneiman@equinoxinitiative.org>
+ Signed-off-by: Jane Sandberg <sandbej@linnbenton.edu>
+
+1 1 docs/RELEASE_NOTES_3_1.adoc
+
+commit a293a0b16fc3ad4658216c4037093555d95283c1
+Author: Dan Wells <dbw2@calvin.edu>
+Date: Thu Aug 15 10:20:17 2019 -0400
+
+ LP#1796945 Match new path_label/alias standard
+
+ The old reporter used '::' as a path separator in some labels, while the
+ new version uses '->' in its place. This would normally be just a
+ curiosity, except that the hashes used as join aliases are generated
+ from these path labels. The end result is that while a report can be
+ cloned, if you add a field anywhere other than the top level, it
+ references a join alias which does not exist, and the report breaks.
+
+ Now, the method by which report templates are upgraded from v4 to v5
+ does not happen all in one pass, but rather a first pass is made
+ populate the interface, then the rest is done when the user saves the
+ clone. Because of this, it actually seems adequate to only fix the
+ label, then allow the other steps to fill in the other bits upon saving
+ of the report.
+
+ Thank you to J. Boyer for helping track down the culprit.
+
+ Signed-off-by: Dan Wells <dbw2@calvin.edu>
+ Signed-off-by: Jason Boyer <jboyer@library.in.gov>
+
+1 1 Open-ILS/web/js/ui/default/staff/reporter/template/app.js
+
+commit cb024908d33e08e1aeafe7dea45a8bafed807d33
+Author: Dan Wells <dbw2@calvin.edu>
+Date: Fri May 3 13:17:50 2019 -0400
+
+ LP#1796945 Reporter cloning and creation fixes
+
+ This commit addresses a variety of issues with the webstaff reporter
+ interface, particularly cases of cloning reports created in the XUL
+ client.
+
+ 1. The conversion process did not account for manually selected JOIN
+ operations (aka nullability). These JOINs are now honored by the
+ conversion code.
+
+ 2. The conversion process did not account for aggregate filters. These
+ filters are now converted where present.
+
+ 3. The previous reporter interface attempted to intelligently apply LEFT
+ and INNER JOINs by default. The new interface applied INNER joins
+ exclusively by default, leading in many cases to different results.
+ This commit reinstates the previous logic. One side effect of this
+ change is that the IDL tree itself is no longer opinionated about JOIN
+ type, and the default JOIN is undefined.
+
+ 4. The nullability selector has been expanded to allow for manual
+ selection of INNER joins, as they will longer be the default in some
+ cases.
+
+ 5. Cloned-converted reports did not retain column order. The order is
+ now preserved.
+
+ 6. Some templates created in the older interface could, in some cases,
+ have aggregate values set as the string "undefined" rather than
+ actually being undefined. This led to converted templates failing with
+ "column [xxx] must appear in the GROUP BY clause...", as they were
+ incorrectly converted as aggregates. The conversion code now accounts
+ for this latent bug.
+
+ Signed-off-by: Dan Wells <dbw2@calvin.edu>
+ Signed-off-by: Jason Boyer <jboyer@library.in.gov>
+
+1 1 Open-ILS/src/templates/staff/reporter/t_edit_template.tt2
+50 38 Open-ILS/web/js/ui/default/staff/reporter/template/app.js
+0 1 Open-ILS/web/js/ui/default/staff/services/idl.js
--- /dev/null
+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),
+ Ubuntu Bionic Beaver (18.04),
+ and Ubuntu Xenial Xerus (16.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. Issue the following commands as the *root* Linux account to install
+ prerequisites using the `Makefile.install` prerequisite installer,
+ substituting `debian-stretch`,`debian-jessie`,`ubuntu-bionic`, or
+ `ubuntu-xenial` for <osname> below:
++
+[source, bash]
+------------------------------------------------------------------------------
+make -f Open-ILS/src/extras/Makefile.install <osname>
+------------------------------------------------------------------------------
++
+[[optional_developer_additions]]
+3. 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 web
+ 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`.
+
+[[install_files_for_web_staff_client]]
+Install AngularJS 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
+npm run build-prod
+npm run test
+------------------------------------------------------------------------------
+
+[[install_files_for_angular_web_staff_client]]
+Install Angular files for web staff client
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+1. Building, Testing, Minification: The remaining steps all take place within
+ the Angular staff root:
++
+[source,sh]
+------------------------------------------------------------------------------
+cd $EVERGREEN_ROOT/Open-ILS/src/eg2/
+------------------------------------------------------------------------------
++
+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 and run tests
+ng build --prod
+npm run test
+------------------------------------------------------------------------------
+
+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 and copy
+ example configuration files to `/openils/conf`.
++
+[source, bash]
+------------------------------------------------------------------------------
+make install
+------------------------------------------------------------------------------
+
+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 to configure your Web server for
+the Evergreen catalog, web staff client, Web services, and administration
+interfaces. Issue the following commands as the *root* Linux account:
++
+[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_24/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
+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):
+ * Replace `Require host 10.0.0.0/8` with `Require all granted`
+. Change the user for the Apache server.
+ * 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.
+ * 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:
++
+.`/etc/apache2/mods-available/mpm_prefork.conf`
+[source,bash]
+------------------------------------------------------------------------------
+<IfModule mpm_prefork_module>
+ StartServers 15
+ MinSpareServers 5
+ MaxSpareServers 15
+ MaxRequestWorkers 75
+ MaxConnectionsPerChild 500
+</IfModule>
+------------------------------------------------------------------------------
++
+. As the *root* user, enable the mpm_prefork module:
++
+[source,bash]
+------------------------------------------------------------------------------
+a2dismod mpm_event
+a2enmod mpm_prefork
+------------------------------------------------------------------------------
++
+. As the *root* Linux account, enable the Evergreen site:
++
+[source,bash]
+------------------------------------------------------------------------------
+a2dissite 000-default # OPTIONAL: disable the default site (the "It Works" page)
+a2ensite eg.conf
+------------------------------------------------------------------------------
++
+. 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:
+
+. 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-ubuntu-xenial
+make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-bionic
+------------------------------------------------------------------------------
+
+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 web 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 web 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.
projects / working / Evergreen.git / commitdiff