Version Compatibility
MTE Relay follows semantic versioning. Within a major version, releases are strictly additive and backwards compatible.
The rule
Any v5 client works with any v5 server. You do not need to upgrade clients and servers in lockstep. Minor and patch releases never break compatibility inside the same major version.
v4 and v5 do not mix
v5 is a new major version. v4 clients cannot pair with v5 servers, and v5 clients cannot pair with v4 servers. For v4 deployments, use the version 4 documentation.
Current v5 releases​
| Component | Distribution | Current release |
|---|---|---|
| MTE Relay Server (MRS) | Container images | 5.0.0-beta.1 |
| MTE API Relay (MAR) | Container images | 5.0.0-beta.1 |
| Web JavaScript client | npm: mte-relay-browser-public-client (beta tag) | 5.0.0-beta.2 |
| Android client | Maven | See Android guide |
| iOS client | Swift Package Manager | See iOS guide |
| Flutter client | SPM / CocoaPods | See Flutter guides |
| Blazor client | Package reference | See Blazor guide |
| Angular client | npm | See Angular guide |
Upgrading​
- Server images are tagged per release. Upgrading a server is redeploying with the new tag; no client changes are required within the same major version.
- 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 (selectable in the navbar version dropdown).