Skip to content

docs(guides): DASHBOARD_ALLOW_EMBED is a build-time flag, not a runtime one - #10697

Merged
diegosouzapw merged 3 commits into
release/v3.8.50from
docs/dashboard-embed-buildtime
Aug 18, 2026
Merged

diegosouzapw merged 3 commits into
release/v3.8.50from
docs/dashboard-embed-buildtime

Conversation

@diegosouzapw

@diegosouzapw diegosouzapw commented Aug 18, 2026 •

Copy link
Copy Markdown
Owner

Problem

docs/guides/VSCODE-COPILOT.md told operators to start OmniRoute with
DASHBOARD_ALLOW_EMBED=vscode omniroute. That never works on a prebuilt install.

Next.js compiles headers() into the route manifest, so next.config.mjs reads the variable
while the bundle is built — the comment at next.config.mjs L83-86 says so explicitly
("Read at build time … so changing it requires a rebuild"), and
docs/reference/ENVIRONMENT.md + .env.example already documented it correctly. Only the
how-to guide was wrong, and it is the page a user actually follows.

Consequence: anyone on npm install -g omniroute or the Docker image sets the variable,
restarts, and the dashboard still refuses to frame — with no hint why. The OmniCopilot
extension's own fallback message already words it right ("a build-time option, so setting the
variable on an existing install is not enough"); the guide contradicted it.

Change

Docs only — no source touched.

  • Replaces the runtime recipe with the build-time one (DASHBOARD_ALLOW_EMBED=vscode npm run build)
  • Adds a table of which install paths can enable embedding at all (source ✅, global npm ❌, Docker ❌)
  • Fixes the troubleshooting row that repeated the same wrong instruction

Known gap (not fixed here)

The Dockerfile has no ARG DASHBOARD_ALLOW_EMBED, so Docker users cannot pass it through
--build-arg — they have to edit the Dockerfile. Adding the ARG+ENV pair next to
OMNIROUTE_BASE_PATH (L140-141) would turn that ❌ into a ✅; deliberately left out of a
docs-only PR.

Verification

npm run check:docs-all — check-doc-links PASS (841 internal links), check-fabricated-docs
PASS. The drift warnings it prints are pre-existing and advisory.

⚠️ base-red inherited: #9985

Refs #10273


The Merge integrity red on this PR is inherited, not caused here: check:agent-skills-sync fails identically on a pristine checkout of the base tip. Discriminated and fixed in #10698.

The VS Code guide told operators to "start OmniRoute with
DASHBOARD_ALLOW_EMBED=vscode". Next.js compiles headers() into the route
manifest, so next.config.mjs reads the variable while the bundle is built —
exporting it in front of an already-built server does nothing, which is the
exact trap anyone on `npm install -g omniroute` or the Docker image falls into.

Documents the build-time nature, the working from-source recipe, and which
install paths can enable it at all. ENVIRONMENT.md and .env.example already
said build-time; this aligns the how-to with them and with the extension's own
fallback message.
The release notes only mentioned OmniCopilot in passing, inside the DASHBOARD_ALLOW_EMBED bullet — a reader would never learn the extension exists. Adds the fragment that says it plainly, with both store links.
@diegosouzapw
diegosouzapw merged commit d7368e2 into release/v3.8.50 Aug 18, 2026
18 checks passed
@diegosouzapw
diegosouzapw deleted the docs/dashboard-embed-buildtime branch August 18, 2026 23:36
HouMinXi pushed a commit to HouMinXi/OmniRoute that referenced this pull request Aug 20, 2026
…me one (diegosouzapw#10697)

* docs(guides): DASHBOARD_ALLOW_EMBED is build-time, not a runtime flag

The VS Code guide told operators to "start OmniRoute with
DASHBOARD_ALLOW_EMBED=vscode". Next.js compiles headers() into the route
manifest, so next.config.mjs reads the variable while the bundle is built —
exporting it in front of an already-built server does nothing, which is the
exact trap anyone on `npm install -g omniroute` or the Docker image falls into.

Documents the build-time nature, the working from-source recipe, and which
install paths can enable it at all. ENVIRONMENT.md and .env.example already
said build-time; this aligns the how-to with them and with the extension's own
fallback message.

* docs(changelog): announce the VS Code Copilot Chat integration

The release notes only mentioned OmniCopilot in passing, inside the DASHBOARD_ALLOW_EMBED bullet — a reader would never learn the extension exists. Adds the fragment that says it plainly, with both store links.

---------

Co-authored-by: Xiangzhe <bakryun0718@proton.me>
giauphan pushed a commit to giauphan/OmniRoute that referenced this pull request Aug 20, 2026
…me one (diegosouzapw#10697)

* docs(guides): DASHBOARD_ALLOW_EMBED is build-time, not a runtime flag

The VS Code guide told operators to "start OmniRoute with
DASHBOARD_ALLOW_EMBED=vscode". Next.js compiles headers() into the route
manifest, so next.config.mjs reads the variable while the bundle is built —
exporting it in front of an already-built server does nothing, which is the
exact trap anyone on `npm install -g omniroute` or the Docker image falls into.

Documents the build-time nature, the working from-source recipe, and which
install paths can enable it at all. ENVIRONMENT.md and .env.example already
said build-time; this aligns the how-to with them and with the extension's own
fallback message.

* docs(changelog): announce the VS Code Copilot Chat integration

The release notes only mentioned OmniCopilot in passing, inside the DASHBOARD_ALLOW_EMBED bullet — a reader would never learn the extension exists. Adds the fragment that says it plainly, with both store links.

---------

Co-authored-by: Xiangzhe <bakryun0718@proton.me>
@diegosouzapw diegosouzapw mentioned this pull request Aug 23, 2026
muhamadgalihsaputra pushed a commit to niyatna/NiyatnaRoute that referenced this pull request Sep 27, 2026
…me one (diegosouzapw#10697)

* docs(guides): DASHBOARD_ALLOW_EMBED is build-time, not a runtime flag

The VS Code guide told operators to "start OmniRoute with
DASHBOARD_ALLOW_EMBED=vscode". Next.js compiles headers() into the route
manifest, so next.config.mjs reads the variable while the bundle is built —
exporting it in front of an already-built server does nothing, which is the
exact trap anyone on `npm install -g omniroute` or the Docker image falls into.

Documents the build-time nature, the working from-source recipe, and which
install paths can enable it at all. ENVIRONMENT.md and .env.example already
said build-time; this aligns the how-to with them and with the extension's own
fallback message.

* docs(changelog): announce the VS Code Copilot Chat integration

The release notes only mentioned OmniCopilot in passing, inside the DASHBOARD_ALLOW_EMBED bullet — a reader would never learn the extension exists. Adds the fragment that says it plainly, with both store links.

---------

Co-authored-by: Xiangzhe <bakryun0718@proton.me>
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.

2 participants