centersl/librechat.ai
1
0
Fork 0
mirror of https://github.com/LibreChat-AI/librechat.ai.git synced 2026-03-27 02:38:32 +07:00
Code Issues Packages Projects Releases Wiki Activity

fix(docs): add valid cache keys to Redis docs and Apple Silicon warning to Docker page (#541)

Browse Source 
Fixes #428: The Redis configuration doc previously listed STATIC_CONFIG as
a valid cache key, which was deprecated and causes startup errors. Added a
complete table of valid CacheKeys values with descriptions, plus a callout
warning about invalid keys.

Fixes #228: The Docker installation page had no mention of the AVX
incompatibility with Apple Silicon (M-series) Macs. Added a prominent
callout in the Prerequisites section with the docker-compose.override.yml
fix to use mongo:4.4.18.
This commit is contained in:
Marco Beretta
2026-03-22 03:31:46 +01:00
committed by GitHub
parent 00586da525
commit 4174c8dd6c
2 changed files with 46 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
content/docs/configuration/redis.mdx
View File

@@ -197,7 +197,36 @@ Force specific cache namespaces to use in-memory storage even when Redis is enab
FORCED_IN_MEMORY_CACHE_NAMESPACES=ROLES,MESSAGES
```
Valid cache keys are defined in the `CacheKeys` enum from `librechat-data-provider`.
Valid cache keys (from the `CacheKeys` enum in `librechat-data-provider`):
| Key | Description |
|---|---|
| `CONFIG_STORE` | Configuration store |
| `ROLES` | User roles |
| `PLUGINS` | Plugins data |
| `GEN_TITLE` | Generated titles |
| `TOOLS` | Tools data |
| `MODELS_CONFIG` | Models configuration |
| `MODEL_QUERIES` | Model queries |
| `STARTUP_CONFIG` | Startup configuration |
| `ENDPOINT_CONFIG` | Endpoint configuration |
| `TOKEN_CONFIG` | Token configuration |
| `APP_CONFIG` | Application configuration |
| `ABORT_KEYS` | Abort keys |
| `BANS` | Ban data |
| `ENCODED_DOMAINS` | Encoded domains |
| `AUDIO_RUNS` | Audio processing runs |
| `MESSAGES` | Messages |
| `FLOWS` | Flows data |
| `PENDING_REQ` | Pending requests |
| `S3_EXPIRY_INTERVAL` | S3 expiry intervals |
| `OPENID_EXCHANGED_TOKENS` | OpenID exchanged tokens |
| `OPENID_SESSION` | OpenID sessions |
| `SAML_SESSION` | SAML sessions |
<Callout type="warn" title="Invalid keys">
Using an invalid key (e.g., the deprecated `STATIC_CONFIG`) will cause a startup error. Only use keys from the table above.
</Callout>
## Performance Tuning

16
content/docs/local/docker.mdx
View File

@@ -13,6 +13,22 @@ For most scenarios, Docker Compose is the recommended installation method due to
Docker Desktop is recommended for most users. For remote server installations, see the [Ubuntu Docker Deployment Guide](/docs/remote/docker_linux).
<Callout type="warn" title="Apple Silicon (M-series) Macs">
Mac computers with Apple Silicon (M1, M2, M3, M4) processors do not support AVX instructions, which are required by the default MongoDB image used in LibreChat's Docker Compose setup. If you're on an M-series Mac, MongoDB will crash on startup.
**Fix:** Create a `docker-compose.override.yml` to use an older, compatible MongoDB image:
```yaml filename="docker-compose.override.yml"
services:
mongodb:
image: mongo:4.4.18
```
See the [Docker Override guide](/docs/configuration/docker_override) for more details.
</Callout>
## Installation
<Steps>