Add deprecation and compatibility notes.
Project: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-website/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-website/commit/5bb6959e Tree: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-website/tree/5bb6959e Diff: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-website/diff/5bb6959e Branch: refs/heads/master Commit: 5bb6959eb87518044eda6e0dade770be25b1594a Parents: 61793df Author: Michael Jumper <[email protected]> Authored: Sat Dec 3 21:14:27 2016 -0800 Committer: Michael Jumper <[email protected]> Committed: Sat Dec 3 21:14:27 2016 -0800 ---------------------------------------------------------------------- _releases/0.9.10-incubating.md | 90 +++++++++++++++++++++++++++++++++++++ 1 file changed, 90 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-guacamole-website/blob/5bb6959e/_releases/0.9.10-incubating.md ---------------------------------------------------------------------- diff --git a/_releases/0.9.10-incubating.md b/_releases/0.9.10-incubating.md index cdbd274..c06e9f4 100644 --- a/_releases/0.9.10-incubating.md +++ b/_releases/0.9.10-incubating.md @@ -38,6 +38,9 @@ Local clipboard integration has also been added (for those browsers which support it), as well as audio input for RDP, theming/branding via extensions, and several other improvements. +**This release contains changes which break compatibility with past releases.** +Please see the [deprecation / compatibility +notes](#deprecation--compatibility-notes) section for more information. We're incubating! ----------------- @@ -252,3 +255,90 @@ typos in Guacamole's French translation. * [GUACAMOLE-112](https://issues.apache.org/jira/browse/GUACAMOLE-112) - Update MessageFormat * [GUACAMOLE-115](https://issues.apache.org/jira/browse/GUACAMOLE-115) - Client may not cleanly disconnect if tunnel read() is blocking + +Deprecation / Compatibility notes +================================= + +As of 0.9.10-incubating, the following changes have been made which affect +compatibility with past releases: + + +Database schema changes +----------------------- + +The MySQL and PostgreSQL schemas have changed to facilitate screen sharing +support. Users of the database authentication will need to run the +`upgrade-pre-0.9.10.sql` script specific to their chosen database. + + +Deprecation of the `basic-user-mapping` property +------------------------------------------------ + +The `basic-user-mapping` property used to specify an alternative location for +`user-mapping.xml` is now deprecated. The property will continue to function as +in previous releases, but a warning will be logged advising of its deprecation. + +Administrators should instead place their `user-mapping.xml` files directly +within [`GUACAMOLE_HOME`](/doc/0.9.10-incubating/gug/configuring-guacamole.html#guacamole-home). + + +Removal of deprecated `lib-directory` and `auth-provider` properties +-------------------------------------------------------------------- + +The `lib-directory` and `auth-provider` properties have been deprecated since +the 0.9.7 release, in favor of a self-contained extension format which does not +require their use. From 0.9.7 on, though these properties still functioned as +in 0.9.6 and older, a warning was logged advising of their deprecation. + +These properties have now been removed, and configurations which rely on these +properties will need to use the `extensions/` directory within +[`GUACAMOLE_HOME`](/doc/0.9.10-incubating/gug/configuring-guacamole.html#guacamole-home) +instead. + + +Rename from `org.glyptodon.guacamole` to `org.apache.guacamole` +--------------------------------------------------------------- + +As Guacamole is now a project operating under the Apache Incubator, its Java +classes and Maven artifacts have moved from the `org.glyptodon.guacamole` +package and groupId to `org.apache.guacamole`. Downstream developers using +Guacamole's APIs will need to update their source code accordingly. + + +Extension API changes for screen sharing +---------------------------------------- + +The Guacamole extension API (guacamole-ext) been changed to provide for storage +of sharing profile data, and to allow for extensions to generate temporary +credentials for shared connections. If you have written an extension for +Guacamole, you may need to implement additional functions in addition to +rebuilding your extension against the latest. + +These changes center around the addition of the [`Shareable`](/doc/0.9.10-incubating/guacamole-ext/org/apache/guacamole/net/auth/Shareable.html) and +[`SharingProfile`](/doc/0.9.10-incubating/guacamole-ext/org/apache/guacamole/net/auth/SharingProfile.html) +interfaces, and primarily affect implementations of the following interfaces: + + * [`ActiveConnection`](/doc/0.9.10-incubating/guacamole-ext/org/apache/guacamole/net/auth/ActiveConnection.html) + * [`UserContext`](/doc/0.9.10-incubating/guacamole-ext/org/apache/guacamole/net/auth/UserContext.html) + +The [updated guacamole-ext +overview](/doc/0.9.10-incubating/gug/guacamole-ext.html) within the manual +covers these changes, particularly the [managing/sharing active +connections](/doc/0.9.10-incubating/gug/guacamole-ext.html#ext-active-connections) +section. + +libguac API changes +------------------- + +The libguac API has been extensively modified for the sake of screen sharing. +A new [`guac_user`](/doc/0.9.10-incubating/libguac/structguac__user.html) +structure has been added to represent each user sharing a logical connection, +where that connection is represented by +[`guac_client`](/doc/0.9.10-incubating/libguac/structguac__client.html). This +requires a completely new initialization flow for protocol support +implementations, and any plugins which provide additional protocol support for +guacd will need to be updated. + +These changes are documented in more detail in the [updated libguac +overview](/doc/0.9.10-incubating/gug/libguac.html) within the manual. +
