Repository navigation
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
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[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 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 |
There was a problem hiding this comment.
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 👍 / 👎.
There was a problem hiding this comment.
Fixed in 02d1052. The section now leads with Docker Desktop's own host minimums (4 GB on macOS and Linux, 8 GB on Windows, plus virtualization), linked to the platform pages on docs.docker.com, and presents 1 GiB / 1 vCPU only as the allocation LibreChat's containers need on top of that. Covered by @Scenario:docker-guide-separates-host-and-container-requirements in e2e/local-system-requirements.spec.ts.
| - 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**. |
There was a problem hiding this comment.
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 👍 / 👎.
There was a problem hiding this comment.
Fixed in 02d1052. Confirmed against LibreChat dev: .env.example ships ADMIN_PANEL_SESSION_SECRET empty and docker-compose.yml notes the panel refuses to start without it. The admin panel is no longer listed among the containers that start by default; the text says it only starts once ADMIN_PANEL_SESSION_SECRET is set and links to /docs/features/admin_panel for the setup. Covered by @Scenario:docker-guide-admin-panel-needs-session-secret.
📦 Next.js Bundle Analysis for librechat.aiThis analysis was generated by the Next.js Bundle Analysis action. 🤖 This PR introduced no changes to the JavaScript bundle! 🙌 |
8c85a02 to
f51c9a7
Compare
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: f51c9a7a17
ℹ️ 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".
|
|
||
| Your computer must first meet Docker Desktop's own requirements. At the time of writing, Docker Desktop needs at least 4 GB of system RAM on [macOS](https://docs.docker.com/desktop/setup/install/mac-install/) and [Linux](https://docs.docker.com/desktop/setup/install/linux/), and 8 GB on [Windows](https://docs.docker.com/desktop/setup/install/windows-install/), plus hardware virtualization. Check the linked pages for the current requirements. | ||
|
|
||
| On top of that, LibreChat's containers need at least 1 GiB of RAM and 1 vCPU, the same [minimum](/docs/remote#minimum-requirements) as on a server. The default Docker Compose file starts MongoDB, Meilisearch (conversation search), and the RAG API with a PostgreSQL/pgvector database (file search) alongside LibreChat. It also defines the admin panel, which only starts once `ADMIN_PANEL_SESSION_SECRET` is set in `.env` (see [Admin Panel](/docs/features/admin_panel)). With everything running, give Docker at least 2 GB of memory for smoother operation. On Docker Desktop, check the memory limit under **Settings > Resources**. |
There was a problem hiding this comment.
When a Windows user follows the recommended Docker Desktop path with its default WSL 2 backend, there is no Docker memory-limit control under Settings > Resources. Docker's settings reference limits that control to macOS, Linux, and Windows Hyper-V, while WSL 2 resource limits must be configured on the WSL utility VM. Qualify this instruction by backend and direct WSL 2 users to the appropriate configuration; otherwise, most Windows readers cannot follow the memory-allocation guidance.
Useful? React with 👍 / 👎.
There was a problem hiding this comment.
Fixed in 6eeed8a. The memory guidance is now split by backend: Docker Desktop's resource settings on macOS, Linux and Windows with Hyper-V; with the Windows WSL 2 backend it is set on the WSL 2 VM, linking to Docker's WSL best-practices page. The unconditional Settings > Resources instruction is gone. Covered by @Scenario:docker-guide-memory-setting-matches-desktop-backend.
| - MongoDB (Atlas or Community Server) | ||
| - [MongoDB Atlas](/docs/configuration/mongodb/mongodb_atlas) | ||
| - [MongoDB Community Server](/docs/configuration/mongodb/mongodb_community) | ||
| - At least 1 GiB RAM and 1 vCPU. See [System Requirements](/docs/local/docker#system-requirements) for what to plan for when you add more services or run models locally. |
There was a problem hiding this comment.
On a host provisioned to this advertised 1 GiB minimum, the installation can run out of memory before LibreChat ever starts: the guide's next command, npm run reinstall, executes npm ci followed by the full frontend build, and LibreChat configures that Vite build with an 8192 MiB old-space ceiling (update.js, client/package.json); its Docker build similarly budgets 6144 MiB. The 1 GiB server runtime minimum therefore should not be reused for this source-build path without a separate build-time RAM requirement or a warning to use the prebuilt Docker image on minimum-spec systems.
Useful? React with 👍 / 👎.
There was a problem hiding this comment.
Fixed in 6eeed8a. Confirmed against LibreChat dev: npm run reinstall runs npm run frontend (config/update.js), which ends in the client build with NODE_OPTIONS=--max-old-space-size=8192 (client/package.json). The npm prerequisite now scopes 1 GiB / 1 vCPU to running LibreChat and adds that the source build needs much more memory, pointing low-memory machines to the prebuilt Docker images. No build-time RAM figure is stated because none is published; the heap ceiling is quoted as what it is. Covered by @Scenario:npm-guide-warns-source-build-needs-more-memory.
|
|
||
| LibreChat does not run AI models itself; it sends requests to the providers you configure, so it does not need a GPU. | ||
|
|
||
| Your computer must first meet Docker Desktop's own requirements. At the time of writing, Docker Desktop needs at least 4 GB of system RAM on [macOS](https://docs.docker.com/desktop/setup/install/mac-install/) and [Linux](https://docs.docker.com/desktop/setup/install/linux/), and 8 GB on [Windows](https://docs.docker.com/desktop/setup/install/windows-install/), plus hardware virtualization. Check the linked pages for the current requirements. |
There was a problem hiding this comment.
For a local Linux user running Docker Engine natively, the 4 GB and KVM requirements stated here do not apply: Docker's Linux Desktop documentation explains that Desktop runs its own VM and can be installed side-by-side with the native Engine. Because this guide lists generic Docker as the prerequisite and says Desktop is only recommended, the categorical “Your computer must” incorrectly rules out valid Engine-based local installations, including the documented 1 GiB setup. Make these host requirements conditional on choosing Docker Desktop.
Useful? React with 👍 / 👎.
There was a problem hiding this comment.
Fixed in 6eeed8a. The host minimums now apply only "If you use Docker Desktop", explaining that Desktop runs its own VM, and the paragraph states that Docker Engine installed directly on Linux has no separate VM. The LibreChat container minimum comes first and stands on its own. Covered by @Scenario:docker-guide-scopes-host-requirements-to-docker-desktop.
📦 Next.js Bundle Analysis for librechat.aiThis analysis was generated by the Next.js Bundle Analysis action. 🤖 This PR introduced no changes to the JavaScript bundle! 🙌 |
📦 Next.js Bundle Analysis for librechat.aiThis 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 participant
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 container minimum and 2 GB recommendation with every bundled service running, which services the default
docker-compose.ymlstarts (checked against LibreChatdev; the admin panel only starts onceADMIN_PANEL_SESSION_SECRETis set), Docker Desktop's own host requirements and memory control by backend (Hyper-V vs WSL 2) for readers who use Desktop, and a note that local model runtimes such as Ollama need their own sizing. The npm guide gets a prerequisite pointing to it, plus a warning that building the frontend from source needs far more memory than running LibreChat.Feedback addressed
1560510614588358778,/docs/user_guides/docs/local/dockerand the matching prerequisites to/docs/local/npm, using the documented minimums, LibreChat's compose and build scripts, and Docker's official requirements.Validation
pnpm exec playwright testin CI on the head: 50 passed, including the five@scenariotests ine2e/local-system-requirements.spec.tsnpx prettier --checkandnpx eslinton the changed files: passed@mdx-js/mdx: no errorsNot changed
1560605020674727938,/docs: "good" rating with no message. Non-actionable.1560623516980879453,/docs: "good" rating with the message "Hi". Non-actionable.