Skip to content

Commit 772e68f

Browse files
committed
docs: document v0.8.6 env and config updates
1 parent 02a49ac commit 772e68f

10 files changed

Lines changed: 1329 additions & 423 deletions

File tree

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
date: 2026-05-25
3+
title: ⚙️ Config v1.3.12
4+
version: '1.3.12'
5+
---
6+
7+
- Added `interface.retentionMode`
8+
- `"temporary"` keeps retention limited to temporary chats
9+
- `"all"` applies configured retention to all supported conversation data
10+
11+
- Added `mcpServers.<server>.proxy`
12+
- Allows `sse` and `streamable-http` MCP servers to use a per-server outbound proxy
13+
- Supports `http://`, `https://`, `socks://`, and `socks5://` proxy URLs
14+
15+
- Added `modelSpecs.list[].hideBadgeRow`
16+
- Allows a model spec to hide the tool badge row in the chat composer

content/docs/configuration/dotenv.mdx

Lines changed: 109 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -258,6 +258,12 @@ To configure LibreChat for local use or custom domain deployment, set the follow
258258
'Specifies the server-side domain.',
259259
'DOMAIN_SERVER=http://localhost:3080',
260260
],
261+
[
262+
'ADMIN_PANEL_URL',
263+
'string',
264+
'External admin panel base URL used for admin OAuth/SSO redirects when the admin panel is hosted separately. Do not include a trailing slash.',
265+
'ADMIN_PANEL_URL=https://admin.example.com/admin',
266+
],
261267
]}
262268
/>
263269

@@ -303,6 +309,12 @@ LibreChat has built-in central logging, see [Logging System](/docs/configuration
303309
'Enable verbose console/stdout logs in the same format as file debug logs.',
304310
'DEBUG_CONSOLE=false',
305311
],
312+
[
313+
'LOG_TO_FILE',
314+
'boolean',
315+
'Set to false to disable file-backed Winston transports while keeping console logging available.',
316+
'LOG_TO_FILE=true',
317+
],
306318
[
307319
'CONSOLE_JSON',
308320
'boolean',
@@ -345,6 +357,65 @@ Note:
345357

346358
Note: `DEBUG_CONSOLE` is not recommended, as the outputs can be quite verbose, and so it's disabled by default.
347359

360+
### OpenTelemetry Tracing
361+
362+
LibreChat can emit backend OpenTelemetry traces for general API, HTTP, MongoDB, Mongoose, Redis, and outbound request visibility. Use Langfuse for GenAI-specific prompt/model observability.
363+
364+
<OptionTable
365+
options={[
366+
[
367+
'OTEL_TRACING_ENABLED',
368+
'boolean',
369+
'Enable backend OpenTelemetry tracing. Tracing remains disabled when OTEL_SDK_DISABLED=true.',
370+
'# OTEL_TRACING_ENABLED=false',
371+
],
372+
[
373+
'OTEL_SERVICE_NAME',
374+
'string',
375+
'Service name reported to OpenTelemetry. Default: librechat.',
376+
'# OTEL_SERVICE_NAME=librechat',
377+
],
378+
[
379+
'OTEL_SERVICE_VERSION',
380+
'string',
381+
'Service version reported to OpenTelemetry. Defaults to the package version when unset.',
382+
'# OTEL_SERVICE_VERSION=',
383+
],
384+
[
385+
'OTEL_EXPORTER_OTLP_ENDPOINT',
386+
'string',
387+
'Base OTLP exporter endpoint.',
388+
'# OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4318',
389+
],
390+
[
391+
'OTEL_EXPORTER_OTLP_TRACES_ENDPOINT',
392+
'string',
393+
'Trace-specific OTLP endpoint. Overrides the base endpoint for traces when set.',
394+
'# OTEL_EXPORTER_OTLP_TRACES_ENDPOINT=',
395+
],
396+
[
397+
'OTEL_EXPORTER_OTLP_HEADERS',
398+
'string',
399+
'Comma-separated OTLP exporter headers, such as authorization metadata.',
400+
'# OTEL_EXPORTER_OTLP_HEADERS=',
401+
],
402+
['OTEL_TRACES_EXPORTER', 'string', 'Trace exporter selection.', '# OTEL_TRACES_EXPORTER=otlp'],
403+
[
404+
'OTEL_TRACES_SAMPLER',
405+
'string',
406+
'OpenTelemetry trace sampler. Default example: parentbased_always_on.',
407+
'# OTEL_TRACES_SAMPLER=parentbased_always_on',
408+
],
409+
['OTEL_LOG_LEVEL', 'string', 'OpenTelemetry SDK log level.', '# OTEL_LOG_LEVEL=INFO'],
410+
[
411+
'OTEL_SDK_DISABLED',
412+
'boolean',
413+
'Disable the OpenTelemetry SDK even if tracing is enabled.',
414+
'# OTEL_SDK_DISABLED=false',
415+
],
416+
]}
417+
/>
418+
348419
### Permission
349420

350421
> UID and GID are numbers assigned by Linux to each user and group on the system. If you have permission problems, set here the UID and GID of the user running the Docker Compose command. The applications in the container will run with these UID/GID.
@@ -431,7 +502,12 @@ Uncomment `ENDPOINTS` to customize the available endpoints in LibreChat.
431502
'Comma-separated list of available endpoints.',
432503
'# ENDPOINTS=openAI,agents,assistants,gptPlugins,azureOpenAI,google,anthropic,bingAI,custom',
433504
],
434-
['PROXY', 'string', 'Proxy setting for all endpoints.', 'PROXY='],
505+
[
506+
'PROXY',
507+
'string',
508+
'Outbound proxy for server-side requests, including endpoint calls and remote MCP HTTP/SSE transports. Remote MCP transports also honor HTTP_PROXY, HTTPS_PROXY, and NO_PROXY when PROXY is unset.',
509+
'PROXY=',
510+
],
435511
['TITLE_CONVO', 'boolean', 'Enable titling for all endpoints.', 'TITLE_CONVO=true'],
436512
]}
437513
/>
@@ -610,6 +686,12 @@ See: [AWS Bedrock Setup](/docs/configuration/pre_configured_ai/bedrock)
610686
'AWS access key ID for Bedrock. Optional if using default AWS credentials chain.',
611687
'# BEDROCK_AWS_ACCESS_KEY_ID=your_access_key_id',
612688
],
689+
[
690+
'BEDROCK_AWS_PROFILE',
691+
'string',
692+
'AWS profile name from ~/.aws/config or ~/.aws/credentials. Supports SSO, assume-role, and credential_process profiles.',
693+
'# BEDROCK_AWS_PROFILE=your-profile-name',
694+
],
613695
[
614696
'BEDROCK_AWS_SECRET_ACCESS_KEY',
615697
'string',
@@ -622,6 +704,12 @@ See: [AWS Bedrock Setup](/docs/configuration/pre_configured_ai/bedrock)
622704
'AWS session token for temporary credentials. Optional.',
623705
'# BEDROCK_AWS_SESSION_TOKEN=your_session_token',
624706
],
707+
[
708+
'BEDROCK_AWS_BEARER_TOKEN',
709+
'string',
710+
'Bedrock API key. Set to an API key for admin-configured auth, or user_provided to prompt users for their own key.',
711+
'# BEDROCK_AWS_BEARER_TOKEN=yourBedrockApiKey',
712+
],
625713
[
626714
'BEDROCK_AWS_MODELS',
627715
'string',
@@ -631,7 +719,7 @@ See: [AWS Bedrock Setup](/docs/configuration/pre_configured_ai/bedrock)
631719
]}
632720
/>
633721

634-
> **Note:** You can omit the access keys to use the default AWS credentials chain (environment variables, SSO credentials, shared credentials files, or EC2/ECS Instance Metadata Service). See [AWS Bedrock Setup](/docs/configuration/pre_configured_ai/bedrock) for more details.
722+
> **Note:** Prefer `BEDROCK_AWS_PROFILE`, IAM roles, or the AWS default credentials chain when possible. Use static keys or `BEDROCK_AWS_BEARER_TOKEN` only when those deployment options are not suitable. See [AWS Bedrock Setup](/docs/configuration/pre_configured_ai/bedrock) for more details.
635723
636724
### BingAI
637725

@@ -1754,6 +1842,12 @@ see: **[Authentication System](/docs/configuration/authentication)**
17541842
'Refresh token expiry time.',
17551843
'REFRESH_TOKEN_EXPIRY=(1000 * 60 * 60 * 24) * 7',
17561844
],
1845+
[
1846+
'SESSION_COOKIE_SECURE',
1847+
'boolean',
1848+
'Overrides the Secure attribute for session/auth cookies. Leave unset to use the default NODE_ENV/DOMAIN_SERVER heuristic.',
1849+
'# SESSION_COOKIE_SECURE=false',
1850+
],
17571851
]}
17581852
/>
17591853

@@ -1995,7 +2089,7 @@ For more information:
19952089
[
19962090
'OPENID_USE_PKCE',
19972091
'boolean',
1998-
'Use PKCE (Proof Key for Code Exchange) for OpenID authentication.',
2092+
'Use PKCE (Proof Key for Code Exchange) for OpenID authentication. For public clients without a client secret, leave OPENID_CLIENT_SECRET empty and set this to true.',
19992093
'# OPENID_USE_PKCE=true',
20002094
],
20012095
[
@@ -2694,6 +2788,18 @@ Configure Model Context Protocol settings for enhanced server management and OAu
26942788
'Skip code challenge method validation. When set to true, forces S256 code challenge even if not advertised in .well-known/openid-configuration',
26952789
'MCP_SKIP_CODE_CHALLENGE_CHECK=false',
26962790
],
2791+
[
2792+
'MCP_STREAMABLE_HTTP_MAX_RESPONSE_BYTES',
2793+
'number',
2794+
'Maximum bytes allowed in a non-GET streamable HTTP MCP response before rejecting it. Set to 0 to disable. Default: 16777216 (16 MiB).',
2795+
'# MCP_STREAMABLE_HTTP_MAX_RESPONSE_BYTES=16777216',
2796+
],
2797+
[
2798+
'MCP_STREAMABLE_HTTP_MAX_LINE_BYTES',
2799+
'number',
2800+
'Maximum bytes allowed in one SSE line for non-GET streamable HTTP MCP responses. Set to 0 to disable. Default: 5242880 (5 MiB).',
2801+
'# MCP_STREAMABLE_HTTP_MAX_LINE_BYTES=5242880',
2802+
],
26972803
]}
26982804
/>
26992805

content/docs/configuration/librechat_yaml/example.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ icon: FileCode
1010
This example config includes all documented endpoints (Except Azure, LiteLLM, MLX, and Ollama, which all require additional configurations)
1111

1212
```yaml filename="librechat.yaml"
13-
version: 1.3.11
13+
version: 1.3.12
1414

1515
cache: true
1616

@@ -273,7 +273,7 @@ This example configuration file sets up LibreChat with detailed options across s
273273
# https://www.librechat.ai/docs/configuration/librechat_yaml
274274

275275
# Configuration version (required)
276-
version: 1.3.11
276+
version: 1.3.12
277277

278278
# Cache settings: Set to true to enable caching
279279
cache: true

content/docs/configuration/librechat_yaml/object_structure/config.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -911,6 +911,12 @@ see also:
911911
'Configures the retention period for temporary chats in hours. Min: 1, Max: 8760. Default: 720 (30 days).',
912912
'',
913913
],
914+
[
915+
'retentionMode',
916+
'String',
917+
'Controls whether retention applies only to temporary chats ("temporary", default) or to all supported conversation data ("all").',
918+
'',
919+
],
914920
[
915921
'autoSubmitFromUrl',
916922
'Boolean',

0 commit comments

Comments
 (0)