doc/RELEASE_NOTES.txt

   1 OpenSRF 3.0.2 release notes
   2 ===========================
   3
   4 Supported platforms
   5 -------------------
   6 The following Linux distributions are well-tested:
   7
   8   * Debian 7 (Wheezy), 8 (Jessie), and 9 (Stretch)
   9   * Ubuntu 14.04 (Trusty Tahr) and 16.04 LTS (Xenial Xerus)
  10
  11 OpenSRF 3.0.2
  12 -------------
  13 OpenSRF 3.0.2 was released on 6 November 2018 and fixes several
  14 bugs. All users of OpenSRF 3.0.x are advised to upgrade as soon
  15 as possible.
  16
  17 The following bugs are fixed:
  18
  19   * LP#1684970: When running behind a proxy such as NGINX, the HTTP
  20     translator was not getting the IP address of the user agent. As
  21     a consequence, it was possible that two different HTTP translator
  22     clients could end up talking to the same OpenSRF worker process.
  23     This issue is resolved by using the `remoteip` Apache module
  24     to extract the user agent's IP address from the X-Real-IP
  25     HTTP header.
  26   * LP#1702978: OpenSRF could fail to retrieve memcached values whose
  27     keys contain the '%' character. This resulted in breaking
  28     authentication in Evergreen when the username or barcode contained
  29     a '%'.
  30   * LP#1711145: The sample NGINX configuration file shipped with
  31     OpenSRF had weak SSL settings. As of this release, it now
  32     ** Enables http2
  33     ** Adds a commented section on enabling SSL everywhere.
  34     ** Apply a 5-minute proxy read timeout to avoid too-short timeouts on
  35       long API calls.
  36     ** Adds a commented section on sending NGINX logs to syslog.
  37     ** Includes INSTALL notes on generating the dhparam file.
  38   * LP#1776510: The JavaScript client code was not detecting when
  39     the WebSockets gateway threw a transport error, e.g. when a request
  40     was made of a nonexistent service. This situation can now be
  41     caught by error-handling callbacks.
  42
  43 Upgrade Notes
  44 ~~~~~~~~~~~~~
  45 Users of NGINX should adjust their configuration to match the revisions
  46 in `examples/nginx/osrf-ws-http-proxy`.
  47
  48 Users of Apache 2.4 and a proxy such as NGINX should enable the `remoteip`
  49 Apache module and apply the following configuration change to the Apache
  50 configuration:
  51
  52 [source,sh]
  53 ---------------------------------------------------------------------
  54     RemoteIPInternalProxy 127.0.0.1/24 # adjust for actual internal
  55                                        # address of proxy
  56     RemoteIPInternalProxy ::1
  57     RemoteIPHeader X-Real-IP
  58 ---------------------------------------------------------------------
  59
  60 Acknowledgments
  61 ~~~~~~~~~~~~~~~
  62 We would like to thank the following people who contributed to coding
  63 and testing for OpenSRF 3.0.2:
  64
  65   * Galen Charlton
  66   * Bill Erickson
  67   * Mike Rylander
  68   * Jason Stephenson
  69   * Cesar Velez
  70
  71 OpenSRF 3.0.1
  72 -------------
  73 OpenSRF 3.0.1 was released on 25 May 2018 and fixes a number of
  74 bugs. All users of OpenSRF 3.0.0 are advised to upgrade as soon
  75 as possible.
  76
  77 The following bugs are fixed:
  78
  79   * LP#1744158: If the WebSockets translator lost its XMPP connection,
  80     it could continue to accept requests but would never respond to
  81     them. Now, when a WS translator backend gets disconnected from
  82     XMPP, it will close the client connection and terminate.
  83   * LP#1746577: Under other conditions, a WebSockets translator backend
  84     that had lost its XMPP connection could busy-loop, uselessly
  85     consuming CPU. This no longer happens.
  86   * LP#1762815: This release Fixes an issue in the Perl client time zone
  87     handling that resulted in the server defaulting to UTC time instead
  88     of the server time zone when no time zone value was received from
  89     the client.
  90   * LP#1340892: `opensrf.settings` now properly ignores XML comments
  91     in `opensrf.xml`, thereby resolving an Evergreen bug where
  92     XML comments in the `<marctemplates>` section could break the
  93     ability to load MARC templates.
  94   * LP#1243841: A number of compilation warnings showing up on newer
  95     releases of Debian and Ubuntu are now resolved.
  96
  97 Acknowledgements
  98 ~~~~~~~~~~~~~~~~
  99 We would like to thank the following people who contributed to coding
 100 and testing for OpenSRF 3.0.1:
 101
 102   * Galen Charlton
 103   * Bill Erickson
 104   * Chris Sharp
 105   * Jason Stephenson
 106
 107 OpenSRF 3.0.0
 108 -------------
 109 OpenSRF 3.0.0 was released on 2 October 2017. It adds support
 110 for Debian 9 (Stretch).
 111
 112 Upgrade Notes
 113 ~~~~~~~~~~~~~
 114 OpenSRF 3.0 also changes how the shared libraries for services written in
 115 C are named.  If upgrading from an earlier version of OpenSRF,
 116 `opensrf.xml` should be edited so that shared library file names
 117 listed in the `<implementation>` tag start with "lib".  For example,
 118
 119 [source,sh]
 120 ---------------------------------------------------------------------
 121             <osrf.math>
 122                 <language>C</language>
 123                 <implementation>osrf_math.so</implementation>
 124 ---------------------------------------------------------------------
 125
 126 should be changed to:
 127
 128 [source,sh]
 129 ---------------------------------------------------------------------
 130             <osrf.math>
 131                 <language>C</language>
 132                 <implementation>libosrf_math.so</implementation>
 133 ---------------------------------------------------------------------
 134
 135 Note for Evergreen Users
 136 ~~~~~~~~~~~~~~~~~~~~~~~~
 137 OpenSRF 3.0.0 is the minimum version required to run Evergreen 3.0.
 138
 139 Acknowledgements
 140 ~~~~~~~~~~~~~~~~
 141
 142 We would like to thank the following people who contributed to OpenSRF 3.0.0:
 143
 144   * Galen Charlton
 145   * Ben Shum
 146   * Jason Stephenson