Skip to content

Commit

Permalink
Updated REDIS section in dotenv.mdx
Browse files Browse the repository at this point in the history
  • Loading branch information
gafda authored and danny-avila committed Feb 20, 2025
1 parent b2c5389 commit ea49282
Showing 1 changed file with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions pages/docs/configuration/dotenv.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -1024,9 +1024,22 @@ LibreChat supports Google Tag Manager for analytics. You will need a Google Tag

**Important:** If using Redis, you should flush the cache after changing any LibreChat settings.

If you are using Redis, you will need to set the following variables:

* `REDIS_URI`: The URI for your Redis instance.
* `USE_REDIS`: Set to `true` to enable Redis.
* `USE_REDIS_CLUSTER`: Set to `true` to enable Redis Cluster mode.
* `REDIS_CA`: The path to the PEM-encoded certificate authority file for Redis TLS connections.
* `REDIS_KEY_PREFIX`: A prefix to be added to all keys in the Redis database. Defaults to empty string if not specified.
* `REDIS_MAX_LISTENERS`: The maximum number of event listeners allowed for the Redis client instance. It helps prevent memory leaks by limiting event listeners. If set to 0 (zero), it will be considered limitless. Defaults to 10 if not specified.

<OptionTable
options={[
['REDIS_URI', 'string', 'Redis URI.','# REDIS_URI='],
['USE_REDIS', 'boolean', 'Use Redis.','# USE_REDIS='],
['REDIS_URI', 'string', 'Redis URI.', '# REDIS_URI="10.11.12.13:6379"'],
['USE_REDIS', 'boolean', 'Use Redis.', '# USE_REDIS="true"'],
['USE_REDIS_CLUSTER', 'boolean', 'User Redis Cluster mode', '# USE_REDIS_CLUSTER="true"'],
['REDIS_CA', 'string', 'Path to certificate', '# REDIS_CA="/path/to/file.crt"'],
['REDIS_KEY_PREFIX', 'string', 'Prefix for Redis keys', '# REDIS_KEY_PREFIX="librechat-staging:"'],
['REDIS_MAX_LISTENERS', 'number', 'Maximum number of event listeners allowed for the Redis client instance', '# REDIS_MAX_LISTENERS=20'],
]}
/>

0 comments on commit ea49282

Please sign in to comment.