-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 76d7bea52583d725010d3e60490067c384609165
+Author: Chris Sharp <csharp@georgialibraries.org>
+Date: Fri Jun 29 08:08:58 2018 -0400
+
+ Updating upgrade docs for 3.0.9.
+
+ Signed-off-by: Chris Sharp <csharp@georgialibraries.org>
+
+16 15 docs/installation/server_upgrade.adoc
+
+commit 0c72abbe44718a133718d4a288cb295704c84537
+Author: Chris Sharp <csharp@georgialibraries.org>
+Date: Fri Jun 29 08:08:21 2018 -0400
+
+ Bumping Perl version string for 3.0.9
+
+ Signed-off-by: Chris Sharp <csharp@georgialibraries.org>
+
+1 1 Open-ILS/src/perlmods/lib/OpenILS.pm
+16 32 docs/installation/server_upgrade.adoc
+
+commit 19785b44bd87db819b0f293514cedaffcd59b2fc
+Author: Jane Sandberg <sandbej@linnbenton.edu>
+Date: Thu Jun 28 12:19:22 2018 -0700
+
+ Docs: Adding 3.0.9 release notes
+
+ Signed-off-by: Jane Sandberg <sandbej@linnbenton.edu>
+
+56 0 docs/RELEASE_NOTES_3_0.adoc
+
+commit e9accd82769f4ec396b7365c25579de9d8c0ff31
+Author: Mike Rylander <mrylander@gmail.com>
+Date: Wed Jun 20 09:22:38 2018 -0400
+
+ LP#1773832: Empty deleted records can be surfaced in search results
+
+ There are cases where we avoid checking the deleted flag of bibs as an
+ optimization that avoids a JOIN in the search query. However, for some
+ shapes of real-world data, particularly in upgraded instances, deleted
+ records can slip through. This commit adds an explicit check for the
+ flag to all search queries.
+
+ Signed-off-by: Mike Rylander <mrylander@gmail.com>
+ Signed-off-by: Daniel Pearl <dpearl@cwmars.org>
+ Signed-off-by: Jason Stephenson <jason@sigio.com>
+
+3 3 Open-ILS/src/perlmods/lib/OpenILS/Application/Storage/Driver/Pg/QueryParser.pm
+
+commit 3ea9d98244ff052b9a36ceb1db5e2c0d790afa08
+Author: Jason Stephenson <jason@sigio.com>
+Date: Wed Jun 27 16:08:17 2018 -0400
+
+ LP 1758160: Bump version in upgrade_log.
+
+ Signed-off-by: Jason Stephenson <jason@sigio.com>
+
+1 1 Open-ILS/src/sql/Pg/002.schema.config.sql
+12 0 Open-ILS/src/sql/Pg/upgrade/1112.schema.auch-source_circ-index.sql
+0 12 Open-ILS/src/sql/Pg/upgrade/XXXX.schema.auch-source_circ-index.sql
+ create mode 100644 Open-ILS/src/sql/Pg/upgrade/1112.schema.auch-source_circ-index.sql
+ delete mode 100644 Open-ILS/src/sql/Pg/upgrade/XXXX.schema.auch-source_circ-index.sql
+
+commit f1745afe5e28c4a3c8e230b2b7fa8a08b4375c32
+Author: blake <blake@mobiusconsortium.org>
+Date: Mon Apr 9 19:52:08 2018 -0500
+
+ LP1758160_Deleting_patrons_can_exceed_staff_client_timeouts
+
+ Added an index to action.usr_circ_history for much needed postgresql justice.
+ This will increase the speed when deleting patrons with large number of circulations.
+
+ Signed-off-by: blake <blake@mobiusconsortium.org>
+ Signed-off-by: Jason Boyer <jboyer@library.in.gov>
+ Signed-off-by: Jason Stephenson <jason@sigio.com>
+
+1 0 Open-ILS/src/sql/Pg/090.schema.action.sql
+12 0 Open-ILS/src/sql/Pg/upgrade/XXXX.schema.auch-source_circ-index.sql
+ create mode 100644 Open-ILS/src/sql/Pg/upgrade/XXXX.schema.auch-source_circ-index.sql
+
+commit 17fe954e1efa8625014b647fb3c65700f542dec3
+Author: Jane Sandberg <sandbej@linnbenton.edu>
+Date: Wed Jun 20 14:33:25 2018 -0700
+
+ Docs: improving index terms for MARC import/export options
+
+ Signed-off-by: Jane Sandberg <sandbej@linnbenton.edu>
+
+2 0 docs/cataloging/batch_importing_MARC.adoc
+4 0 docs/development/support_scripts.adoc
+
+commit f44be2fdf073f4cec387bf90c9c92253fcdc2e76
+Author: Jeanette Lundgren <jlundgren@cwmars.org>
+Date: Tue Jun 19 15:21:50 2018 -0400
+
+ added fields for hold notification preference to display
+
+ Signed-off-by: Jeanette Lundgren <jlundgren@cwmars.org>
+ Signed-off-by: Garry Collum <gcollum@gmail.com>
+ Signed-off-by: Jason Stephenson <jason@sigio.com>
+
+4 1 Open-ILS/src/templates/staff/circ/share/t_hold_shelf_dialog.tt2
+
+commit 10e25842a8478f2076f94b765eaf94e48b296aa2
+Author: Jane Sandberg <sandbej@linnbenton.edu>
+Date: Thu Jun 7 10:11:43 2018 -0700
+
+ LP1772444: Updating list of variables in bill template descriptions
+
+ Bill: repaired merge conflicts and applied some additional docs
+ consistency across the two billing templates.
+
+ Signed-off-by: Jane Sandberg <sandbej@linnbenton.edu>
+ Signed-off-by: Bill Erickson <berickxx@gmail.com>
+
+18 4 Open-ILS/src/templates/staff/share/print_templates/t_bills_current.tt2
+19 6 Open-ILS/src/templates/staff/share/print_templates/t_bills_historical.tt2
+
+commit 745ec1f35b659b83791a7c79da3b734867cebf9c
+Author: Jason Boyer <jboyer@library.in.gov>
+Date: Mon May 21 12:09:09 2018 -0400
+
+ LP1772444: Add Patron Names to Bill Receipts
+
+ The bills_current and bills_historical receipt templates
+ were missing patron information. This has been added to
+ match most other receipt templates (money_summary is not
+ included since it could potentially be stale).
+
+ Signed-off-by: Jason Boyer <jboyer@library.in.gov>
+ Signed-off-by: Bill Erickson <berickxx@gmail.com>
+
+28 2 Open-ILS/web/js/ui/default/staff/circ/patron/bills.js
+
+commit 055e6441dd15885db9640ed3dc5d6ba8d5352cf3
+Author: Bill Erickson <berickxx@gmail.com>
+Date: Thu May 31 10:58:38 2018 -0400
+
+ LP#1774427 Parse DoB dates as whole dates
+
+ Fixes DoB parsing in the browser client patron edit interface by
+ creating date objects from a whole YMD date string instead of compiling
+ the date as collection of pieces. Compiling dates from pieces (calling
+ setFullYear(), setMonth(), etc.) can have unexpected consequences,
+ because a change of month can result in a change of days as well, if the
+ number of days in the date object exceeds the capacity of the selected
+ month.
+
+ For example:
+
+ ---
+ > d = new Date()
+ 2018-05-31T14:59:26.186Z
+ > d.setMonth(1)
+ 1520092766186
+ > d
+ 2018-03-03T15:59:26.186Z
+ --
+
+ Parsing as Date(YYYY,MM,DD) instead avoids this kind of shuffling.
+
+ To test
+
+ [1] Log in to the staff client on the 31st day of the month :)
+ [2] Change a patron's DoB to a month that does not contain 31 days.
+ [3] Save patron and note on reload, the DoB shows the wrong value.
+
+ Signed-off-by: Bill Erickson <berickxx@gmail.com>
+ Signed-off-by: Terran McCanna <tmccanna@georgialibraries.org>
+ Signed-off-by: Kathy Lussier <klussier@masslnc.org>
+
+1 5 Open-ILS/web/js/ui/default/staff/circ/patron/regctl.js
+
+commit c5f0c487ffa9b2c8340bedf76ee9c2a12e2c2675
+Author: Remington Steed <rjs7@calvin.edu>
+Date: Thu Jun 14 09:31:33 2018 -0400
+
+ Docs: Minor corrections to "Borrowing items" section
+
+ This commit fixes a number of small inconsistencies in wording (between
+ the docs and the interface) and formatting (e.g. making menu names bold).
+ Also, one sentence is expanded for clarity.
+
+ Signed-off-by: Remington Steed <rjs7@calvin.edu>
+
+11 10 docs/admin_initial_setup/borrowing_items.adoc
+
+commit 836960e863327e6b038ff52db536e6b66322c3f9
+Author: Galen Charlton <gmc@equinoxinitiative.org>
+Date: Thu Mar 29 11:46:03 2018 -0400
+
+ LP#1740535: retrieve list of billing types
+
+ This patch changes how the web staff client retrieves the list
+ of billing types available for use by the Bill Patron modal. PCRUD
+ permissions on config.billing_type don't quite match how the
+ the set of billing types available to a staff user used to work
+ in the XUL staff client, so this patch uses the
+ open-ils.circ.billing_type.ranged.retrieve.all method instead.
+
+ To test
+ -------
+ [1] Log in as a Circulators staff user (assuming stock data
+ and permissions).
+ [2] Try the Bill Patron dialog in the web staff client; note that
+ no billing types are accessible.
+ [3] Apply the patch and repeat step #2. This time, it should
+ include the miscellaneous billing type.
+
+ Signed-off-by: Galen Charlton <gmc@equinoxinitiative.org>
+ Signed-off-by: Kathy Lussier <klussier@masslnc.org>
+
+9 7 Open-ILS/web/js/ui/default/staff/circ/services/billing.js
+
+commit 9fd00201ba32b0193ba2d6aa89c6284c6dbef98e
+Author: Dan Pearl <dpearl@cwmars.org>
+Date: Thu Jun 7 14:20:49 2018 -0400
+
+ LP1739271 - Fix Item Edit when Part Present
+
+ Cannot edit item or call number after mono part
+ assigned. This was indeed a timing error where parts were referenced before
+ they were completely assigned to the structure in which they were to reside.
+ I have restructured the code to ensure the parts are available.
+
+ Signed-off-by: Dan Pearl <dpearl@cwmars.org>
+ Signed-off-by: Jason Boyer <jboyer@library.in.gov>
+
+11 10 Open-ILS/web/js/ui/default/staff/cat/volcopy/app.js
+
+commit 8960fb1d3ed7cb927f7d818bc758728f84429436
+Author: a. bellenir <ab@grpl.org>
+Date: Wed Jun 6 09:41:06 2018 -0400
+
+ LP1770752: clicking 'update expire date' should flag field_modified
+
+ ensure user is warned that unsaved data may be lost when navigating away
+
+ Signed-off-by: a. bellenir <ab@grpl.org>
+ Signed-off-by: Garry Collum <gcollum@gmail.com>
+ Signed-off-by: Kathy Lussier <klussier@masslnc.org>
+
+1 0 Open-ILS/web/js/ui/default/staff/circ/patron/regctl.js
+
+commit 1a7a1a9af9b9f339d6f4d0e2d974e1511c99af4f
+Author: Geoff Sams <gsams@roanoketexas.com>
+Date: Mon Jun 4 16:23:49 2018 -0500
+
+ LP#16989634 - Changing z-index to 4 to allow active text boxes to pass under patron tabs naturally.
+
+ Signed-off-by: Geoff Sams <gsams@roanoketexas.com>
+ Signed-off-by: Chris Sharp <csharp@georgialibraries.org>
+ Signed-off-by: Kathy Lussier <klussier@masslnc.org>
+
+1 1 Open-ILS/src/templates/staff/css/circ.css.tt2
+
+commit 765eb249c121a40f91c5003f394d2f301ab352bc
+Author: a. bellenir <ab@grpl.org>
+Date: Tue Jun 5 20:31:46 2018 -0400
+
+ LP1775294: item status should show floating group name
+
+ Signed-off-by: a. bellenir <ab@grpl.org>
+ Signed-off-by: Kathy Lussier <klussier@masslnc.org>
+
+1 1 Open-ILS/src/templates/staff/cat/item/t_list.tt2
+
+commit c0336824d73ffce797c38d3ce478a845e59d573b
+Author: Michele Morgan <mmorgan@noblenet.org>
+Date: Wed May 16 10:50:59 2018 -0400
+
+ LP#1745422 - Removed three commented out lines from the code and signoff.
+
+ Signed-off-by: Michele Morgan <mmorgan@noblenet.org>
+ Signed-off-by: Kathy Lussier <klussier@masslnc.org>
+
+0 3 Open-ILS/src/templates/staff/circ/share/t_hold_details.tt2
+
+commit 5f1d959cb9fed7fb34f3de78005fad90a558d7fd
+Author: Cesar Velez <cesar.velez@equinoxinitiative.org>
+Date: Fri Feb 16 11:01:23 2018 -0500
+
+ LP#1745422 - Add Parts column to Patron holds grids and detail view
+
+ The webstaff's patron ui did not have a display for the Part,
+ which will be fetched for any hold type "P" (monographic part).
+ This adds a Part column to the hold grids and inthe detail view
+ IF the hold type is P, it'll append the part.label in the same
+ field/well.
+
+ Signed-off by: Cesar Velez <cesar.velez@equinoxinitiative.org>
+
+ Signed-off-by: Michele Morgan <mmorgan@noblenet.org>
+ Signed-off-by: Kathy Lussier <klussier@masslnc.org>
+
+1 0 Open-ILS/src/templates/staff/circ/patron/t_holds_list.tt2
+4 1 Open-ILS/src/templates/staff/circ/share/t_hold_details.tt2
+
+commit c9a88fb08f5cbbb15344498d0638a9a043924fda
+Author: BC Libraries Cooperative <office@bc.libraries.coop>
+Date: Thu Jun 7 12:00:00 2018 -0700
+
+ Docs: Adding information about activating POs
+
+ Signed-off-by: Jane Sandberg <sandbej@linnbenton.edu>
+
+16 0 docs/acquisitions/selection_lists_po.adoc
+
+commit 665b73d914ac7529eba63e93f47c6a9384851647
+Author: Jane Sandberg <sandbej@linnbenton.edu>
+Date: Thu Jun 7 11:55:07 2018 -0700
+
+ Docs: Reorganizing purchase order chapter
+
+ Signed-off-by: Jane Sandberg <sandbej@linnbenton.edu>
+
+23 10 docs/acquisitions/selection_lists_po.adoc
+
+commit 1fa56056d25405af0d4a212f6ed796a0c85f7934
+Author: Dan Wells <dbw2@calvin.edu>
+Date: Mon Jun 4 09:06:55 2018 -0400
+
+ Forward port 3.0.8 upgrade script
+
+ Signed-off-by: Dan Wells <dbw2@calvin.edu>
+
+131 0 Open-ILS/src/sql/Pg/version-upgrade/3.0.7-3.0.8-upgrade-db.sql
+ create mode 100644 Open-ILS/src/sql/Pg/version-upgrade/3.0.7-3.0.8-upgrade-db.sql
+
+commit 15bcf0c929f2e175849b888ab47632c85b9c1942
+Author: Remington Steed <rjs7@calvin.edu>
+Date: Thu May 31 13:59:30 2018 -0400
+
+ Docs: Add bullet number images removed in 2.10
+
+ These number images are used by the code callout feature of AsciiDoc,
+ used by the new Receipt Template Editor chapter (and possibly other
+ docs). I had renamed them in 2015, supposedly to prevent an ePub build
+ error, but that broke the code callout images. And since I cannot
+ replicate the ePub error now, I am renaming them back to their original
+ state, with sincere apologies to code callout readers everywhere.
+
+ Signed-off-by: Remington Steed <rjs7@calvin.edu>
+
+- - docs/media/1.png
+- - docs/media/10.png
+- - docs/media/11.png
+- - docs/media/12.png
+- - docs/media/13.png
+- - docs/media/14.png
+- - docs/media/15.png
+- - docs/media/2.png
+- - docs/media/3.png
+- - docs/media/4.png
+- - docs/media/5.png
+- - docs/media/6.png
+- - docs/media/7.png
+- - docs/media/8.png
+- - docs/media/9.png
+- - docs/media/media1.png
+- - docs/media/media10.png
+- - docs/media/media11.png
+- - docs/media/media12.png
+- - docs/media/media13.png
+- - docs/media/media14.png
+- - docs/media/media15.png
+- - docs/media/media2.png
+- - docs/media/media3.png
+- - docs/media/media4.png
+- - docs/media/media5.png
+- - docs/media/media6.png
+- - docs/media/media7.png
+- - docs/media/media8.png
+- - docs/media/media9.png
+ create mode 100644 docs/media/1.png
+ create mode 100644 docs/media/10.png
+ create mode 100644 docs/media/11.png
+ create mode 100644 docs/media/12.png
+ create mode 100644 docs/media/13.png
+ create mode 100644 docs/media/14.png
+ create mode 100644 docs/media/15.png
+ create mode 100644 docs/media/2.png
+ create mode 100644 docs/media/3.png
+ create mode 100644 docs/media/4.png
+ create mode 100644 docs/media/5.png
+ create mode 100644 docs/media/6.png
+ create mode 100644 docs/media/7.png
+ create mode 100644 docs/media/8.png
+ create mode 100644 docs/media/9.png
+ delete mode 100644 docs/media/media1.png
+ delete mode 100644 docs/media/media10.png
+ delete mode 100644 docs/media/media11.png
+ delete mode 100644 docs/media/media12.png
+ delete mode 100644 docs/media/media13.png
+ delete mode 100644 docs/media/media14.png
+ delete mode 100644 docs/media/media15.png
+ delete mode 100644 docs/media/media2.png
+ delete mode 100644 docs/media/media3.png
+ delete mode 100644 docs/media/media4.png
+ delete mode 100644 docs/media/media5.png
+ delete mode 100644 docs/media/media6.png
+ delete mode 100644 docs/media/media7.png
+ delete mode 100644 docs/media/media8.png
+ delete mode 100644 docs/media/media9.png
--- /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), 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_9 install
+------------------------------------------------------------------------------
++
+2. The server portion of the staff client expects `http://hostname/xul/server`
+ to resolve. Issue the following commands as the *root* Linux account to
+ create a symbolic link pointing to the `server` subdirectory of the server
+ portion of the staff client that we just built using the staff client ID
+ 'rel_name':
++
+[source, bash]
+------------------------------------------------------------------------------
+cd /openils/var/web/xul
+ln -sf rel_name/server server
+------------------------------------------------------------------------------
+
+Change ownership of the Evergreen files
+---------------------------------------
+
+All files in the `/openils/` directory and subdirectories must be owned by the
+`opensrf` user. Issue the following command as the *root* Linux account to
+change the ownership on the files:
+
+[source, bash]
+------------------------------------------------------------------------------
+chown -R opensrf:opensrf /openils
+------------------------------------------------------------------------------
+
+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.
projects / working / Evergreen.git / commitdiff