Skip to content

Fix migration guide rendering #556

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 9, 2025
Merged

Fix migration guide rendering #556

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
39570c2
Fix utf-8 symbol
sfodagain May 5, 2025
ea4b225
Use markdown for footnotes
sfodagain May 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions documents/MIGRATION_GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,19 +168,19 @@ section of the MQTT5 user guide for detailed information and code snippets on ea
> [!NOTE]
> Both v1 and v2 SDKs support only SigV4 and Custom authentication in browser environment.

| Connection type/feature | v1 SDK - Node.js | v1 SDK - browser |v2 SDK - Node.js | v2 SDK - browser |User guide section|
|------------------------------------------------------------------------|---------------------------------------|---------------------------------------|----------------------------------|----------------------------------|------------------|
| MQTT over Secure WebSocket with AWS SigV4 authentication | $${\Large\color{green}&#10004}$$ | $${\Large\color{green}&#10004}$$ | $${\Large\color{green}&#10004}$$ | $${\Large\color{green}&#10004}$$ | [Node.js section](https://github.com/awslabs/aws-crt-nodejs/blob/main/MQTT5-UserGuide.md#mqtt-over-websockets-with-sigv4-authentication) [Browser section](https://github.com/awslabs/aws-crt-nodejs/blob/main/MQTT5-UserGuide.md#mqtt-over-websockets-with-sigv4-authentication-1) |
| MQTT over Secure WebSocket with Cognito Authentication Method | $${\Large\color{green}&#10004}$$ | $${\Large\color{green}&#10004}$$ | $${\Large\color{green}&#10004}$$ | $${\Large\color{green}&#10004}$$ | [Node.js section](https://github.com/awslabs/aws-crt-nodejs/blob/main/MQTT5-UserGuide.md#mqtt-over-websockets-with-sigv4-authentication) |
| MQTT over Secure WebSocket with Custom Authentication | $${\Large\color{green}&#10004}$$ | $${\Large\color{green}&#10004}$$ | $${\Large\color{green}&#10004}$$ | $${\Large\color{green}&#10004}$$ | [Node.js section](https://github.com/awslabs/aws-crt-nodejs/blob/main/MQTT5-UserGuide.md#direct-mqtt-with-custom-authentication) [Browser section](https://github.com/awslabs/aws-crt-nodejs/blob/main/MQTT5-UserGuide.md#mqtt-over-websockets-with-custom-authentication) |
| MQTT (over TLS 1.2) with X.509 certificate based mutual authentication | $${\Large\color{green}&#10004}$$ | $${\Large\color{red}&#10008}$$ | $${\Large\color{green}&#10004}$$ | $${\Large\color{red}&#10008}$$ | [Node.js section](https://github.com/awslabs/aws-crt-nodejs/blob/main/MQTT5-UserGuide.md#direct-mqtt-with-x509-based-mutual-tls) |
| MQTT with PKCS12 Method | $${\Large\color{orange}&#10004\*}$$ | $${\Large\color{red}&#10008}$$ | $${\Large\color{green}&#10004}$$ | $${\Large\color{red}&#10008}$$ | [Node.js section](https://github.com/awslabs/aws-crt-nodejs/blob/main/MQTT5-UserGuide.md#direct-mqtt-with-pkcs12-method) |
| MQTT with Windows Certificate Store Method | $${\Large\color{red}&#10008}$$ | $${\Large\color{red}&#10008}$$ | $${\Large\color{green}&#10004}$$ | $${\Large\color{red}&#10008}$$ | [Node.js section](https://github.com/awslabs/aws-crt-nodejs/blob/main/MQTT5-UserGuide.md#direct-mqtt-with-windows-certificate-store-method) |
| MQTT with PKCS11 Method | $${\Large\color{red}&#10008}$$ | $${\Large\color{red}&#10008}$$ | $${\Large\color{green}&#10004}$$ | $${\Large\color{red}&#10008}$$ | [Node.js section](https://github.com/awslabs/aws-crt-nodejs/blob/main/MQTT5-UserGuide.md#direct-mqtt-with-pkcs11-method) |
| HTTP Proxy | $${\Large\color{orange}&#10004\*\*}$$ | $${\Large\color{orange}&#10004\*\*}$$ | $${\Large\color{green}&#10004}$$ | $${\Large\color{green}&#10004}$$ | [Node.js section](https://github.com/awslabs/aws-crt-nodejs/blob/main/MQTT5-UserGuide.md#http-proxy) [Browser section](https://github.com/awslabs/aws-crt-nodejs/blob/main/MQTT5-UserGuide.md#http-proxy-1) |

${\Large\color{orange}&#10004\*}$ - To get this connection type work in the v1 SDK, you need to extract a private key from a PKCS #12 file.\
${\Large\color{orange}&#10004\*\*}$ - The v1 SDK does not allow specifying HTTP proxy, but it is possible to configure systemwide proxy.
| Connection type/feature | v1 SDK - Node.js | v1 SDK - browser | v2 SDK - Node.js | v2 SDK - browser |User guide section|
|------------------------------------------------------------------------|---------------------------------------------------|---------------------------------------------------|-----------------------------------|-----------------------------------|------------------|
| MQTT over Secure WebSocket with AWS SigV4 authentication | $${\Large\color{green}✔}$$ | $${\Large\color{green}✔}$$ | $${\Large\color{green}✔}$$ | $${\Large\color{green}✔}$$ | [Node.js section](https://github.com/awslabs/aws-crt-nodejs/blob/main/MQTT5-UserGuide.md#mqtt-over-websockets-with-sigv4-authentication) [Browser section](https://github.com/awslabs/aws-crt-nodejs/blob/main/MQTT5-UserGuide.md#mqtt-over-websockets-with-sigv4-authentication-1) |
| MQTT over Secure WebSocket with Cognito Authentication Method | $${\Large\color{green}✔}$$ | $${\Large\color{green}✔}$$ | $${\Large\color{green}✔}$$ | $${\Large\color{green}✔}$$ | [Node.js section](https://github.com/awslabs/aws-crt-nodejs/blob/main/MQTT5-UserGuide.md#mqtt-over-websockets-with-sigv4-authentication) |
| MQTT over Secure WebSocket with Custom Authentication | $${\Large\color{green}✔}$$ | $${\Large\color{green}✔}$$ | $${\Large\color{green}✔}$$ | $${\Large\color{green}✔}$$ | [Node.js section](https://github.com/awslabs/aws-crt-nodejs/blob/main/MQTT5-UserGuide.md#direct-mqtt-with-custom-authentication) [Browser section](https://github.com/awslabs/aws-crt-nodejs/blob/main/MQTT5-UserGuide.md#mqtt-over-websockets-with-custom-authentication) |
| MQTT (over TLS 1.2) with X.509 certificate based mutual authentication | $${\Large\color{green}✔}$$ | $${\Large\color{red}✘}$$ | $${\Large\color{green}✔}$$ | $${\Large\color{red}✘}$$ | [Node.js section](https://github.com/awslabs/aws-crt-nodejs/blob/main/MQTT5-UserGuide.md#direct-mqtt-with-x509-based-mutual-tls) |
| MQTT with PKCS12 Method | $${\Large\color{orange}&#10004;}$$<sup>\*</sup> | $${\Large\color{red}&#10008;}$$ | $${\Large\color{green}&#10004;}$$ | $${\Large\color{red}&#10008;}$$ | [Node.js section](https://github.com/awslabs/aws-crt-nodejs/blob/main/MQTT5-UserGuide.md#direct-mqtt-with-pkcs12-method) |
| MQTT with Windows Certificate Store Method | $${\Large\color{red}&#10008;}$$ | $${\Large\color{red}&#10008;}$$ | $${\Large\color{green}&#10004;}$$ | $${\Large\color{red}&#10008;}$$ | [Node.js section](https://github.com/awslabs/aws-crt-nodejs/blob/main/MQTT5-UserGuide.md#direct-mqtt-with-windows-certificate-store-method) |
| MQTT with PKCS11 Method | $${\Large\color{red}&#10008;}$$ | $${\Large\color{red}&#10008;}$$ | $${\Large\color{green}&#10004;}$$ | $${\Large\color{red}&#10008;}$$ | [Node.js section](https://github.com/awslabs/aws-crt-nodejs/blob/main/MQTT5-UserGuide.md#direct-mqtt-with-pkcs11-method) |
| HTTP Proxy | $${\Large\color{orange}&#10004;}$$<sup>\*\*</sup> | $${\Large\color{orange}&#10004;}$$<sup>\*\*</sup> | $${\Large\color{green}&#10004;}$$ | $${\Large\color{green}&#10004;}$$ | [Node.js section](https://github.com/awslabs/aws-crt-nodejs/blob/main/MQTT5-UserGuide.md#http-proxy) [Browser section](https://github.com/awslabs/aws-crt-nodejs/blob/main/MQTT5-UserGuide.md#http-proxy-1) |

${\Large\color{orange}&#10004;}$<sup>\*</sup> - To get this connection type work in the v1 SDK, you need to extract a private key from a PKCS #12 file.\
${\Large\color{orange}&#10004;}$<sup>\*\*</sup> - The v1 SDK does not allow specifying HTTP proxy, but it is possible to configure systemwide proxy.

#### Example of creating connection in the v1 SDK

Expand Down
Loading