docs(influxdb3_ui): Explorer restructure for Enterprise WASM integration - #7788
Merged
jstirnaman merged 14 commits intoOct 1, 2026
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
What changed: Adds docs/exec-plans/2026-09-02-explorer-install-version-routing.md, the decision record for restructuring the InfluxDB 3 Explorer install documentation ahead of the v1.10 release. Why: Explorer v1.9 is the last release distributed as a standalone Docker container. Starting with v1.10, Explorer is included with InfluxDB 3 Enterprise and deployed as WebAssembly (WASM). The current pages state no version or edition scope, so readers, search engines, retrieval systems, and coding agents all get Docker as the unconditional answer to "how do I install Explorer". Impact: Documentation only. No content or template changes in this commit. The record fixes the approach before implementation: keep the /influxdb3/explorer/install/ URL as a version-routing hub, move the Docker body to a child page that declares its version ceiling, and use existing frontmatter (metadata, cascade.prepend) instead of new template logic. Verification: None required for this commit. The exec-plan lists the verification steps for the implementation that follows. Claude-Session: https://claude.ai/code/session_01DZg2nkJ1rSRVqp2R9hZZh7
…iness plan What changed: - Adds DOCS-VERSION-AVAILABILITY.md, which documents how to state a version or edition constraint: which marker to use for page-wide versus section-level scope, which surface carries which fact, where a page lives when a feature spans two products, the version-check pattern, and how temporary notices are retired. - Adds docs/exec-plans/2026-09-02-explorer-v110-release-readiness.md, the ordered pre-release, release-day, and post-release task sequence for the Explorer v1.10 and InfluxDB 3 Enterprise release. - Lists the new reference in AGENTS.md and regenerates the instruction adapters. Why: The install restructure exec-plan prepares version routing but leaves the WASM instructions, products.yml updates, and hub lede flip until v1.10 ships. The release sequence needs to exist before release day. The conventions are feature-agnostic and apply to any version-gated documentation, so they belong in a durable reference rather than in a per-release plan. Impact: Documentation for contributors and agents. No published content changes. The conventions reference links to DOCS-FRONTMATTER.md and DOCS-AI-VISIBILITY.md instead of restating field syntax or artifact layers. It records that data/notifications.yaml renders in the footer and therefore never reaches Markdown twins or llms-full.txt, so a version fact stated only in a notification is invisible to AI consumers. Verification: yarn build:agent:instructions and yarn validate:agent-instructions both pass. Markdown lint passes on the new files. Claude-Session: https://claude.ai/code/session_01DZg2nkJ1rSRVqp2R9hZZh7
What changed: Slims the release readiness exec-plan to the v1.10 release. Adds the decision that every new feature page shows the reader how to check whether their version has the feature, covering both the Explorer version and the InfluxDB 3 server version and edition. Replaces the draft:true default with merging at release, keeping draft:true for specific cases such as a link target other merged content needs. Why: The first draft stated version markers but not how a reader arriving from search determines which version they're running, and it assumed a publishing workflow the team doesn't use. Impact: Planning document only. Verification: Markdown lint passes. Claude-Session: https://claude.ai/code/session_01DZg2nkJ1rSRVqp2R9hZZh7
Convert /influxdb3/explorer/install/ into a version-routing hub and move the Docker instructions to install/docker.md with an explicit version ceiling (v1.9 and earlier). Explorer v1.10+ ships with InfluxDB 3 Enterprise as WASM instead of a standalone container, so the old Docker-only page misled readers and retrieval systems about the current distribution model. - install/docker.md: metadata frontmatter states the version ceiling in the frontmatter, description, and lede; anchors are unchanged. - install/_index.md: new hub that routes by version/edition and shows the GET /ping check. - explorer/_index.md: cascade.prepend transition notice and a version-branched quick start. - about/_index.md: states the v1.9/v1.10 distribution split. - Seven inbound links updated to point at the hub or install/docker/#anchor. Implements the restructure described in PR #7734's linked exec-plan (docs/exec-plans/2026-09-02-explorer-install-version-routing.md).
What changed: - Split install.md into install/_index.md (a version-routing hub) and install/docker.md (Docker instructions scoped to InfluxDB 3 Core and Enterprise earlier than v3.11). - Added a GET /ping-based version/edition check to the hub, and a cascade.prepend transition notice on explorer/_index.md. - Propagated the InfluxDB 3 Enterprise v3.11+ (integrated WASM) vs. Docker scoping to about/_index.md, get-started.md, manage-databases.md, and manage-tokens.md, replacing links/claims that assumed Docker is the only deployment. - Fixed inbound links across content/shared, enterprise, and explorer pages to point at the hub or the Docker page as appropriate; preserved the three anchors other pages link into. - Added bidirectional alt_links and related entries between the install hub and content/influxdb3/enterprise/visualize-data/explorer.md, so the product switcher and related links connect the two halves of this split feature. Why: the Explorer install docs described Docker as the only distribution with no version or edition scoping, so a docs-grounded assistant could only infer that no other install path exists (issue #6702). InfluxDB 3 Enterprise v3.11 added an integrated WASM alternative to the Docker container without any corresponding doc changes. Verification: npx hugo --quiet builds clean; yarn lint-codeblocks passes on all changed files; node scripts/check-jsonld-links.js reports no dangling @id references; manually confirmed the three preserved anchors resolve and no in-repo link still points at the old /install/#anchor paths.
Contributor
Vale Style Check Results
Warnings (14)
✅ 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/enterprise/visualize-data/explorer/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/influxdb3/explorer/about/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/influxdb3/explorer/get-started/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/influxdb3/explorer/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/influxdb3/explorer/install/docker/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/influxdb3/explorer/install/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/influxdb3/explorer/manage-databases/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/influxdb3/explorer/manage-tokens/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/influxdb3/explorer/release-notes/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
Full details: workflow run summary and artifact. Last updated: 2026-09-30 00:14:39 UTC
jstirnaman
changed the base branch from
master
to
claude/influxdb-explorer-wasm-docs-ooa7ue
September 18, 2026 15:34
jstirnaman
added
release:pending
jstirnaman
changed the base branch from
claude/influxdb-explorer-wasm-docs-ooa7ue
to
master
September 18, 2026 15:42
mavarius
reviewed
Sep 25, 2026
mavarius
left a comment
mavarius
left a comment
Collaborator
There was a problem hiding this comment.
Overall a good start. I'll need to open another docs pr after this to add the user authentication capabilities.
| {{% product-name %}} requires | ||
| [`--webui-session-secret`](/influxdb3/enterprise/reference/config-options/#webui-session-secret) | ||
| whenever `webui` mode is enabled, and doesn't start without it. | ||
| - A plugin directory. |
Collaborator
There was a problem hiding this comment.
A plugin directory (and the --plugin-dir flag) isn't strictly needed to run Explorer but it is needed to use plugins and the plugin features in Explorer.
| > To control which interface the server listens on, see | ||
| > [`--http-bind`](/influxdb3/enterprise/reference/config-options/#http-bind). | ||
|
|
||
| <!-- NEEDS VERIFICATION: the address and path that serve Explorer when `webui` |
Collaborator
There was a problem hiding this comment.
Explorer is served on the server's normal address and port, at the root: http://localhost:8181/.
| For the connection fields and the steps to create a connection, see | ||
| [Get started with InfluxDB 3 Explorer](/influxdb3/explorer/get-started/). | ||
|
|
||
| <!-- NEEDS VERIFICATION: whether the integrated Explorer requires an operator |
Collaborator
There was a problem hiding this comment.
If you're not using user authentication, you can use either an admin or resource token but you need an admin token to manage the resources like databases etc. If you are using user authentication then it will automatically connect to the database and you can create your first user from the UI (in version 3.12+).
| > [!Important] | ||
| > #### Control who can reach Explorer | ||
| > | ||
| > Anyone who can reach Explorer can use the InfluxDB connection configured in |
Collaborator
There was a problem hiding this comment.
This is true if not using user authentication. With user auth, they'll need to login and their role will dictate what they have permission to (in v3.12+).
| `--webui-session-secret` signs the session cookies that Explorer issues. | ||
| The server requires the option whenever `webui` mode is enabled. | ||
|
|
||
| - **Generate the secret once and reuse it.** |
Collaborator
There was a problem hiding this comment.
If several nodes serve Explorer, they all need the same secret.
| ## Enable AI chat | ||
|
|
||
| Explorer includes an AI chat feature that you can point at any | ||
| OpenAI-compatible endpoint. |
Collaborator
There was a problem hiding this comment.
Users enter their AI API key in Explorer's settings, not on the server. Explorer supports OpenAI, Anthropic, and Gemini. This option only changes where OpenAI requests go.
| credential option), document it here. `influxdb3 serve --help-all` lists every | ||
| option in a specific build. --> | ||
|
|
||
| ## Choose between integrated and containerized Explorer |
| Use [Docker](https://docker.com) to install and run **InfluxDB 3 Explorer**. | ||
| Use [Docker](https://docker.com) to install and run **InfluxDB 3 Explorer** | ||
| as a standalone container against InfluxDB 3 Core or InfluxDB 3 Enterprise | ||
| earlier than v3.11. |
Collaborator
There was a problem hiding this comment.
The Docker version of Explorer works with Enterprise 3.11 and later too. It's just not required there. Maybe we can say, "Required for Core and for Enterprise before 3.11."
Contributor
Author
There was a problem hiding this comment.
The Docker version of Explorer works with Enterprise 3.11 and later too. It's just not required there. Maybe we can say, "Required for Core and for Enterprise before 3.11."
👍 I probably steered too hard toward the "recommended path".
2 of 3 tasks
jstirnaman
pushed a commit
that referenced
this pull request
Sep 25, 2026
## 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
jstirnaman
pushed a commit
that referenced
this pull request
Sep 25, 2026
## 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
github-actions
Bot
added
product:shared
What changed: Port the Enterprise 3.11.5 Explorer corrections from master and update Docker compatibility across the install route. Why: Product review confirmed the UI URL, token rules, AI key handling, optional plugin directory, and continued Docker support for Enterprise 3.11+. Impact: The release branch now documents both deployment paths accurately and removes stale verification comments. Verification: Hugo build, code-block lint, link checks, and Markdown coherence pass.
jstirnaman
changed the base branch from
release/explorer-v1.10
to
explorer-v1.11-version-bump
October 1, 2026 02:44
jstirnaman
pushed a commit
that referenced
this pull request
Oct 1, 2026
## 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
jstirnaman
force-pushed
the
explorer-v1.11-version-bump
branch
from
October 1, 2026 03:37
492248b to
62e1a39
Compare
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
install/docker/and preserve the existing deep links.master: Explorer's URL, token permissions, AI provider keys, optional plugin directory, session secret, and web UI options.DOCS-VERSION-AVAILABILITY.md; the current guide is already onmaster.master.Why
The install docs presented Docker as the only Explorer deployment. Enterprise v3.11 also includes an integrated Explorer UI. Product review in this PR confirmed the deployment details and that the Docker container still works with later Enterprise releases. Closes #6702.
Impact
Readers can choose the deployment that fits their InfluxDB 3 server. The Docker instructions remain available for Core and every supported Enterprise version. No runtime behavior changes.
Verification
Completed:
@mavariusverified the integrated UI URL, token requirements, AI key handling, optional plugin directory, and Docker compatibility in this PR's review.mastercommitf63b63ec8to this PR's release branch.npx hugo --quietbuilds.yarn verify:changed -- --runpasses code-block and link checks for the changed content and shared-content consumers.yarn build:md,yarn build:llms-full, andyarn check:md-coherencepass.node scripts/check-jsonld-links.js(18 nodes across 6,098 HTML pages).influxdb3_explorer.latest_patch: 1.11.0against the release branch.Open on release day:
Open at v1.11:
Open verification:
llms-full.txt.master.