redis/node-redis
1
0
Fork 0
mirror of https://github.com/redis/node-redis.git synced 2025-08-09 00:22:08 +03:00
Code Activity

doc: add defaults option example to cluster documentation (#2377)

Browse Source 
* doc: add defaults option example to cluster documentation

* Formatting update.

* Formatting.

Co-authored-by: Simon Prickett <simon@redis.com>
This commit is contained in:
bodong.ybd
2023-01-25 06:52:15 +08:00
committed by GitHub
parent 29a2dc5027
commit 85bf97bb39
1 changed files with 16 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/clustering.md
View File

@@ -40,6 +40,22 @@ const value = await cluster.get('key');
| modules | | Included [Redis Modules](../README.md#packages) |
| scripts | | Script definitions (see [Lua Scripts](../README.md#lua-scripts)) |
| functions | | Function definitions (see [Functions](../README.md#functions)) |
## Auth with password and username
Specifying the password in the URL or a root node will only affect the connection to that specific node. In case you want to set the password for all the connections being created from a cluster instance, use the `defaults` option.
```javascript
createCluster({
rootNodes: [{
url: 'redis://10.0.0.1:30001'
}, {
url: 'redis://10.0.0.2:30002'
}],
defaults: {
username: 'username',
password: 'password'
}
});
```
## Node Address Map