doc/RELEASE_NOTES.txt

   1 OpenSRF 3.2.0-beta
   2 ------------------
   3 OpenSRF 3.2.0-beta was released on 1 October 2019. This release adds
   4 support for Debian 10 Buster and deprecates the Apache `mod_websocket`
   5 backend for the WebSockets gateway but does not add new features.
   6
   7 Major Changes
   8 ~~~~~~~~~~~~~
   9
  10 Support for Debian 10 Buster (LP#1835458)
  11 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  12 OpenSRF 3.2 adds support for Debian 10 Buster. Debian 10 comes with
  13 ejabberd 18.12 (as compared to ejabberd 16.09 in Debian 9), which
  14 means that a `mod_legacy_auth` directive will need to be uncommented
  15 or added to the ejabberd configuration. However, Debian 10 is
  16 otherwise not significantly different from Debian 9 as far as OpenSRF
  17 is concerned.
  18
  19 Removal of Support for `mod_websocket` (LP#1834208)
  20 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  21 OpenSRF 3.2 formally removes support for using the Apache
  22 `mod_websocket` module to act as the WebSockets gateway to OpenSRF
  23 in favor of requiring `websocketed`. OpenSRF 3.2 also includes tweaks
  24 to the example NGINX and HAProxy configurations.
  25
  26 Folks upgrading from previous versions of OpenSRF who are using
  27 `mod_websocket` should follow the instructions for installing
  28 `websocketd`, then stop remove the `apache2-websockets` Apache
  29 instance before starting `websocketd`.
  30
  31 Removal of Variable Arguments for `md5sum()` (LP#1830642)
  32 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  33 The `md5sum()` utility function included in OpenSRF's C code
  34 no longer accepts variadic arguments, fixing a bug in Evergreen
  35 where a percent in a user password could prevent authentication
  36 from working.
  37
  38 Upgrade Notes
  39 ~~~~~~~~~~~~~
  40 OpenSRF 3.2 introduces changes to the application binary interface
  41 (ABI) for C applications. Consequently, Evergreen users should plan on
  42 recompiling Evergreen after installing OpenSRF 3.2.
  43
  44 Users of NGINX or HAProxy should review the example configuration files
  45 (respectively `examples/nginx/osrf-ws-http-proxy`
  46 or `examples/haproxy/osrf-ws-http-proxy`) and make adjustments to
  47 their production configuration accordingly.
  48
  49 Evergreen Compatibility
  50 ~~~~~~~~~~~~~~~~~~~~~~~
  51 OpenSRF 3.2 can be used by Evergreen 3.1.x, 3.2.x, 3.3.x, and 3.4.x.
  52
  53 Acknowledgements
  54 ~~~~~~~~~~~~~~~
  55
  56 We would like to thank the following people who contributed to OpenSRF 3.2.0-beta:
  57
  58   * Jason Boyer
  59   * Galen Charlton
  60   * Jeff Davis
  61   * Bill Erickson
  62   * Ben Shum
  63   * Jason Stephenson