You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/account/app/index.textile
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
---
2
-
title: Overview
2
+
title: App management overview
3
3
meta_description: " Manage and monitor your applications on the Ably platform using the Ably dashboard. Create new apps, view existing ones, and configure settings from your browser."
Copy file name to clipboardExpand all lines: content/auth/index.textile
+8-8Lines changed: 8 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
---
2
-
title: Authentication
2
+
title: Authentication overview
3
3
meta_description: "Ably supports two main authentication schemes: basic authentication and token authentication. Token authentication can be implemented using JWTs, Ably tokens, and Ably token requests."
4
4
redirect_from:
5
5
- /docs/rest/authentication
@@ -19,15 +19,15 @@ redirect_from:
19
19
- /docs/general/_authentication_capabilities
20
20
---
21
21
22
-
Before a client or server can issue requests to Ably, such as subscribe to channels, or publish messages, it must authenticate with Ably. Authentication requires an Ably API key.
22
+
Before a client or server can issue requests to Ably, such as subscribe to channels, or publish messages, it must authenticate with Ably. Authentication requires an Ably API key.
23
23
24
24
h2(#api-keys). Ably API keys
25
25
26
26
Every Ably app can have one or more API keys associated with it in order to authenticate directly with Ably, or to issue tokens with. API keys can be created with different "capabilities":/docs/auth/capabilities and any tokens issued using that API key can only permit a subset of those capabilities.
27
27
28
28
h3(#format). API key format
29
29
30
-
An Ably API key string has the following format: @I2E_JQ.OqUdfg:EVKVTCBlzLBPYJiCZTsIW_pqylJ9WVRB5K9P19Ap1y0@.
30
+
An Ably API key string has the following format: @I2E_JQ.OqUdfg:EVKVTCBlzLBPYJiCZTsIW_pqylJ9WVRB5K9P19Ap1y0@.
31
31
32
32
The API key is made up of three parts:
33
33
@@ -61,23 +61,23 @@ h2(#mechanisms). Available authentication mechanisms
61
61
The two authentication mechanisms available to authenticate with Ably are:
62
62
63
63
1. "Basic authentication":/docs/auth/basic, which uses your Ably API key directly.
64
-
2. "Token authentication":/docs/auth/token, which uses short-lived tokens for access. These tokens are periodically renewed, and can be revoked if required.
64
+
2. "Token authentication":/docs/auth/token, which uses short-lived tokens for access. These tokens are periodically renewed, and can be revoked if required.
65
65
66
66
h3(#client). Client-side authentication
67
67
68
-
"Token authentication":/docs/auth/token is the recommended authentication mechanism on the client-side, as it provides more fine-grained access control and limits the risk of exposing your Ably API key.
68
+
"Token authentication":/docs/auth/token is the recommended authentication mechanism on the client-side, as it provides more fine-grained access control and limits the risk of exposing your Ably API key.
69
69
70
-
In production systems you should never use basic authentication on the client-side as it exposes your Ably API key. API keys don't have an expiry, so once compromised, they could be used indefinitely by an attacker.
70
+
In production systems you should never use basic authentication on the client-side as it exposes your Ably API key. API keys don't have an expiry, so once compromised, they could be used indefinitely by an attacker.
71
71
72
72
Tokens have an expiry, and so there is only a small period of time during which the compromised token can be used. It is also possible to "revoke tokens":/docs/auth/revocation, should that be necessary for security reasons.
73
73
74
74
h3(#server). Server-side authentication
75
75
76
-
Use "basic authentication":/docs/auth/basic on the server-side. You should never use token authentication server-side, as this results in unnecessary overhead due the server needing to periodically make token requests to authenticate itself.
76
+
Use "basic authentication":/docs/auth/basic on the server-side. You should never use token authentication server-side, as this results in unnecessary overhead due the server needing to periodically make token requests to authenticate itself.
77
77
78
78
h2(#selecting-auth). Selecting an authentication mechanism
79
79
80
-
When deciding on which authentication method you will be using, it is recommended you bear in mind the "principle of least privilege":https://en.wikipedia.org/wiki/Principle_of_least_privilege.
80
+
When deciding on which authentication method you will be using, it is recommended you bear in mind the "principle of least privilege":https://en.wikipedia.org/wiki/Principle_of_least_privilege.
81
81
82
82
A client should ideally only possess the credentials and rights that it needs to accomplish what it wants. This way, if the credentials are compromised, the rights that can be abused by an attacker are minimized.
meta_description: "Presence and occupancy provide information about clients attached to channels. This includes metrics about the attached clients, and details of the individual members attached to the channel."
4
4
---
5
5
6
-
"Presence":/docs/presence-occupancy/presence and "occupancy":/docs/presence-occupancy/occupancy are features that provide information about the clients and "connections":/docs/connect attached to a channel. Occupancy returns high level metrics about the clients attached to a channel, whereas presence provides details about individual members that have joined a channel's presence set.
6
+
"Presence":/docs/presence-occupancy/presence and "occupancy":/docs/presence-occupancy/occupancy are features that provide information about the clients and "connections":/docs/connect attached to a channel. Occupancy returns high level metrics about the clients attached to a channel, whereas presence provides details about individual members that have joined a channel's presence set.
7
7
8
8
h2(#presence-vs-occupancy). Occupancy versus presence
9
9
@@ -13,4 +13,4 @@ Presence is a feature that tracks the membership of a presence set for a channel
13
13
14
14
Occupancy provides metrics for a channel. It is a feature that counts how many of a thing are attached to a channel, such as the number of connections. It does not provide any information that can identify individual connections or clients attached to the channel.
15
15
16
-
Take a chat application containing multiple chat rooms as an example. Occupancy would be a more lightweight method for displaying the popularity of rooms, by displaying the number of connections to each channel. Presence could be utilized in each channel to indicate which users are online, and to notify other members when someone leaves the room.
16
+
Take a chat application containing multiple chat rooms as an example. Occupancy would be a more lightweight method for displaying the popularity of rooms, by displaying the number of connections to each channel. Presence could be utilized in each channel to indicate which users are online, and to notify other members when someone leaves the room.
0 commit comments