Document integrated InfluxDB 3 Explorer UI (v3.11+) - #7740
Merged
Merged
Conversation
## What changed - Add `content/influxdb3/enterprise/visualize-data/explorer.md`, the server-side deployment page for the integrated Explorer web UI. - Document the `webui` value of `--mode` in the shared config options reference. - Add an Enterprise-only "Web UI" section to the shared config options reference covering `--webui-session-secret` and `--webui-openai-base-url`. - Link the 3.11 release notes entry to the new page. ## Why Enterprise 3.11 ships Explorer inside the binary as a WebAssembly guest, but the only description of it was the release notes entry. Readers had no page that states the requirements, the startup command, or how the integrated UI differs from the Docker container. This is item 3 of the "Before the release" list in docs/exec-plans/2026-09-02-explorer-v110-release-readiness.md (PR #7734), which reserves the Enterprise-side WASM instructions for a separate change. It touches no file that PR #7734 restructures. ## Impact The new page carries `metadata: [InfluxDB 3 Enterprise v3.11+]` and shows both version checks (`influxdb3 --version` and `GET /ping`), following DOCS-VERSION-AVAILABILITY.md. The config options additions are gated with `show-in "enterprise"`, so Core output is unchanged. Four facts are marked with NEEDS VERIFICATION comments rather than guessed: the address that serves the UI, whether the first connection needs an operator token, how the AI chat endpoint authenticates, and the full `--webui-*` option list with its environment variable names. Extract those from `influxdb3 serve --help-all` and remove the comments before publishing. ## Verification - `npx hugo --quiet` builds without errors. - The `#web-ui`, `#webui-session-secret`, and `#webui-openai-base-url` anchors render in the Enterprise config options page and are absent from Core. - Every internal link on the new page resolves to a built page or anchor. - Vale and link-checker aren't installed in this environment, so neither ran. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01DEVE1zb7YVtzh5ZEVAxbdv
## What changed Add an Enterprise-only optional bullet to the "Start InfluxDB" option list in content/shared/influxdb3-get-started/setup.md, naming `--mode all,webui` and linking to the integrated Explorer deployment page. ## Why The setup guide is where a reader chooses their `influxdb3 serve` options. Without a mention there, the integrated web UI is reachable only from the release notes or the Visualize data section, so a reader setting up a 3.11 server has no reason to know the option exists. The bullet names the dependencies and defers the requirements and the full command to the deployment page rather than repeating them. ## Impact Enterprise only. The bullet is wrapped in `show-in "enterprise"`, and the Explorer link uses the explicit `/influxdb3/enterprise/` path rather than `/influxdb3/version/`, so the shared file produces no Core-side link to a page that doesn't exist in Core. ## Verification - `npx hugo --quiet` builds without errors. - The bullet renders on /influxdb3/enterprise/get-started/setup/ and is absent from the Core build of the same page. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01DEVE1zb7YVtzh5ZEVAxbdv
Contributor
Vale Style Check Results
✅ Check passed |
Contributor
Release version check
💡 Badge new features with the versionDocumenting a new feature? Add a version badge in the page frontmatter — the
For inline version text, use |
Contributor
🔗 Link Check Results — Link Check Bot✅ All links are valid
|
| Source File | URL | Issue |
|---|---|---|
content/influxdb3/core/get-started/setup/_index.md |
https://support.influxdata.com/ | Error (cached): Error (cached) |
content/influxdb3/core/reference/config-options/_index.md |
https://support.influxdata.com/ | Error (cached): Error (cached) |
content/influxdb3/core/release-notes/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/influxdb3/enterprise/get-started/setup/_index.md |
https://support.influxdata.com/ | Error (cached): Error (cached) |
content/influxdb3/enterprise/reference/config-options/_index.md |
https://support.influxdata.com/ | Error (cached): Error (cached) |
content/influxdb3/enterprise/release-notes/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/influxdb3/enterprise/visualize-data/explorer/_index.md |
https://support.influxdata.com/ | Error (cached): Error (cached) |
Full details: workflow run summary and artifact. Last updated: 2026-09-25 19:56:23 UTC
jstirnaman
marked this pull request as ready for review
September 16, 2026 19:36
jstirnaman
added
product:v3-monolith
## What changed Apply the review corrections from PR #7788 and the option list verified against a running Enterprise 3.11.5 server. Corrections from review: - `--plugin-dir` is optional. Explorer runs without a plugin directory; the directory is needed only for Explorer's plugin features. Corrected in the requirements list, the startup steps, the `mode` option, and the get-started setup bullet. - Explorer is served at the root path of the server's regular HTTP address and port, such as http://localhost:8181/, not on a separate listener. Added as a startup step and to the setup bullet. - Connection tokens: a resource token is enough to query and write; an admin token is required to manage databases, tokens, and other resources. - Every node in a cluster that serves Explorer needs the same session secret. - AI chat supports OpenAI, Anthropic, and Gemini, and each user supplies their own provider API key in Explorer's settings. No server option enables the feature. `--webui-openai-base-url` only redirects OpenAI requests and doesn't affect Anthropic or Gemini. - The Docker container isn't replaced by the integrated UI. It's required for Core and for Enterprise earlier than v3.11, and still works with v3.11 and later. Verified option list: - Document `--webui-cookie-secure` (`INFLUXDB3_WEBUI_COOKIE_SECURE`, default `false`), the third and last `--webui-*` option, and reference it from the access-control callout. - Remove the verification comment from the Web UI section. The option list is complete and both existing environment variable names are confirmed. Also add bidirectional navigation: `alt_links.explorer` and a `related` entry pointing at the Explorer install page. ## Why The page was written from the 3.11 release notes, which left the serving address, the token requirements, the AI chat model, and the full option list unstated. Those gaps were marked in the source rather than guessed. Product review answered them, and `influxdb3 serve --help-all` on 3.11.5 settled the option list. The v3.12 user-authentication behavior raised in the same review is left out; that release hasn't shipped. ## Impact Enterprise only; the Core build of the shared files is unchanged. Readers following the previous instructions would have created a plugin directory they didn't need and had no way to find the UI. ## Verification - `npx hugo --quiet` builds without errors. - `yarn lint-codeblocks` passes on all three files. - The `#webui-cookie-secure` anchor renders in the Enterprise config options page and is absent from Core. - No `NEEDS VERIFICATION` comments remain in the changed files. - `link-checker` isn't installed in this environment, so it didn't run. CI covers it. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01DEVE1zb7YVtzh5ZEVAxbdv
Contributor
Author
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
Documents the integrated InfluxDB 3 Explorer web UI that ships with InfluxDB 3
Enterprise v3.11 and later, where Explorer runs as a WebAssembly (WASM) guest
inside the server process instead of as a separate Docker container.
content/influxdb3/enterprise/visualize-data/explorer.md, coveringrequirements, the version check, the startup command, connecting Explorer to
the server, session secret handling, application data, AI chat, and how the
integrated UI differs from the container.
content/shared/influxdb3-cli/config-options.md: addswebuito themodevalues and a new Enterprise-only Web UI section documenting all three
--webui-*options.content/shared/influxdb3-get-started/setup.md: adds an Enterprise-only--mode all,webuibullet to theinfluxdb3 serveoption list.content/shared/v3-core-enterprise-release-notes/_index.md: links the 3.11Integrated Explorer entry to the new page.
Bidirectional navigation:
alt_links.explorerand arelatedentry connect thenew page to
/influxdb3/explorer/install/.Why
Enterprise 3.11 ships Explorer inside the binary, but the only description of it
was the release notes entry. There was no page stating the requirements, the
startup command, where to reach the UI, or how the integrated UI differs from
the container.
This is item 3 of the "Before the release" list in
docs/exec-plans/2026-09-02-explorer-v110-release-readiness.md, which reservesthe Enterprise-side WASM instructions for a separate change.
Verified facts
The first draft was written from the 3.11 release notes, which left several
behaviors unstated. Those gaps were marked in the source rather than guessed.
All are now resolved and the markers removed.
Product review on #7788 (@mavarius) established:
--plugin-diris optional. Explorer runs without a plugin directory; thedirectory is needed only for Explorer's plugin features. The earlier draft
listed it as a requirement.
port, such as
http://localhost:8181/. There's no separate listener or port.token is required to manage databases, tokens, and other resources.
own provider API key in Explorer's settings. No server option enables the
feature.
--webui-openai-base-urlonly redirects OpenAI requests and doesn'taffect Anthropic or Gemini.
and for Enterprise earlier than v3.11, and still works with v3.11 and later.
influxdb3 serve --help-allagainst a running Enterprise 3.11.5 server(
influxdb:3.11.5-enterprise, sha256:c14a7f1b) established the complete optionlist. There are exactly three
--webui-*options, and no otherINFLUXDB3_WEBUI_*variables:--webui-session-secretINFLUXDB3_WEBUI_SESSION_SECRETwebuimode--webui-cookie-secureINFLUXDB3_WEBUI_COOKIE_SECUREfalse--webui-openai-base-urlINFLUXDB3_WEBUI_OPENAI_BASE_URLdocs-tooling records this live verification as
claim-20260925-0202throughclaim-20260925-0205; that run includes a rerunnable capture script and asanitized transcript.
--webui-cookie-secureis new to this PR since the first review pass. It setsthe
Secureattribute on session cookies, so the page also notes that enablingit while reaching Explorer over plain HTTP prevents sessions from persisting.
The v3.12 user-authentication behavior raised in the same review is not
included here, because that release hasn't shipped. Those threads remain open on
#7788.
Impact
Enterprise only. The
webuimode value, the Web UI section, and the setupbullet are gated with
show-in "enterprise", so the Core build of the sharedfiles is unchanged. The Explorer link in the setup bullet uses an explicit
/influxdb3/enterprise/path rather than/influxdb3/version/, so the sharedfile produces no Core-side link to a page that doesn't exist in Core.
The new page carries
metadata: [InfluxDB 3 Enterprise v3.11+]and shows bothversion checks (
influxdb3 --versionandGET /ping), perDOCS-VERSION-AVAILABILITY.md.Readers following the earlier draft would have created a plugin directory they
didn't need and had no way to find the UI.
Verification
npx hugo --quietbuilds without errors.yarn lint-codeblockspasses on all changed content files.#web-ui,#webui-session-secret,#webui-cookie-secure, and#webui-openai-base-urlanchors render in the Enterprise config options pageand are absent from the Core build.
--mode all,webuibullet renders on the Enterprise get-started setup pageand is absent from the Core build.
NEEDS VERIFICATIONcomments remain in the changed files.link-checkerweren't available in the authoring environment, soneither ran locally. Both run in CI and are green on the current head.
Coordination
#7788 restructures
content/influxdb3/explorer/install.mdintoinstall/_index.mdandinstall/docker.mdagainst baserelease/explorer-v1.10, and carries its own earlier copy ofcontent/influxdb3/enterprise/visualize-data/explorer.md. This PR touches noneof the files #7788 restructures, and keeps
/influxdb3/explorer/install/linksas-is, because
/influxdb3/explorer/install/docker/doesn't exist onmasteryet. Whichever PR merges second will need to reconcile the duplicated page.
Checklist
npx hugo --quiet)Suggested reviewers (click to expand)
Based on files changed, consider requesting review from:
https://claude.ai/code/session_01DEVE1zb7YVtzh5ZEVAxbdv