Skip to content

📏 docs: Add System Requirements to Local Installation Guides - #832

Open
berry-13 wants to merge 1 commit into
mainfrom
berry-13/auto-librechat-ai-address-feedbacks-run-47-20261016T1800
Open

berry-13 wants to merge 1 commit into
mainfrom
berry-13/auto-librechat-ai-address-feedbacks-run-47-20261016T1800

Conversation

@berry-13

Copy link
Copy Markdown
Collaborator

Summary

The local installation guides listed software prerequisites but nothing about hardware, and the only minimum requirements on the site sit on the remote deployment overview. Readers asking what they need to run LibreChat locally had no answer on the install path.

This adds a System Requirements section to the Docker guide: the existing 1 GiB RAM / 1 vCPU minimum, the extra containers the default docker-compose.yml starts (checked against LibreChat origin/dev: MongoDB, Meilisearch, pgvector, RAG API, admin panel), the existing 2 GB recommendation when everything runs, and a note that local model runtimes such as Ollama need their own sizing. The npm guide gets a one-line prerequisite pointing to it.

Feedback addressed

  • 1560510614588358778, /docs/user_guides
    • Asked what is required to run LibreChat locally; local install docs had no hardware requirements.
    • Added System Requirements to /docs/local/docker and a pointer from /docs/local/npm, reusing the documented minimums.
    • Classification: FIXED

Validation

  • npx prettier --check content/docs/local/docker.mdx content/docs/local/npm.mdx: passed
  • npx fumadocs-mdx: generated without errors
  • Compiled both changed pages with @mdx-js/mdx: no errors
  • Confirmed the /docs/remote#minimum-requirements and Ollama link targets exist
  • ESLint ignores .mdx in this repo; full pnpm build not run for this content-only change

Not changed

  • 1560605020674727938, /docs: "good" rating with no message. Non-actionable.
  • 1560623516980879453, /docs: "good" rating with the message "Hi". Non-actionable.

@vercel

vercel Bot commented Oct 16, 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 16, 2026 6:08pm UTC

Request Review

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 16, 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-16T18:06:49.102540Z 8c85a02 PR opened
🔒 Security Review ✅ Completed 2026-10-16T18:05:27.796491Z 8c85a02 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: 8c85a02df4

ℹ️ 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".


LibreChat does not run AI models itself; it sends requests to the providers you configure, so it does not need a GPU. The [minimum requirements](/docs/remote#minimum-requirements) are the same locally as on a server:

- 1 GiB RAM

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 Correct the local Docker Desktop RAM minimum

For users following the recommended Docker Desktop installation path, 1 GiB is not a valid local system minimum: Docker Desktop itself requires at least 4 GB on macOS and Linux, and 8 GB on Windows, before allocating memory to these containers. Copying the headless-server minimum here could lead readers to provision machines that cannot run the prerequisite; distinguish LibreChat's container allocation from the host requirements and link to the platform-specific Docker Desktop requirements.

Useful? React with 👍 / 👎.

- 1 GiB RAM
- 1 vCPU

The default Docker Compose file starts several containers alongside LibreChat: MongoDB, Meilisearch (conversation search), the RAG API with a PostgreSQL/pgvector database (file search), and the admin panel. With all of them running, plan for at least 2 GB of RAM available to Docker for smoother operation. On Docker Desktop, check the memory limit under **Settings > Resources**.

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 Document the admin-panel secret before counting it as running

When users follow the installation steps below and copy .env.example, ADMIN_PANEL_SESSION_SECRET is unset, so the bundled admin-panel image refuses to start rather than running alongside LibreChat. This requirement is documented in content/docs/features/admin_panel.mdx:75-80 and content/changelog/config_v1.3.13.mdx:19-22; either add the secret-generation step here before docker compose up -d, or clarify that the panel is unavailable without that extra configuration.

Useful? React with 👍 / 👎.

@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! 🙌

This branch was successfully deployed

1 active deployment
Preview — 8c85a02d Deployed Oct 16, 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