About Kaazing WebSocket Gateway Releases and Upgrades

The Kaazing WebSocket Gateway release number consists of three digits separated by dots, with software changes denoted in order of major, minor, and maintenance release numbers. For example, Kaazing WebSocket Gateway release 4.x.y is represented as:

You can upgrade Kaazing WebSocket Gateway to a newer Gateway release that has a higher major or minor release number, or patch your current Gateway release (such as from release 3.5.10. to 3.5.11).

You can find the release number on the Command Center console, on the Kaazing download page, in README.txt, or in the Gateway startup log.

Supported Gateway Upgrade Paths

The following table shows the supported paths for Gateway upgrades (major and minor) and patch release updates.

If your current Gateway release is ... And you want to upgrade to Gateway release ... Then follow these upgrade instructions ... And consider the impact on Kaazing client migration and backward compatibility *
3.2 or earlier 4.0.x Contact Kaazing Support Contact Kaazing Support

3.3.x
3.4.x

3.5.x (for example, 3.4.1 to 3.5.11) Upgrade Kaazing WebSocket Gateway Recompilation of the Kaazing client code might be necessary, but code changes are not required.
3.5.x 3.5.y (for example, 3.5.11 to 3.5.11) Upgrade Kaazing WebSocket Gateway No code changes or recompilation of Kaazing client code is required.

3.3.x
3.4.x
3.5.x

4.0.x (for example, 3.5.11 to 4.0.3) Upgrade Kaazing WebSocket Gateway Code changes and/or recompilation of Kaazing client code might be necessary.

* See Kaazing Clients and Backward Compatibility

Upgrade Options

You can use the Windows or Linux installer to install the Gateway into conventional (default) operating system locations or you can choose to unpack the .zip for Windows or .tar.gz for Linux, UNIX, or Mac) into any directory location:

  • Run the Windows or Linux installer to install the Gateway into conventional operating system locations and automatically run the Gateway as a service. The newer release is installed in a separate KAAZING_HOME that is at the same level in the directory structure as the KAAZING_HOME for the earlier release. Earlier releases are not overwritten or removed. For example, jms/3.5 and jms/4.0 are separate but parallel directories. About KAAZING_HOME describes KAAZING_HOME in more detail.

    Note: You cannot run both releases at the same time unless you change the ports on one or the other. You cannot run two Gateways on the same hostname and port.

  • Unpack the .zip for Windows or .tar.gz for Linux, UNIX, or Mac and then uncompress the Gateway to any directory location and run it in place. You must take care to save user-modified files (such as the gateway-config.xml file) if you install the newer release in the same KAAZING_HOME as the earlier release. Earlier releases of the Gateway will be overwritten or removed.

Download and installation options are discussed in more detail in Setting Up Kaazing WebSocket Gateway.

Kaazing Clients and Backward Compatibility

Kaazing WebSocket Gateway provides backward compatibility for clients written using the Kaazing WebSocket Gateway (release 3.3.x through 3.5.x) APIs. Backward compatibility guarantees that you can use older clients (3.3.x or higher release) in a newer Gateway installation. However, to take advantage of new features, you must migrate your Java and JavaScript clients by migrating JavaScript and Java clients built using the Kaazing WebSocket Gateway 3.3 or higher libraries and APIs to the Kaazing WebSocket Gateway 4.x libraries and APIs. Kaazing WebSocket Gateway 4.0 supports all clients written using the Kaazing WebSocket Gateway 3.3 or higher APIs. You do not need to migrate your legacy (Flash, .NET, or Silverlight) clients to use Kaazing WebSocket Gateway 4.0.

Note: If you are using your own WebSocket client (not a client built using the Kaazing client APIs) do not migrate your clients using the instructions in this documentation. See the developer how-tos for information about how to integrate your client with Kaazing WebSocket Gateway according to your platform.

See Also

TOP