[EDU-2105] - Render both auth examples in examples page by GregHolmes · Pull Request #2920 · ably/docs

GregHolmes · 2025-10-27T11:14:05Z

Description

Checklist

Commits have been rebased.
Linting has been run against the changed file(s).
The PR adheres to the writing style guide and contribution guide.

coderabbitai · 2025-10-27T11:14:22Z

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

🔍 Trigger review

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch EDU-2105-Update-JWT-and-token-auth-examples-to-use-Ably-demo-endpoint

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

m-hulbert

A few minor comments and we're there. Are we ably to raise the profile of the note about which method to prefer with an Aside or similar?

m-hulbert · 2026-02-24T15:31:42Z

examples/auth-generate-jwt/react/README.md

-Authentication is the first step for an application to communicate with Ably. The application initializes a client and calls a predefined `authUrl` endpoint on your backend server. This endpoint uses an API key to request a JWT from Ably and returns it to the requesting client. When the JWT nears expiry, the `authUrl` is automatically invoked to request a new JWT.
+Authentication is the first step for an application to communicate with Ably. The application initializes a client with an `authCallback` that fetches credentials from your backend server. This endpoint uses an API key to generate a JWT and returns it to the requesting client. When the JWT nears expiry, the `authCallback` is automatically invoked to request a new JWT.

 Authentication is implemented using [Ably Pub/Sub](https://ably.com/docs/auth). The Pub/Sub SDK provides the authentication mechanism that is utilized by all Ably products. It provides a set of flexible APIs capable of building any realtime application and is powered by Ably's reliable and scalable platform.


Suggested change

Authentication is implemented using [Ably Pub/Sub](https://ably.com/docs/auth). The Pub/Sub SDK provides the authentication mechanism that is utilized by all Ably products. It provides a set of flexible APIs capable of building any realtime application and is powered by Ably's reliable and scalable platform.

Authentication is implemented using [Ably Pub/Sub](https://ably.com/docs/auth). The Pub/Sub SDK provides the authentication mechanism that is utilized by all Ably products.

m-hulbert · 2026-02-24T15:31:56Z

examples/auth-request-token/javascript/README.md

-Authentication is the first step for an application to communicate with Ably. The application initializes a client and calls a predefined `authUrl` endpoint on your backend server. This endpoint uses an API key to request a token from Ably and returns it to the requesting client. When the token nears expiry, the `authUrl` is automatically invoked to request a new token.
+Authentication is the first step for an application to communicate with Ably. The application initializes a client with an `authCallback` that fetches credentials from your backend server. This endpoint uses an API key to request a token from Ably and returns it to the requesting client. When the token nears expiry, the `authCallback` is automatically invoked to request a new token.

 Authentication is implemented using [Ably Pub/Sub](/docs/auth). The Pub/Sub SDK provides the authentication mechanism that is utilized by all Ably products. It provides a set of flexible APIs capable of building any realtime application and is powered by Ably's reliable and scalable platform.


Suggested change

Authentication is implemented using [Ably Pub/Sub](/docs/auth). The Pub/Sub SDK provides the authentication mechanism that is utilized by all Ably products. It provides a set of flexible APIs capable of building any realtime application and is powered by Ably's reliable and scalable platform.

Authentication is implemented using [Ably Pub/Sub](/docs/auth). The Pub/Sub SDK provides the authentication mechanism that is utilized by all Ably products.

m-hulbert · 2026-02-24T15:34:04Z

examples/auth-request-token/javascript/README.md


 Authentication is implemented using [Ably Pub/Sub](/docs/auth). The Pub/Sub SDK provides the authentication mechanism that is utilized by all Ably products. It provides a set of flexible APIs capable of building any realtime application and is powered by Ably's reliable and scalable platform.

+> **Note:** For most use cases, [JWTs](/docs/auth/token#jwt) are the recommended authentication method. They enable you to issue credentials without making a request to Ably, reducing latency and server dependencies. Ably Tokens are primarily useful when you need to use the Ably SDKs on the server-side to generate tokens with specific capabilities.


So the only time we're pointing people to use Ably Tokens are:

Your capability list is too large and exceeds JWT size limits. JWTs must fit within HTTP header limits, typically around 8 KB.

You need to keep your capability list confidential, as JWTs can be decoded by clients.

You already have a JWT-based auth system and want to embed Ably tokens within your existing JWTs.

And I think we should be more firm with it - i.e. "Only use an Ably Token when:"

m-hulbert · 2026-02-24T15:35:28Z

src/data/examples/index.ts

+  },
+  {
+    id: 'auth-request-token',
+    name: 'Request Token',


Suggested change

name: 'Request Token',

name: 'Request an Ably Token',

m-hulbert

LGTM!

- auth-generate-jwt: Switch JavaScript and React clients to authCallback - auth-request-token: Switch JavaScript and React clients to authCallback - Fix ES module compatibility (__dirname) in both servers - Change dotenv to load .env instead of .env.local - Fix JWT response format (send as text, not JSON)

GregHolmes self-assigned this Oct 27, 2025

GregHolmes added DRAFT Draft PR - do not review review-app Create a Heroku review app labels Oct 27, 2025

ably-ci temporarily deployed to ably-docs-edu-2105-upda-4vwecg October 27, 2025 11:14 Inactive

GregHolmes force-pushed the EDU-2105-Update-JWT-and-token-auth-examples-to-use-Ably-demo-endpoint branch from 2fa8833 to 3c5aeb5 Compare October 27, 2025 11:58

GregHolmes temporarily deployed to ably-docs-edu-2105-upda-4vwecg October 27, 2025 11:58 Inactive

GregHolmes temporarily deployed to ably-docs-edu-2105-upda-4vwecg October 27, 2025 12:08 Inactive

GregHolmes temporarily deployed to ably-docs-edu-2105-upda-4vwecg October 27, 2025 12:09 Inactive

GregHolmes force-pushed the EDU-2105-Update-JWT-and-token-auth-examples-to-use-Ably-demo-endpoint branch from d53fd73 to 35db3af Compare October 27, 2025 12:09

GregHolmes temporarily deployed to ably-docs-edu-2105-upda-4vwecg October 27, 2025 12:09 Inactive

GregHolmes force-pushed the EDU-2105-Update-JWT-and-token-auth-examples-to-use-Ably-demo-endpoint branch from 35db3af to e071f69 Compare October 27, 2025 12:10

GregHolmes temporarily deployed to ably-docs-edu-2105-upda-4vwecg October 27, 2025 12:10 Inactive

GregHolmes temporarily deployed to ably-docs-edu-2105-upda-4vwecg October 27, 2025 12:12 Inactive

GregHolmes force-pushed the EDU-2105-Update-JWT-and-token-auth-examples-to-use-Ably-demo-endpoint branch from de1dab6 to e3088cc Compare October 27, 2025 12:12

GregHolmes changed the title ~~DRAFT: [EDU-2105] - Update JWT auth example~~ [EDU-2105] - Update JWT auth example Oct 27, 2025

GregHolmes temporarily deployed to ably-docs-edu-2105-upda-4vwecg October 27, 2025 12:13 Inactive

GregHolmes changed the title ~~[EDU-2105] - Update JWT auth example~~ [EDU-2105] - Render both auth examples in examples page Oct 27, 2025

GregHolmes force-pushed the EDU-2105-Update-JWT-and-token-auth-examples-to-use-Ably-demo-endpoint branch from e3088cc to 52f39b1 Compare October 27, 2025 15:22

GregHolmes temporarily deployed to ably-docs-edu-2105-upda-4vwecg October 27, 2025 15:23 Inactive

GregHolmes force-pushed the EDU-2105-Update-JWT-and-token-auth-examples-to-use-Ably-demo-endpoint branch from 52f39b1 to 3a04d13 Compare November 4, 2025 09:05

GregHolmes temporarily deployed to ably-docs-edu-2105-upda-sjytlb November 4, 2025 09:30 Inactive

GregHolmes force-pushed the EDU-2105-Update-JWT-and-token-auth-examples-to-use-Ably-demo-endpoint branch from 3a04d13 to 5b6adab Compare November 11, 2025 16:26

GregHolmes added review-app Create a Heroku review app and removed review-app Create a Heroku review app labels Nov 11, 2025

ably-ci temporarily deployed to ably-docs-edu-2105-upda-guiyoc November 11, 2025 16:33 Inactive

GregHolmes temporarily deployed to ably-docs-edu-2105-upda-jofx5r November 12, 2025 10:02 Inactive

GregHolmes force-pushed the EDU-2105-Update-JWT-and-token-auth-examples-to-use-Ably-demo-endpoint branch 3 times, most recently from 8c5fdc3 to 2fd278a Compare January 21, 2026 11:08

GregHolmes added review-app Create a Heroku review app and removed review-app Create a Heroku review app labels Feb 23, 2026

ably-ci temporarily deployed to ably-docs-edu-2105-upda-iclapk February 23, 2026 11:03 Inactive

GregHolmes force-pushed the EDU-2105-Update-JWT-and-token-auth-examples-to-use-Ably-demo-endpoint branch from a309b5d to b10a0b2 Compare February 23, 2026 11:21

GregHolmes temporarily deployed to ably-docs-edu-2105-upda-iclapk February 23, 2026 11:21 Inactive

GregHolmes temporarily deployed to ably-docs-edu-2105-upda-iclapk February 23, 2026 11:24 Inactive

kennethkalmer temporarily deployed to ably-docs-edu-2105-upda-iclapk February 23, 2026 12:07 Inactive

kennethkalmer temporarily deployed to ably-docs-edu-2105-upda-iclapk February 23, 2026 12:45 Inactive

kennethkalmer temporarily deployed to ably-docs-edu-2105-upda-iclapk February 23, 2026 12:56 Inactive

kennethkalmer temporarily deployed to ably-docs-edu-2105-upda-iclapk February 24, 2026 09:34 Inactive

kennethkalmer temporarily deployed to ably-docs-edu-2105-upda-iclapk February 24, 2026 13:51 Inactive

m-hulbert reviewed Feb 24, 2026

View reviewed changes

GregHolmes temporarily deployed to ably-docs-edu-2105-upda-iclapk February 24, 2026 16:08 Inactive

GregHolmes force-pushed the EDU-2105-Update-JWT-and-token-auth-examples-to-use-Ably-demo-endpoint branch from fd12610 to 9753514 Compare February 24, 2026 16:08

GregHolmes temporarily deployed to ably-docs-edu-2105-upda-iclapk February 24, 2026 16:08 Inactive

GregHolmes temporarily deployed to ably-docs-edu-2105-upda-iclapk February 24, 2026 16:10 Inactive

GregHolmes deployed to ably-docs-edu-2105-upda-iclapk February 24, 2026 16:20 View deployment

GregHolmes requested a review from m-hulbert February 24, 2026 16:25

m-hulbert approved these changes Feb 24, 2026

View reviewed changes

GregHolmes force-pushed the EDU-2105-Update-JWT-and-token-auth-examples-to-use-Ably-demo-endpoint branch from 3f69b18 to 8894554 Compare February 24, 2026 16:50

GregHolmes temporarily deployed to ably-docs-edu-2105-upda-iclapk February 24, 2026 16:51 Inactive

GregHolmes added review-app Create a Heroku review app and removed review-app Create a Heroku review app labels Feb 24, 2026

GregHolmes force-pushed the EDU-2105-Update-JWT-and-token-auth-examples-to-use-Ably-demo-endpoint branch from 8894554 to 5c335d0 Compare February 25, 2026 09:27

GregHolmes added 3 commits February 25, 2026 09:59

Update and enable Auth JWT example

630d667

Update and enable Auth Token example

f8ab730

GregHolmes force-pushed the EDU-2105-Update-JWT-and-token-auth-examples-to-use-Ably-demo-endpoint branch from 5c335d0 to a5bf8c3 Compare February 25, 2026 09:59

GregHolmes merged commit 4b341fc into main Feb 25, 2026
7 checks passed

GregHolmes deleted the EDU-2105-Update-JWT-and-token-auth-examples-to-use-Ably-demo-endpoint branch February 25, 2026 10:08

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[EDU-2105] - Render both auth examples in examples page#2920

[EDU-2105] - Render both auth examples in examples page#2920
GregHolmes merged 3 commits intomainfrom
EDU-2105-Update-JWT-and-token-auth-examples-to-use-Ably-demo-endpoint

GregHolmes commented Oct 27, 2025

Uh oh!

coderabbitai bot commented Oct 27, 2025 •

edited

Loading

Review skipped

Uh oh!

m-hulbert left a comment

Uh oh!

m-hulbert Feb 24, 2026

Uh oh!

GregHolmes Feb 24, 2026

Uh oh!

m-hulbert Feb 24, 2026

Uh oh!

GregHolmes Feb 24, 2026

Uh oh!

m-hulbert Feb 24, 2026

Uh oh!

m-hulbert Feb 24, 2026

Uh oh!

GregHolmes Feb 24, 2026

Uh oh!

m-hulbert left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

6 participants

	Authentication is implemented using [Ably Pub/Sub](https://ably.com/docs/auth). The Pub/Sub SDK provides the authentication mechanism that is utilized by all Ably products. It provides a set of flexible APIs capable of building any realtime application and is powered by Ably's reliable and scalable platform.
	Authentication is implemented using [Ably Pub/Sub](https://ably.com/docs/auth). The Pub/Sub SDK provides the authentication mechanism that is utilized by all Ably products.


		Authentication is implemented using [Ably Pub/Sub](/docs/auth). The Pub/Sub SDK provides the authentication mechanism that is utilized by all Ably products. It provides a set of flexible APIs capable of building any realtime application and is powered by Ably's reliable and scalable platform.

		> Note: For most use cases, [JWTs](/docs/auth/token#jwt) are the recommended authentication method. They enable you to issue credentials without making a request to Ably, reducing latency and server dependencies. Ably Tokens are primarily useful when you need to use the Ably SDKs on the server-side to generate tokens with specific capabilities.

Conversation

GregHolmes commented Oct 27, 2025

Description

Checklist

Uh oh!

coderabbitai bot commented Oct 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Uh oh!

m-hulbert left a comment

Choose a reason for hiding this comment

Uh oh!

m-hulbert Feb 24, 2026

Choose a reason for hiding this comment

Uh oh!

GregHolmes Feb 24, 2026

Choose a reason for hiding this comment

Uh oh!

m-hulbert Feb 24, 2026

Choose a reason for hiding this comment

Uh oh!

GregHolmes Feb 24, 2026

Choose a reason for hiding this comment

Uh oh!

m-hulbert Feb 24, 2026

Choose a reason for hiding this comment

Uh oh!

m-hulbert Feb 24, 2026

Choose a reason for hiding this comment

Uh oh!

GregHolmes Feb 24, 2026

Choose a reason for hiding this comment

Uh oh!

m-hulbert left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

6 participants

coderabbitai bot commented Oct 27, 2025 •

edited

Loading