Skip to content

🛠️ docs: Correct the Configuration Guides Against LibreChat - #864

Merged
berry-13 merged 5 commits into
mainfrom
berry-13/docs-config-guides-audit
Oct 23, 2026
Merged

berry-13 merged 5 commits into
mainfrom
berry-13/docs-config-guides-audit

Conversation

@berry-13

Copy link
Copy Markdown
Collaborator

Summary

Checks the configuration guides (authentication providers and LDAP, CDN, Redis, logging, metrics, Meilisearch, RAG API, moderation, token usage, speech, banner, preconfigured providers and tools) against the LibreChat source. It fixes variables, defaults and behavior that had drifted, and repairs the broken anchors on the metrics and RAG API pages.

Stacked on #863; review only this PR's diff.

Change Type

  • Documentation update

Testing

  • Each changed claim traced to LibreChat dev, then rechecked by a second independent pass
  • Internal links and anchors: 0 broken (3 on main)
  • Frontmatter parses

Checklist

  • No dash punctuation added

@vercel

vercel Bot commented Oct 23, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
librechat-ai Ready Ready Preview Oct 23, 2026 9:03pm UTC

Request Review

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 23, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-23T20:57:42.110193Z 23df3d0 New commits
🔒 Security Review ✅ Completed 2026-10-23T15:20:30.668660Z 1e7095a PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 1e7095acfd

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread content/docs/configuration/cdn/azure.mdx
Comment thread content/docs/configuration/redis.mdx
Comment on lines +39 to +40
['IMPORT_VIOLATION_SCORE', 'integer', 'Score for import conversation violations.','IMPORT_VIOLATION_SCORE=0'],
['FORK_VIOLATION_SCORE', 'integer', 'Score for conversation fork violations.','FORK_VIOLATION_SCORE=0'],

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Restore the import and fork violation scores

These examples now set both violation scores to 0, while the environment reference still specifies IMPORT_VIOLATION_SCORE=1 and FORK_VIOLATION_SCORE=1 in content/docs/configuration/dotenv.mdx:2400-2409. An operator copying this table would disable ban-score accumulation for repeated import and fork violations, so the documented values need to match the actual defaults.

Useful? React with 👍 / 👎.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in f952f51: both examples are back to 1 with 'Defaults to 1 when unset' (logViolation's default score when the variable is undefined).

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 05420f9fec

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

services:
api:
environment:
- RAG_API_URL=http://host.docker.internal:8000

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Add the Linux host gateway to the RAG override

On Linux Docker Engine, this example points the api container at host.docker.internal without defining that hostname, so a RAG API running on the Docker host remains unreachable. Docker provides this name automatically on macOS and Windows, but its Compose networking documentation requires an extra_hosts entry such as host.docker.internal:host-gateway on Linux; add that mapping under api, as the Ollama example later on this page already does for rag_api.

Useful? React with 👍 / 👎.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in ac7c775: the override maps host.docker.internal:host-gateway, with a note that Linux needs it.

Comment thread content/docs/configuration/stt_tts.mdx Outdated

### One provider per service

Configure exactly one provider block under `speech.stt` and exactly one under `speech.tts`. If more than one is set, requests fail with the error "Multiple providers are set. Please set only one provider."

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Allow deployments to configure only one speech service

When an operator wants server-side STT with browser TTS, or server-side TTS with browser STT, this says they must configure provider blocks for both services even though either section can be omitted. The page's own STT-only and TTS-only examples demonstrate that these are independent; the actual restriction described by the following error is at most one provider under each section that is present, not exactly one provider under both.

Useful? React with 👍 / 👎.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in ac7c775: each section takes at most one provider and either can be omitted.

Comment thread content/docs/configuration/pre_configured_ai/google.mdx

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: ac7c775766

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread content/docs/configuration/pre_configured_ai/bedrock.mdx
@github-actions

Copy link
Copy Markdown
Contributor

📦 Next.js Bundle Analysis for librechat.ai

This analysis was generated by the Next.js Bundle Analysis action. 🤖

This PR introduced no changes to the JavaScript bundle! 🙌

Base automatically changed from berry-13/docs-yaml-endpoints-audit to main October 23, 2026 20:56
Check the authentication, CDN, Redis, logging, metrics, Meilisearch, RAG
API, moderation, token usage, speech, banner, provider and tool guides
against the LibreChat source, fix wrong variables, defaults and
behavior, and repair the two broken anchors on the metrics and RAG API
pages.
The bundled compose files set RAG_API_URL on the api service, which
takes precedence over .env, so adding it to .env does not redirect a
Docker deployment. Show the docker-compose.override.yml form instead.
…ults

The import and fork limiters are always active, so the LIMIT_IMPORT_*
and LIMIT_FORK_* switches did nothing. IMPORT_VIOLATION_SCORE and
FORK_VIOLATION_SCORE default to 1 when unset.
The RAG override needs host.docker.internal mapped on Linux. Each speech
section takes at most one provider and either can be omitted. The Argon
region rule applies to Vertex AI only; the Gemini API serves it too.
@github-actions

Copy link
Copy Markdown
Contributor

📦 Next.js Bundle Analysis for librechat.ai

This analysis was generated by the Next.js Bundle Analysis action. 🤖

This PR introduced no changes to the JavaScript bundle! 🙌

@berry-13
berry-13 merged commit e31f08c into main Oct 23, 2026
5 checks passed
@berry-13
berry-13 deleted the berry-13/docs-config-guides-audit branch October 23, 2026 21:28

This branch was successfully deployed

1 active deployment
Preview — 23df3d05 Deployed Oct 23, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant