Skip to content

Commit 4174c8d

Browse files
authored
fix(docs): add valid cache keys to Redis docs and Apple Silicon warning to Docker page (#541)
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.
1 parent 00586da commit 4174c8d

2 files changed

Lines changed: 46 additions & 1 deletion

File tree

content/docs/configuration/redis.mdx

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,36 @@ Force specific cache namespaces to use in-memory storage even when Redis is enab
197197
FORCED_IN_MEMORY_CACHE_NAMESPACES=ROLES,MESSAGES
198198
```
199199

200-
Valid cache keys are defined in the `CacheKeys` enum from `librechat-data-provider`.
200+
Valid cache keys (from the `CacheKeys` enum in `librechat-data-provider`):
201+
202+
| Key | Description |
203+
|---|---|
204+
| `CONFIG_STORE` | Configuration store |
205+
| `ROLES` | User roles |
206+
| `PLUGINS` | Plugins data |
207+
| `GEN_TITLE` | Generated titles |
208+
| `TOOLS` | Tools data |
209+
| `MODELS_CONFIG` | Models configuration |
210+
| `MODEL_QUERIES` | Model queries |
211+
| `STARTUP_CONFIG` | Startup configuration |
212+
| `ENDPOINT_CONFIG` | Endpoint configuration |
213+
| `TOKEN_CONFIG` | Token configuration |
214+
| `APP_CONFIG` | Application configuration |
215+
| `ABORT_KEYS` | Abort keys |
216+
| `BANS` | Ban data |
217+
| `ENCODED_DOMAINS` | Encoded domains |
218+
| `AUDIO_RUNS` | Audio processing runs |
219+
| `MESSAGES` | Messages |
220+
| `FLOWS` | Flows data |
221+
| `PENDING_REQ` | Pending requests |
222+
| `S3_EXPIRY_INTERVAL` | S3 expiry intervals |
223+
| `OPENID_EXCHANGED_TOKENS` | OpenID exchanged tokens |
224+
| `OPENID_SESSION` | OpenID sessions |
225+
| `SAML_SESSION` | SAML sessions |
226+
227+
<Callout type="warn" title="Invalid keys">
228+
Using an invalid key (e.g., the deprecated `STATIC_CONFIG`) will cause a startup error. Only use keys from the table above.
229+
</Callout>
201230

202231
## Performance Tuning
203232

content/docs/local/docker.mdx

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,22 @@ For most scenarios, Docker Compose is the recommended installation method due to
1313

1414
Docker Desktop is recommended for most users. For remote server installations, see the [Ubuntu Docker Deployment Guide](/docs/remote/docker_linux).
1515

16+
<Callout type="warn" title="Apple Silicon (M-series) Macs">
17+
18+
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.
19+
20+
**Fix:** Create a `docker-compose.override.yml` to use an older, compatible MongoDB image:
21+
22+
```yaml filename="docker-compose.override.yml"
23+
services:
24+
mongodb:
25+
image: mongo:4.4.18
26+
```
27+
28+
See the [Docker Override guide](/docs/configuration/docker_override) for more details.
29+
30+
</Callout>
31+
1632
## Installation
1733
1834
<Steps>

0 commit comments

Comments
 (0)