Version Compatibility
MTE Relay follows semantic versioning. Within a major version, releases are additive and backwards compatible.
Any frame version 2 client works with any v5 MTE Relay Server release. v5 servers speak frame version 2, and a server accepts the frame versions it advertises in discovery. MTE API Relay images pair only with other MTE API Relay images. Client SDK releases and server releases are maintained independently. You do not need to upgrade clients and servers in lockstep within v5.
v5 is a new major version with a new wire protocol. A v4 client cannot start a session with a v5 relay, a v5 client cannot pair with a v4 relay, and a v4 MTE API Relay cannot chain to a v5 one. See Upgrading from v4, and for v4 deployments the version 4 compatibility page.
Current v5 releases
| Component | Distribution | Current release |
|---|---|---|
| MTE Relay Server (MRS) | Container images | 5.0.5 |
| MTE API Relay (MAR) | Container images | 5.0.5 |
| Web JavaScript client | npm: mte-relay-browser-public-client | 5.0.0 |
| Browser engine | npm: mte-relay-browser | 5.0.0 |
| Java / Android client | Maven | 5.3.0 |
| Swift / iOS client | Swift Package Manager | 5.3.0 |
| Flutter client | Git checkout | 5.3.0 |
| Blazor client | Package reference | 5.0.0 |
| Python Requests client | Source checkout and MTE SDK | 5.0.0 |
| Python Locust client | Source checkout and MTE SDK | 5.0.0 |
| Angular client | npm: mte-relay-angular | 5.0.0 |
The public JavaScript client 5.0.0 bundles the browser engine 5.0.0 and the license for you. Both speak frame version 2. Browser engines that speak frame version 1 cannot connect to a v5 relay.
Upgrading
- Server images are tagged per release. Upgrading a server within v5 is redeploying with the new tag; no client changes are required.
- Features introduced mid major are marked in these docs with a badge, for example: Since 5.1.0. If you run an older minor, the badge tells you the minimum server version that supports the feature.
- Breaking changes only ever arrive with a new major version, which gets its own documentation set.