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: README.md
+8Lines changed: 8 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -136,6 +136,14 @@ Jedis supports retry and failover for your Redis deployments. This is useful whe
136
136
137
137
For the complete failover configuration options and examples, see the [Jedis failover docs](docs/failover.md).
138
138
139
+
## Token-Based Authentication
140
+
141
+
Jedis supports Token-Based authentication (TBA) starting with 5.3.0 GA release. This feature is complemented by an extension library that enhances the developer experience and provides most of the components required for TBA functionality.
142
+
143
+
Notably, the extension library includes built-in support for **Microsoft EntraID**, offering a seamless integration as part of the generic solution.
144
+
145
+
For more details and examples, please refer to the [Advanced Usage](docs/advanced-usage.md) documentation.
146
+
139
147
## Documentation
140
148
141
149
The [Jedis wiki](http://github.com/redis/jedis/wiki) contains several useful articles for using Jedis.
Copy file name to clipboardExpand all lines: docs/advanced-usage.md
+89-1Lines changed: 89 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -97,7 +97,7 @@ jedis.subscribe(l, "foo");
97
97
Note that subscribe is a blocking operation because it will poll Redis for responses on the thread that calls subscribe. A single JedisPubSub instance can be used to subscribe to multiple channels. You can call subscribe or psubscribe on an existing JedisPubSub instance to change your subscriptions.
98
98
99
99
100
-
###Monitoring
100
+
## Monitoring
101
101
102
102
To use the monitor command you can do something like the following:
Starting with version 5.3.0 GA, Jedis supports token-based authentication. The [redis-authx-entraid](https://github.com/redis/jvm-redis-authx-entraid) repository provides the necessary components that Jedis utilizes to enable this functionality.
128
+
129
+
Additionally, support for Microsoft EntraID has been fully implemented and is now available as an extension for Azure Managed Redis (AMR) and Azure Cache for Redis(ACR).
130
+
131
+
### Using With Custom Identity Provider
132
+
Jedis provides a token-based authentication mechanism with a generic identity provider of your choice.
133
+
For custom use of this feature, you will need to provide an implementation of `IdentityProvider` and `IdentityProviderConfig` and configure it in the way Jedis expects.
134
+
135
+
You will have the required interfaces from transitive Jedis dependencies;
Extension for EntraID is fully integrated and ready to use with [Azure Managed Redis](https://azure.microsoft.com/en-us/products/managed-redis)(AMR) or [Azure Cache for Redis](https://azure.microsoft.com/en-us/products/cache/)(ACR). All you need is to add the EntraID dependency and code for configuration for chosen authentication type with Microsoft EntraID service.
168
+
169
+
To get started, add the `redis-authx-entraid` extension as dependency;
170
+
171
+
```
172
+
<dependency>
173
+
<groupId>redis.clients.authentication</groupId>
174
+
<artifactId>redis-authx-entraid</artifactId>
175
+
<version>${version}</version>
176
+
</dependency>
177
+
```
178
+
179
+
After adding the dependency, configure it using `EntraIDTokenAuthConfigBuilder`:
Here you will see the `AuthXManager` class that is built into Jedis. Essentially it integrates the extension into Jedis and handles the authentication process.
198
+
For other available configurations, detailed information and usage of Jedis with Microsoft EntraID, please refer to the [official guide](https://redis.io/docs/latest/develop/clients/jedis/amr/)
199
+
200
+
**Setting Up AMR or ACR with Microsoft EntraID:**
201
+
202
+
To use Microsoft EntraID with AMR or ACR, for sure you will need to set up and configure your AMR/ACR services as well as Microsoft EntraID. The following resources provide useful information;
[Azure Cache for Redis](https://azure.microsoft.com/en-us/products/cache/)
207
+
208
+
[Microsoft Entra ID for AMR authentication](https://learn.microsoft.com/en-us/azure/azure-cache-for-redis/managed-redis/managed-redis-entra-for-authentication)
209
+
210
+
[Microsoft Entra ID for ACR authentication](https://learn.microsoft.com/en-us/azure/azure-cache-for-redis/cache-azure-active-directory-for-authentication)
211
+
212
+
[Use Microsoft Entra](https://learn.microsoft.com/en-us/azure/app-service/configure-authentication-provider-aad?tabs=workforce-configuration)
0 commit comments