-
Notifications
You must be signed in to change notification settings - Fork 46
Ftf 444 new dashboard docs #3061
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.
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
Open
franrob-projects
wants to merge
30
commits into
main
Choose a base branch
from
FTF-444-new-dashboard-docs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
30 commits
Select commit
Hold shift + click to select a range
53cc3f6
Updates acc overview page
franrob-projects 5d43cb1
Updates sso page
franrob-projects 37021d5
Updates 2fa page
franrob-projects cf32c91
Updates table on enterprise customization page
franrob-projects 2d0516f
Updates Programmatic management with Control API page
franrob-projects c6c7b8d
Updates App management overview page
franrob-projects 590363f
Updates App management overview page (part 2)
franrob-projects 2e6f0fd
Adds new folder and files for products
franrob-projects 601f134
Adds product > pub/sub page
franrob-projects 3b0e04f
Updates dev console to web client page
franrob-projects f291a50
Adds product > push page
franrob-projects ee4d315
Adds product > chat page
franrob-projects 56b3413
Adds product > spaces page
franrob-projects d9094f6
Adds product > liveobjects page
franrob-projects d14e2c3
Adds product > livesync page
franrob-projects dbd1562
Adds new pages for monitoring and config in nav
franrob-projects f557d28
Updates queues page
franrob-projects 5314c75
Updates connections page
franrob-projects f249d26
Adds logs page
franrob-projects e91f95b
Adds reports page
franrob-projects 1931df6
Adds integrations page
franrob-projects 7150824
Adds api-keys page
franrob-projects f1b2c82
Adds deletes old page
franrob-projects 5e78ffc
Adds settings page
franrob-projects e82a276
Deletes uneeded files
franrob-projects 5acee8f
Adds title ids
franrob-projects c6b5ae7
Fixes links
franrob-projects 1abe95a
Resolve merge conflicts between FTF-444-new-dashboard-docs and main
franrob-projects e9bc78e
Feedback
franrob-projects 4a08300
fixup! Feedback
franrob-projects File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file removed
BIN
-27.8 KB
src/images/content/screenshots/control-api/account-settings-menu-item.png
Binary file not shown.
Binary file removed
BIN
-24.2 KB
src/images/content/screenshots/control-api/my-access-tokens-menu-item.png
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| --- | ||
| title: Web client | ||
| meta_description: "Test and debug your application using the browser-based web client for realtime messaging, channel monitoring, and event tracking." | ||
| meta_keywords: "Ably web client, browser testing, realtime monitoring, connection status changes, channel activity, event logs" | ||
| redirect_from: | ||
| - /docs/account/app/console | ||
| --- | ||
|
|
||
| The web client provides a browser-based interface for testing and debugging your realtime application. Access the web client through your [app dashboard](https://ably.com/accounts/any/apps/any/console) under the Console section. It offers realtime insights into application-wide events, such as connection status changes and channel activity. | ||
|
|
||
|  | ||
|
|
||
| These features enable you to: | ||
|
|
||
| * Observe changes in connection status across the application. | ||
| * View activity on specific channels, including message traffic and channel events. | ||
| * Examine event logs to troubleshoot your application. | ||
|
|
||
| ## Application-wide events interface <a id="application-events"/> | ||
|
|
||
| The application-wide events interface allows you to monitor your application's health and activity in realtime. | ||
|
|
||
| The following explains the realtime monitoring tools in the application-wide events interface: | ||
|
|
||
| | Field | Description | | ||
| | ----- | ----------- | | ||
| | API key | The API key to access and view events within the app. | | ||
| | Average application-wide events per second (p/s) | This metric shows the average number of events occurring per second across your application. For example, if the current rate is 0, no active events are being processed. | | ||
| | Event log table | The event log table displays a record of events related to the current client's connection status. This table can be used to debug potential issues in your application. | | ||
|
|
||
| ## Message auditing and logging <a id="message-auditing"/> | ||
|
|
||
| The web client displays messages in realtime for debugging and testing purposes, but does not provide persistent message auditing or logging capabilities. Ably does not currently offer native functionality to view historical messages filtered by specific channels or client IDs for auditing purposes. | ||
|
|
||
| If you need to audit or log messages by channel or client ID, implement this functionality on the application side. Consider using: | ||
|
|
||
| - [Webhooks](/docs/platform/integrations/webhooks) to send message events to your logging system | ||
| - [Message queues](/docs/platform/integrations/queues) to process and store message data | ||
| - Client-side logging in your application code | ||
|
|
||
| For native message auditing features, [contact support](mailto:support@ably.com) to discuss requirements. | ||
|
|
||
| ## Channels <a id="channels"/> | ||
|
|
||
| The following is a step-by-step instructions for connecting to a channel, publishing messages. | ||
|
|
||
| ### Connect to a channel <a id="connect-channel"/> | ||
|
|
||
| Connect to a channel: | ||
|
|
||
| 1. **Enter a channel name** - In the channel name field, choose a name (e.g get-started). | ||
| 2. **Attach to channel** - Click the **attach to channel** button. This connects you to the **get-started** channel, enabling you to start publishing or subscribing to messages. | ||
| 3. **Monitor channel status** - The interface will display the channel status as **pending** and then **attached** once connected, confirming that the channel is ready for interaction. | ||
|
|
||
| ### Publish a message <a id="publish-message"/> | ||
|
|
||
| Publish a message: | ||
|
|
||
| 1. **Message data** - In the **message data** field, type a message (e.g. example). | ||
| 2. **Publish message** - Click the **publish message** button to send the message to the **get-started** channel. | ||
| 3. **View the message** - If you have a subscriber, it will receive and display the message in the console. | ||
|
|
||
| Interact with presence: | ||
|
|
||
| 1. **Client ID** - Enter a unique client ID to simulate joining the presence of the channel. | ||
| 2. **Enter presence** - Click **enter presence** to indicate that this client is now in the channel. | ||
| 3. **Monitor presence** - The interface will list all clients in the channel under **presence members**. | ||
|
|
||
| ### Control the channel <a id="control-channel"/> | ||
|
|
||
| Control the channel in the web client: | ||
|
|
||
| * **Detach** - Click **detach** to disconnect from the channel. | ||
| * **Pause** - Use **pause** to temporarily stop receiving messages. | ||
| * **Clear** - Click **clear** to clear the channel data or logs from the interface. | ||
47 changes: 47 additions & 0 deletions
47
src/pages/docs/platform/account/app/configuration/api-keys.mdx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| --- | ||
| title: API keys | ||
| meta_description: “Manage Ably API keys by creating, updating, setting restrictions, and exploring integration options.” | ||
| meta_keywords: "API keys, Ably, create key, update key, key restrictions, integration, webhooks, authentication" | ||
| redirect_from: | ||
| - /docs/account/app/api | ||
| --- | ||
|
|
||
| The API keys tab lists all API keys associated with your account and provides information on each key's capabilities and restrictions. Manage your API keys in the [app dashboard](https://ably.com/accounts/any/apps/any/app_keys) under the API Keys section. You can [create a new API key](#create) and manage an existing one. | ||
|
|
||
|  | ||
|
|
||
| <Aside data-type='note'> | ||
| Before setting up multiple API keys with different permissions or sharing API keys with untrusted parties, consider using [token authentication](/docs/auth/token) instead. Token authentication provides more flexible access control and better security for client-side applications. | ||
| </Aside> | ||
|
|
||
| ## Create a new API key <a id="create"/> | ||
|
|
||
| Create a new API key: | ||
|
|
||
| 1. Click **Create a new API key**. | ||
| 2. Assign a friendly name. | ||
| 3. Give the new API key a descriptive name (e.g. chat app key) so it is easy to identify later. | ||
|
|
||
| To manage an API key: set [capabilities](/docs/auth/capabilities), define resource restrictions, use revocable tokens for security, and adjust key settings as needed. | ||
|
|
||
| ### Capabilities <a id="capabilities"/> | ||
|
|
||
| [Capabilities](/docs/auth/capabilities) define what permissions your API key has. You can select from core messaging capabilities (subscribe, publish, presence), content management (message updates/deletes, annotations), data access (history, stats), push notifications, and administrative features. See the [capabilities documentation](/docs/auth/capabilities) for the complete list and detailed descriptions. | ||
|
|
||
| ### Set resource restrictions <a id="resource-restrictions"/> | ||
|
|
||
| Control which channels and queues the API key can access. You can choose from **None** (unrestricted access), **Only channels** (no queue access), **Only queues** (no channel access), or **Selected channels and queues** for specific access rules. | ||
|
|
||
| When selecting specific resources, provide a comma-separated list. Use exact names (`channel-name`) or wildcards (`namespace:*`). Queues need the `[queue]` prefix and meta channels use `[meta]`. See [capabilities documentation](/docs/auth/capabilities#wildcards) for wildcard syntax. | ||
|
|
||
| <Aside data-type='important'> | ||
| A single API key cannot support complex permission combinations, such as publish access on one channel and subscribe access on another. For such requirements, use [token authentication](/docs/auth/token) instead. | ||
| </Aside> | ||
|
|
||
| ### Revocable tokens <a id="revocable-tokens"/> | ||
|
|
||
| Enable [revocable tokens](/docs/auth/revocation#revocable-tokens) to enhance security by allowing shorter token lifetimes and the ability to revoke tokens issued by this API key. | ||
|
|
||
| ### Change your API key settings <a id="change-settings"/> | ||
|
|
||
| Click **Settings** on the required API key to change its settings. The same settings apply as when creating a new API key. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think you can just change the page title rather than the URL for this one for now.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure what you mean here sorry 🤔