From: Jason Stephenson Date: Thu, 21 Jul 2022 14:32:55 +0000 (-0400) Subject: Bumping version numbers, adding Upgrade Script and Changelog X-Git-Url: https://old-git.evergreen-ils.org/?a=commitdiff_plain;h=68a4d4c02893163e9c6f179eae38b74f13671e45;p=working%2FEvergreen.git Bumping version numbers, adding Upgrade Script and Changelog Signed-off-by: Jason Stephenson --- diff --git a/ChangeLog b/ChangeLog index 1f72b2c73e..40b0a72eb1 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,258 @@ -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 ff22c71b014d66b718f898431629e0ec28a03b32 +Author: Jason Stephenson +Date: Thu Jul 21 10:09:12 2022 -0400 + + Revert "Translation updates - po files" + + This reverts commit b7e11c87cb7a69c647f6ce35c3bc4bdc8488842b. + + This was the newpot step run by mistake. + +442 442 build/i18n/po/bootstrap-opac/bootstrap-opac.pot +1 1 build/i18n/po/conify/conify.pot +14 14 build/i18n/po/kpac/kpac.pot +441 441 build/i18n/po/tpac/tpac.pot +2 2 build/i18n/po/urlverify/urlverify.pot +114 114 build/i18n/po/webstaff/webstaff.pot + +commit b7e11c87cb7a69c647f6ce35c3bc4bdc8488842b +Author: Jason Stephenson +Date: Thu Jul 21 09:53:39 2022 -0400 + + Translation updates - po files + + Signed-off-by: Jason Stephenson + +442 442 build/i18n/po/bootstrap-opac/bootstrap-opac.pot +1 1 build/i18n/po/conify/conify.pot +14 14 build/i18n/po/kpac/kpac.pot +441 441 build/i18n/po/tpac/tpac.pot +2 2 build/i18n/po/urlverify/urlverify.pot +114 114 build/i18n/po/webstaff/webstaff.pot + +commit f851e5a34670620e2d99c9c43d6d8304fefd0677 +Author: Jason Stephenson +Date: Wed Jul 20 08:57:55 2022 -0400 + + Docs: 3.7.4 Release Notes + + Signed-off-by: Jason Stephenson + +32 0 docs/RELEASE_NOTES_3_7.adoc + +commit 484e6a5d65274bb572b28974d436e3c5e3620ebc +Author: Jason Stephenson +Date: Tue Jul 19 14:18:29 2022 -0400 + + Revert "LP#1945385: use eg-admin-page for circ limit sets admin UI" + + This reverts commit 5380bfb11a3a38bac521ce8ef92216c13d46f3b9. + + The reverted code raises the following error in 3.7: + + ERROR in + src/app/staff/admin/local/circ_limit_set/circ_limit_set.component.html:4:32 + - error NG8002: Can't bind to 'templateFields' since it isn't a known + property of 'eg-admin-page'. + + Signed-off-by: Jason Stephenson + +20 8 Open-ILS/src/eg2/src/app/staff/admin/local/circ_limit_set/circ_limit_set.component.html +118 2 Open-ILS/src/eg2/src/app/staff/admin/local/circ_limit_set/circ_limit_set.component.ts +0 2 Open-ILS/src/eg2/src/app/staff/admin/local/circ_limit_set/circ_limit_set.module.ts +1 1 Open-ILS/src/eg2/src/app/staff/admin/local/circ_limit_set/circ_limit_set_edit.component.ts + +commit f51c09157ff0199a7782c4f4974e2146e5fde77f +Author: Jason Stephenson +Date: Fri Jul 15 13:34:18 2022 -0400 + + Revert "LP#1851884: eg-fm-record-editor: avoid fetching all rows from linked table" + + This reverts commit f2824b8457fa1e941053cdc7fa715ab21e6f58c9. + + It causes the following error when building Angular: + + ERROR in src/app/share/fm-editor/fm-editor.component.ts:517:30 - error TS2339: Property 'linkedSearchConditions' does not exist on type 'FmFieldOptions'. + + 517 if (fieldOptions.linkedSearchConditions) { + ~~~~~~~~~~~~~~~~~~~~~~ + src/app/share/fm-editor/fm-editor.component.ts:518:51 - error TS2339: Property 'linkedSearchConditions' does not exist on type 'FmFieldOptions'. + + 518 field.idlBaseQuery = fieldOptions.linkedSearchConditions; + + There does not appear to be any way to resolve this as the patch also + relies on other changes in rel_3_8 and rel_3_9 that are not present in + rel_3_7. For these reasons, I am reverting the patch from rel_3_7. + + Signed-off-by: Jason Stephenson + +1 10 Open-ILS/src/eg2/src/app/core/idl.service.ts +0 13 Open-ILS/src/eg2/src/app/share/fm-editor/fm-editor.component.html +72 14 Open-ILS/src/eg2/src/app/share/fm-editor/fm-editor.component.ts + +commit 4f51006f1b944dd41380efdc158ea171500a9738 +Author: Jason Stephenson +Date: Thu May 26 13:02:53 2022 -0400 + + LP 1975861: Fix the Patch for Lp 1909681 on rel_3_7 + + The change to the Hopeless Holds Interface for opening title links in + a new tab was missed in the 3.7 backport of the branch from bug + 1909681. This commit adds it back. + + NOTE: This branch is for rel_3_7 and ONLY rel_3_7. Other Evergreen + branches do not need it. + + Signed-off-by: Jason Stephenson + +1 1 Open-ILS/src/eg2/src/app/staff/share/holds/grid.component.html + +commit f2824b8457fa1e941053cdc7fa715ab21e6f58c9 +Author: Galen Charlton +Date: Wed Apr 27 20:42:05 2022 -0400 + + LP#1851884: eg-fm-record-editor: avoid fetching all rows from linked table + + This patch ensures that Angular FM record editor dialogs do + not attempt to fetch all rows from target table when constructing + a combobox for a linked field. + + In particular, it makes the following changes: + + * If a custom template for a field is supplied, use that by + default rather than _also_ creating a data source for + a combobox. + * Rather than creating its own data source for a linked field, + the FM record editor now uses the IDL mode of eg-combobox. By doing + this, we use eg-combobox's default data source, which limits + record retrievals to 100 rows max. Also, empty-click is now + enabled by default. + * When attempting to identify a selector for an IDL class, if + the class doesn't define a selector and doesn't have a field named + 'name', but its primary key is a text field, use the primary + key as the selector. + + To test + ------- + [1] Create a few thousand empty bib record buckets in your test database. + [2] Edit a carousel under Local Administration; note that it can + take some time for the dialog to load. + [3] Apply the patch and repeat step 2. This time, the carousel edit modal + should open instantly. + [4] Test various Angular record editor modals to confirm that they behave + as expected. For example: + + * The allocate to fund dialog in Fund Administration, in particular + to verify that only active funds show up. + * The assign user to course modal, to verify that searching is done + by course number, not name. + * Filter Dialog Set editor under /eg2/en-US/staff/admin/local/config/filter_dialog_filter_set + to verify that the drop down for the creator doesn't fetch + all patrons. (Note that this is an artificial example). + + Signed-off-by: Galen Charlton + Signed-off-by: Jason Boyer + +10 1 Open-ILS/src/eg2/src/app/core/idl.service.ts +13 0 Open-ILS/src/eg2/src/app/share/fm-editor/fm-editor.component.html +14 72 Open-ILS/src/eg2/src/app/share/fm-editor/fm-editor.component.ts + +commit 5380bfb11a3a38bac521ce8ef92216c13d46f3b9 +Author: Jeff Davis +Date: Thu May 19 16:32:38 2022 -0700 + + LP#1945385: use eg-admin-page for circ limit sets admin UI + + Signed-off-by: Jeff Davis + Signed-off-by: Jennifer Pringle + Signed-off-by: Jason Stephenson + +8 20 Open-ILS/src/eg2/src/app/staff/admin/local/circ_limit_set/circ_limit_set.component.html +2 118 Open-ILS/src/eg2/src/app/staff/admin/local/circ_limit_set/circ_limit_set.component.ts +2 0 Open-ILS/src/eg2/src/app/staff/admin/local/circ_limit_set/circ_limit_set.module.ts +1 1 Open-ILS/src/eg2/src/app/staff/admin/local/circ_limit_set/circ_limit_set_edit.component.ts + +commit 4c18d9ae1fae96eaa057dccbd3da1968277e986a +Author: Jeff Davis +Date: Thu Apr 21 10:48:15 2022 -0700 + + LP#1932203: serialize requests on Edit Due Date in Items Out tab + + Signed-off-by: Jeff Davis + Signed-off-by: Jason Stephenson + +7 5 Open-ILS/web/js/ui/default/staff/circ/patron/items_out.js + +commit bd9fc8a16fa8d84176e2fbc065bd7ea7ea9295aa +Author: Galen Charlton +Date: Mon May 23 19:06:48 2022 -0400 + + LP#1930617: reduce parallel requests initiated by AngularJS holdings editor + + This patch decreases the number of parallel requests spawned by the + AngularJS holdings editor. This can reduce load on open-ils.pcrud when + the editor is used to handle a large number of items in one batch. + + This patch takes the following approaches: + + - the fetching of call number affixes now only makes one request + per relevant org unit + - item alerts are now retrieved via fleshing when the batch of items + is requested (as opposed to doing a PCRUD request for each copy) + - fetching monograph parts is now done serially + + To test + ------- + [1] Apply the patch. + [2] Create a bucket with a few hundred items and edit all of them + in the AngularJS holdings editor (which is what you get when + you edit items from the bucket interface). + [3] Verify that the editing loads itself without causing errors + or PCRUD drone spikes. + [4] Verify that item alerts and monograph parts are loaded + [5] Verify that the call number prefix and suffix drop-downs + are correctly populated. + [6] Verify that copy alerts can be attached to newly-created items + and saved. + + Signed-off-by: Galen Charlton + Signed-off-by: Jeff Davis + +68 29 Open-ILS/web/js/ui/default/staff/cat/volcopy/app.js + +commit 45dd90092449fc2aeb3ed39945706e61f2886ee6 +Author: Galen Charlton +Date: Thu May 19 10:00:48 2022 -0400 + + LP#1974195: fix memory leak when performing fleshed Fieldmapper search + + This patch fixes a memory leak that occurs when performing + a fleshed search of an IDL class via open-ils.cstore, open-ils.pcrud, + or open-ils.rstore. It removes a debug-level log entry that didn't + free a temporary string. + + To test + ------- + [1] Perform a PCRUD search that includes fleshing and retrieves + a large responses. One example is a search on bre that fleshes + call numbers and copies and returns a few hundred bibs. + [2] Observe that the PCRUD drone that serviced the request has + increased its memory usage significantly. + [3] Apply the patch and repeat step 1. This time, the drone's memory + usage should not (persistently) increase as much. + + Signed-off-by: Galen Charlton + Signed-off-by: Jason Stephenson + +0 2 Open-ILS/src/c-apps/oils_sql.c + +commit c915763aeaf24629435ff471ebe19a2b087022a7 +Author: Jason Boyer +Date: Fri May 20 17:35:53 2022 -0400 + + Forward Port 3.7.3 Upgrade Script + + Signed-off-by: Jason Boyer + +2231 0 Open-ILS/src/sql/Pg/version-upgrade/3.7.2-3.7.3-upgrade-db.sql + create mode 100644 Open-ILS/src/sql/Pg/version-upgrade/3.7.2-3.7.3-upgrade-db.sql diff --git a/Open-ILS/src/perlmods/lib/OpenILS.pm b/Open-ILS/src/perlmods/lib/OpenILS.pm index d7235ce61a..240d697a4c 100644 --- a/Open-ILS/src/perlmods/lib/OpenILS.pm +++ b/Open-ILS/src/perlmods/lib/OpenILS.pm @@ -6,6 +6,6 @@ OpenILS - Client and server support for the Evergreen open source library system =cut -our $VERSION = '2.4'; +our $VERSION = '3.0704'; 1; diff --git a/Open-ILS/src/perlmods/lib/OpenILS/Application.pm b/Open-ILS/src/perlmods/lib/OpenILS/Application.pm index d750216454..9f0baa284e 100644 --- a/Open-ILS/src/perlmods/lib/OpenILS/Application.pm +++ b/Open-ILS/src/perlmods/lib/OpenILS/Application.pm @@ -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-7-4"; } __PACKAGE__->register_method( diff --git a/Open-ILS/src/sql/Pg/002.schema.config.sql b/Open-ILS/src/sql/Pg/002.schema.config.sql index 8198950c31..4614a86a74 100644 --- a/Open-ILS/src/sql/Pg/002.schema.config.sql +++ b/Open-ILS/src/sql/Pg/002.schema.config.sql @@ -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 ('1325', :eg_version); -- stompro/sandbergja/JBoyer +INSERT INTO config.upgrade_log (version, applied_to) VALUES ('3.7.4', :eg_version); CREATE TABLE config.bib_source ( id SERIAL PRIMARY KEY, diff --git a/Open-ILS/src/sql/Pg/version-upgrade/3.7.3-3.7.4-upgrade-db.sql b/Open-ILS/src/sql/Pg/version-upgrade/3.7.3-3.7.4-upgrade-db.sql new file mode 100644 index 0000000000..47ec90c131 --- /dev/null +++ b/Open-ILS/src/sql/Pg/version-upgrade/3.7.3-3.7.4-upgrade-db.sql @@ -0,0 +1,5 @@ +--Upgrade Script for 3.7.3 to 3.7.4 +\set eg_version '''3.7.4''' +BEGIN; +INSERT INTO config.upgrade_log (version, applied_to) VALUES ('3.7.4', :eg_version); +COMMIT; diff --git a/Open-ILS/xul/staff_client/chrome/content/main/about.html b/Open-ILS/xul/staff_client/chrome/content/main/about.html index b2b87b683f..002c7ceaf1 100644 --- a/Open-ILS/xul/staff_client/chrome/content/main/about.html +++ b/Open-ILS/xul/staff_client/chrome/content/main/about.html @@ -1,7 +1,7 @@

Evergreen

Target Server ID:

-

$HeadURL$

+

http://git.evergreen-ils.org/?p=Evergreen.git;a=shortlog;h=refs/heads/tags/rel_3_7_4

What is Evergreen?

diff --git a/Open-ILS/xul/staff_client/defaults/preferences/prefs.js b/Open-ILS/xul/staff_client/defaults/preferences/prefs.js index 0613a13ddf..8afa2da3d1 100644 --- a/Open-ILS/xul/staff_client/defaults/preferences/prefs.js +++ b/Open-ILS/xul/staff_client/defaults/preferences/prefs.js @@ -11,7 +11,7 @@ pref("toolkit.singletonWindowType", "eg_main"); pref("open-ils.enable_join_tabs", true); // We'll use this one to help brand some build information into the client, and rely on subversion keywords -pref("open-ils.repository.headURL","$HeadURL$"); +pref("open-ils.repository.headURL","http://git.evergreen-ils.org/?p=Evergreen.git;a=shortlog;h=refs/heads/tags/rel_3_7_4"); pref("open-ils.repository.author","$Author$"); pref("open-ils.repository.revision","$Revision$"); pref("open-ils.repository.date","$Date$"); diff --git a/Open-ILS/xul/staff_client/windowssetup.nsi b/Open-ILS/xul/staff_client/windowssetup.nsi index a9543579a8..fe5c9880b5 100644 --- a/Open-ILS/xul/staff_client/windowssetup.nsi +++ b/Open-ILS/xul/staff_client/windowssetup.nsi @@ -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.7" !define PRODUCT_INSTALL_TAG "${PRODUCT_TAG}" !define UI_IMAGESET "beta" ;!define UI_IMAGESET "release" diff --git a/README b/README deleted file mode 120000 index 1486a8d676..0000000000 --- a/README +++ /dev/null @@ -1 +0,0 @@ -docs/modules/installation/pages/server_installation.adoc \ No newline at end of file diff --git a/README b/README new file mode 100644 index 0000000000..694dc0663d --- /dev/null +++ b/README @@ -0,0 +1,662 @@ += Installing the Evergreen server = +:toc: + +== 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.6. + * **Linux**: Evergreen has been tested on + Debian Buster (10), + Debian Stretch (9), + Debian Jessie (8), + Ubuntu Focal Fossa (20.04), + and Ubuntu Bionic Beaver (18.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.2.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.2.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-buster`,`debian-stretch`,`debian-jessie`,`ubuntu-focal`, + or `ubuntu-bionic` for below: ++ +[source, bash] +------------------------------------------------------------------------------ +make -f Open-ILS/src/extras/Makefile.install +------------------------------------------------------------------------------ ++ +[[optional_developer_additions]] +3. OPTIONAL: Developer additions ++ +To perform certain developer tasks from a Git source code checkout, +including the testing of the Angular web client components, +additional packages may be required. As the *root* Linux account: ++ + * To install packages needed for retrieving and managing web dependencies, + use the -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 -developer +------------------------------------------------------------------------------ ++ + * To install packages required for building Evergreen translations, use + the -translator Makefile.install target. ++ +[source, bash] +------------------------------------------------------------------------------ +make -f Open-ILS/src/extras/Makefile.install -translator +------------------------------------------------------------------------------ ++ + * To install packages required for building Evergreen release bundles, use + the -packager Makefile.install target. ++ +[source, bash] +------------------------------------------------------------------------------ +make -f Open-ILS/src/extras/Makefile.install -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. Otherwise, ensure you have installed the +xref:#optional_developer_additions[optional developer additions] before proceeding. + +[[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, concat+minify +npm run build-prod +------------------------------------------------------------------------------ ++ +4. OPTIONAL: Test web client code if the -developer packages were installed. + CHROME_BIN should be set to the path to chrome or chromimum, e.g., + `/usr/bin/chromium`: ++ +[source,sh] +------------------------------------------------------------------------------ +CHROME_BIN=/path/to/chrome 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 +------------------------------------------------------------------------------ ++ +4. OPTIONAL: Test eg2 web client code if the -developer packages were installed: + CHROME_BIN should be set to the path to chrome or chromimum, e.g., + `/usr/bin/chromium`: ++ +[source,sh] +------------------------------------------------------------------------------ +CHROME_BIN=/path/to/chrome npm run test +------------------------------------------------------------------------------ + +[[install_opac_deps]] +=== Install OPAC skin dependencies === + +1. The following steps take place within the OPAC dependencies root: ++ +[source,sh] +------------------------------------------------------------------------------ +cd $EVERGREEN_ROOT/Open-ILS/web/opac/deps +------------------------------------------------------------------------------ ++ +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 and CSS dependencies +------------------------------------------------------------------------------ ++ +Note that there is no build step. + +== 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 Ubuntu 18.04 / 20.04 or Debian Stretch / Buster, 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 catalog to the web: ++ +.`/etc/apache2/mods-available/mpm_prefork.conf` +[source,bash] +------------------------------------------------------------------------------ + + StartServers 15 + MinSpareServers 5 + MaxSpareServers 15 + MaxRequestWorkers 75 + MaxConnectionsPerChild 500 + +------------------------------------------------------------------------------ ++ +. 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: + + * xref:admin:apache_rewrite_tricks.adoc#apache_rewrite_tricks[Apache Rewrite Tricks] + * xref:admin:apache_access_handler.adoc#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 xref:#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 +xref:admin:actiontriggers_process.adoc#processing_action_triggers[Notifications / Action Triggers]. + +[[creating_the_evergreen_database]] +== 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-'. Choose the most appropriate +command below based on your operating system. This will install PostgreSQL 9.6, +the minimum supported version. + +[source, bash] +------------------------------------------------------------------------------ +make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-buster +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-bionic +make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-focal +------------------------------------------------------------------------------ + +To install PostgreSQL version 10, use the following command for your operating +system: + +[source, bash] +------------------------------------------------------------------------------ +make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-buster-10 +make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-stretch-10 +make -f Open-ILS/src/extras/Makefile.install postgres-server-debian-jessie-10 +make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-bionic-10 +make -f Open-ILS/src/extras/Makefile.install postgres-server-ubuntu-focal-10 +------------------------------------------------------------------------------ + +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 , , +, , and with the appropriate values for your +PostgreSQL database (where and are for the *evergreen* +PostgreSQL account you just created), and replace and +with the values you want for the *egadmin* Evergreen administrator account: + +[source, bash] +------------------------------------------------------------------------------ +perl Open-ILS/src/support-scripts/eg_db_config --update-config \ + --service all --create-database --create-schema --create-offline \ + --user --password --hostname --port \ + --database --admin-user --admin-pass +------------------------------------------------------------------------------ + +This creates the database and schema and configures all of the services in +your `/openils/conf/opensrf.xml` configuration file to point to that database. +It also creates the configuration files required by the Evergreen `cgi-bin` +administration scripts, and sets the user name and password for the *egadmin* +Evergreen administrator account to your requested values. + +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.6 and later ==== + +To create the database instance on a remote database server running PostgreSQL +9.6 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 catalog 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 +------------------------------------------------------------------------------ + +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. diff --git a/configure.ac b/configure.ac index f7da01416f..951a5cd0ff 100644 --- a/configure.ac +++ b/configure.ac @@ -20,7 +20,7 @@ export PATH=${PATH}:/usr/sbin AC_PREREQ(2.61) -AC_INIT(Open-ILS, trunk, open-ils-dev@list.georgialibraries.org) +AC_INIT(Open-ILS, 3.7.4, open-ils-dev@list.georgialibraries.org) AC_CONFIG_SRCDIR([configure.ac]) AC_CONFIG_MACRO_DIR([m4]) AM_INIT_AUTOMAKE diff --git a/docs/modules/installation/pages/server_upgrade.adoc b/docs/modules/installation/pages/server_upgrade.adoc index ef8ba1f11a..899a792c37 100644 --- a/docs/modules/installation/pages/server_upgrade.adoc +++ b/docs/modules/installation/pages/server_upgrade.adoc @@ -7,7 +7,7 @@ All of the steps in this chapter are to be completed from the command line. == Software Prerequisites == * **PostgreSQL**: The minimum supported version is 9.6. - * **Linux**: Evergreen 3.X.X has been tested on Debian Stretch + * **Linux**: Evergreen 3.7.4 has been tested on Debian Stretch (9.0), Debian Jessie (8.0), Ubuntu Bionic Beaver (18.04), and Ubuntu Focal Fossa (20.04). If you are running an older version of these distributions, you may want to upgrade before upgrading @@ -43,12 +43,12 @@ osrf_control --localhost --stop-all .. Back up the /openils directory. . Upgrade OpenSRF. Download and install the latest version of OpenSRF from the https://evergreen-ils.org/opensrf-downloads/[OpenSRF download page]. -. As the *opensrf* user, download and extract Evergreen 3.X.X: +. As the *opensrf* user, download and extract Evergreen 3.7.4: + [source, bash] ----------------------------------------------- -wget https://evergreen-ils.org/downloads/Evergreen-ILS-3.X.X.tar.gz -tar xzf Evergreen-ILS-3.X.X.tar.gz +wget https://evergreen-ils.org/downloads/Evergreen-ILS-3.7.4.tar.gz +tar xzf Evergreen-ILS-3.7.4.tar.gz ----------------------------------------------- + [NOTE] @@ -58,7 +58,7 @@ For the latest edition of Evergreen, check the https://evergreen-ils.org/egdownl + [source, bash] --------------------------------------------- -cd /home/opensrf/Evergreen-ILS-3.X.X +cd /home/opensrf/Evergreen-ILS-3.7.4 --------------------------------------------- + On the next command, replace `[distribution]` with one of these values for your @@ -82,7 +82,7 @@ make -f Open-ILS/src/extras/Makefile.install [distribution] + [source, bash] ------------------------------------------------------------ -cd /home/opensrf/Evergreen-ILS-3.X.X +cd /home/opensrf/Evergreen-ILS-3.7.4 PATH=/openils/bin:$PATH ./configure --prefix=/openils --sysconfdir=/openils/conf make ------------------------------------------------------------ @@ -93,7 +93,7 @@ These instructions assume that you have also installed OpenSRF under /openils/. + [source, bash] ------------------------------------------------------------ -cd /home/opensrf/Evergreen-ILS-3.X.X +cd /home/opensrf/Evergreen-ILS-3.7.4 make install ------------------------------------------------------------ + @@ -104,8 +104,8 @@ can supply `STAFF_CLIENT_STAMP` during the `make install` step like this: + [source, bash] ------------------------------------------------------------ -cd /home/opensrf/Evergreen-ILS-3.X.X -make STAFF_CLIENT_STAMP_ID=rel_3_x_x install +cd /home/opensrf/Evergreen-ILS-3.7.4 +make STAFF_CLIENT_STAMP_ID=rel_3_7_4 install ------------------------------------------------------------ + . As the *root* user, change all files to be owned by the opensrf user and group: @@ -122,7 +122,7 @@ chown -R opensrf:opensrf /openils ------------------------------------------------------------ cd /openils/var/web/xul/ rm server -ln -sf rel_3_x_x/server server +ln -sf rel_3_7_4/server server ------------------------------------------------------------ + . As the *opensrf* user, update opensrf_core.xml and opensrf.xml by copying the @@ -142,7 +142,7 @@ Copying these configuration files will remove any customizations you have made t + [source, bash] ------------------------------------------------------------------------- -cd /home/opensrf/Evergreen-ILS-3.X.X +cd /home/opensrf/Evergreen-ILS-3.7.4 perl Open-ILS/src/support-scripts/eg_db_config --update-config --service all \ --create-offline --database evergreen --host localhost --user evergreen --password evergreen ------------------------------------------------------------------------- @@ -166,21 +166,21 @@ The diff command can be used to show the differences between the distribution ve + [source, bash] ---------------------------------------------------------- -cp /home/opensrf/Evergreen-ILS-3.X.X/Open-ILS/examples/apache/eg_startup /etc/apache2/eg_startup +cp /home/opensrf/Evergreen-ILS-3.7.4/Open-ILS/examples/apache/eg_startup /etc/apache2/eg_startup ---------------------------------------------------------- + .. Update /etc/apache2/eg_vhost.conf by copying the example from Open-ILS/examples/apache/eg_vhost.conf. + [source, bash] ---------------------------------------------------------- -cp /home/opensrf/Evergreen-ILS-3.X.X/Open-ILS/examples/apache/eg_vhost.conf /etc/apache2/eg_vhost.conf +cp /home/opensrf/Evergreen-ILS-3.7.4/Open-ILS/examples/apache/eg_vhost.conf /etc/apache2/eg_vhost.conf ---------------------------------------------------------- + .. Update /etc/apache2/sites-available/eg.conf by copying the example from Open-ILS/examples/apache/eg.conf. + [source, bash] ---------------------------------------------------------- -cp /home/opensrf/Evergreen-ILS-3.X.X/Open-ILS/examples/apache/eg.conf /etc/apache2/sites-available/eg.conf +cp /home/opensrf/Evergreen-ILS-3.7.4/Open-ILS/examples/apache/eg.conf /etc/apache2/sites-available/eg.conf ---------------------------------------------------------- == Upgrade the Evergreen database schema == @@ -236,8 +236,8 @@ as a user with the ability to connect to the database server. [source, bash] ---------------------------------------------------------- -cd /home/opensrf/Evergreen-ILS-3.X.X/Open-ILS/src/sql/Pg -psql -U evergreen -h localhost -f version-upgrade/3.X.W-3.X.X-upgrade-db.sql evergreen +cd /home/opensrf/Evergreen-ILS-3.7.4/Open-ILS/src/sql/Pg +psql -U evergreen -h localhost -f version-upgrade/3.7.3-3.7.4-upgrade-db.sql evergreen ---------------------------------------------------------- [TIP]