Document integrated InfluxDB 3 Explorer UI (v3.11+) - #7740
Draft
jstirnaman wants to merge 3 commits into
Draft
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/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/influxdb3/core/get-started/setup/_index.md |
https://reddit.com/r/influxdb | Error (cached) |
content/influxdb3/core/reference/config-options/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
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/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
content/influxdb3/enterprise/reference/config-options/_index.md |
https://support.influxdata.com/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
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/ | Network error: SSL certificate not trusted. Use --insecure if site is trusted (e… |
Full details: workflow run summary and artifact. Last updated: 2026-09-04 15:22:19 UTC
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
2 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.
Closes #
What changed
Added comprehensive documentation for the integrated InfluxDB 3 Explorer web UI that ships with InfluxDB 3 Enterprise v3.11+. The Explorer now runs as a WebAssembly (WASM) guest inside the server process instead of requiring a separate Docker container.
New content:
content/influxdb3/enterprise/visualize-data/explorer.mdcovering setup, configuration, and operational differences from the containerized versionwebuimode documentation to config options with two new settings:--webui-session-secretand--webui-openai-base-url--mode all,webuiflag for Enterprise v3.11+Key topics covered:
Why
InfluxDB 3 Enterprise v3.11 introduces a significant operational improvement by embedding Explorer directly in the server binary. This eliminates the need to run a separate container while maintaining feature parity. Documentation is needed to help users understand the new capability, how to enable it, and how it differs from the existing containerized approach.
Impact
Users running InfluxDB 3 Enterprise v3.11+ can now serve Explorer directly from their server without additional container orchestration. This simplifies deployment and reduces operational overhead. The documentation provides clear guidance on requirements, setup, and configuration options including the new AI chat feature.
Verification
npx hugo --quiet)Checklist
npx hugo --quiet)Suggested reviewers (click to expand)
Based on files changed, consider requesting review from:
https://claude.ai/code/session_01DEVE1zb7YVtzh5ZEVAxbdv