🖥️ docs: Clarify That LibreChat Has No Desktop Installer on the Local Install Hub - #758
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: cce50a9fad
ℹ️ 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".
|
|
||
| <Callout type="info" title="Is there a Windows or macOS app?"> | ||
|
|
||
| No. LibreChat is a self-hosted web application, so there is no `.exe`, `.dmg`, or AppImage to download. You run it on your own machine using one of the methods below, then open it in your browser at [http://localhost:3080](http://localhost:3080). Docker and npm both work on Windows, macOS, and Linux, and [Docker Desktop](/docs/local/docker) is the simplest starting point on Windows. |
There was a problem hiding this comment.
When a reader chooses the Helm method listed below, LibreChat runs inside a Kubernetes cluster and is not automatically exposed on the reader's localhost:3080; the Helm guide only installs the chart and may target a remote cluster or a ClusterIP service. Qualify this URL as applying to Docker/npm, or direct Helm users to expose the service through their cluster.
Useful? React with 👍 / 👎.
|
|
||
| <Callout type="info" title="Is there a Windows or macOS app?"> | ||
|
|
||
| No. LibreChat is a self-hosted web application, so there is no `.exe`, `.dmg`, or AppImage to download. You run it on your own machine using one of the methods below, then open it in your browser at [http://localhost:3080](http://localhost:3080). Docker and npm both work on Windows, macOS, and Linux, and [Docker Desktop](/docs/local/docker) is the simplest starting point on Windows. |
There was a problem hiding this comment.
For readers asking whether LibreChat can behave like a Windows or macOS app, the categorical “No” omits LibreChat's supported installable PWA—the repository's release notes document PWA support and later PWA improvements. Although there is no .exe or .dmg, clarify that users can install the web app from a supporting browser after hosting it rather than implying that no desktop-app experience exists.
Useful? React with 👍 / 👎.
📦 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! 🙌 |
…all hub A reader on /de/docs/local reported that they wanted a Windows app. The Local Installation hub renders three install cards and no prose, so nothing on the page tells a reader that LibreChat is a self-hosted web application rather than something you download and run natively. /docs already carries this clarification (added in #600), but the install hub is a separate entry point that readers reach directly from search and from the sidebar, so that note never reaches them. The complaint arriving again on /docs/local is evidence that one placement is not enough. Adds a short callout that answers the question directly and points Windows readers at Docker Desktop. The localhost URL is scoped to Docker and npm, since the Helm chart deploys to a Kubernetes cluster and is reached through cluster networking rather than a local address. Also widens the page description so the expectation is set in search results. Verified against the app source at origin/dev: LibreChat has no Electron, Tauri, or other desktop packaging, and PORT defaults to 3080 in .env.example. Discord feedback ID: 1546161795104768073 Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01UqsVMs6sqXvDj8KvRut897
cce50a9 to
5a7522b
Compare
📦 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! 🙌 |
1 participant
Summary
A reader on
/de/docs/localsubmitted "Ich wollte eine Windows app" ("I wanted a Windows app"). The Local Installation hub renders three install cards (<LocalInstallHub />) and no prose, so nothing on the page tells a reader that LibreChat is a self-hosted web application rather than something you download and run natively./docsalready carries this clarification, added in #600 in response to the same class of report. The install hub is a separate entry point that readers reach directly from search results and from the sidebar, so that note never reaches them. The same complaint arriving again, one level down, is evidence that a single placement is not enough.This adds a short callout on
/docs/localthat answers the question directly and routes Windows readers to Docker Desktop, and widens the page description so the expectation is also set in the search-result snippet that brings people to the page.Only the English source is changed.
.github/workflows/translate_docs.ymlregenerates the 13 locale copies on push tomain, so/de/docs/localpicks the callout up from that run.Facts verified before writing
Checked against the application source at
danny-avila/LibreChat@origin/dev, not assumed:PORT=3080andDOMAIN_CLIENT=http://localhost:3080in.env.example, anddocker-compose.ymlpublishes${PORT}:${PORT}, so thehttp://localhost:3080the callout gives is the real default.content/docs/local/docker.mdxdocuments Docker Desktop plus a Windowscopynote, andcontent/docs/local/npm.mdxcarries a Windows note of its own.localhost:3080promise is scoped to Docker and npm.content/docs/local/helm_chart.mdxnever mentions that URL, and a Helm install targets a Kubernetes cluster reached through cluster networking, so the callout says so rather than implying a local address for all three cards.Review
Reviewed with
codex review --base mainatxhighreasoning effort. The first pass raised one P2: the original wording said "you run it on your own machine using one of the methods below, then open it in your browser athttp://localhost:3080", which reads as a promise for the Helm card too. Verified againstcontent/docs/local/helm_chart.mdx(nolocalhost, no access section at all), so the finding was correct and the sentence is now scoped to Docker and npm with a separate clause for Helm. A second pass on the amended diff returned no findings.Change Type
Feedback addressed
1546161795104768073(/de/docs/local)Validation
Run locally on Node 24.16.0 (the repo requires
>=22.0.0 <25):pnpm lint: passed (zero warnings)pnpm lint:prettier: passedpnpm typecheck: passedpnpm test: passed (313 tests, 22 files)pnpm build: passed, includingpostbuildand sitemap generationVerified in the build output rather than assumed: the callout is present in the prerendered
/docs/localHTML with the correct info styling, and it is picked up into the English search index andllms-full.txt. The/de/docs/localpage still builds cleanly and continues to serve the current German copy until the translation workflow runs.The default V8 heap is not enough for a full build of this site in the automation environment; the first attempt died with an OOM during webpack compilation and the run above used
--max-old-space-size=12288. That is an environment limit, unrelated to this change.Not changed
1546050296445276172(/docs): rating "good", no message and no additional embed fields. A bare positive rating with no request in it. Classification: NON-ACTIONABLE.content/docs/local/index.mdxwere deliberately left alone. English is the source of truth and the translation workflow owns the generated files./docs/local/npmWindows troubleshooting) and issue docs: the documentation never explains what LibreChat is for a first-time reader #747 (the docs never explain what LibreChat is) are adjacent but distinct, and neither is closed by this change. docs: /docs/local/npm needs a Windows troubleshooting section #748 needs a real Windows reproduction; docs: the documentation never explains what LibreChat is for a first-time reader #747 is a broader editorial gap about the product introduction.🤖 Generated with Claude Code
https://claude.ai/code/session_01UqsVMs6sqXvDj8KvRut897