Correct Horizon UI setup docs (Docker Hub image, port 8081, horizon.yaml config)#13888
Merged
Conversation
…aml config The UI setup docs pointed operators at the GHCR dev registry, used port 8080, and documented SW_OAP_ADDRESS / SW_ADMIN_ADDRESS / SW_ZIPKIN_ADDRESS environment variables that Horizon UI does not read (it is configured via a mounted horizon.yaml). Correct them: - Released images come from Docker Hub apache/skywalking-ui (latest / horizon-<version>); ghcr.io/apache/skywalking-horizon-ui is per-commit/dev only. - Default port is 8081 (Horizon BFF), not 8080. - Configuration is via horizon.yaml (oap.queryUrl/adminUrl/zipkinUrl), not environment variables. - Do not lock a Horizon UI version: OAP 11.0+ is supported and compatibility is Horizon UI's responsibility. - Keep the OAP-side docs to basics and link to the Horizon UI website docs; drop source-code links. Also align the Helm ui.image examples, the changelog upgrade path, and the release guide for consistency. Verified against the Horizon UI source and the skywalking-helm chart (ui-svc.yaml: service port 80 -> targetPort 8081).
wu-sheng
added
the
documentation
wankai123
approved these changes
Jun 2, 2026
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.
Fix incorrect Horizon UI setup documentation
The Horizon UI setup docs predated Horizon UI's settled configuration surface and were factually wrong on three counts:
apache/skywalking-ui(tagslatest/horizon-<version>);ghcr.io/apache/skywalking-horizon-uiis per-commit/dev only.docker runexample used8080. Horizon UI's BFF binds 8081 (EXPOSE 8081).SW_OAP_ADDRESS/SW_ADMIN_ADDRESS/SW_ZIPKIN_ADDRESSenvironment variables that Horizon UI does not read. It is configured via a mountedhorizon.yaml(oap.queryUrl/oap.adminUrl/oap.zipkinUrl), so the old example could not have worked.This PR corrects those and applies the same registry/version policy across the docs:
setup/backend/ui-setup.md— rewritten: Docker Hub image, port 8081,horizon.yamlconfig, no-default-login note, no Horizon UI version lock (OAP11.0+supported; compatibility is Horizon UI's responsibility), high-level "what Horizon provides", and links to the Horizon UI website docs only.ui/README.md— drop the source-code link; describe the bundled set (default per-layer dashboard configs, overview / 3D infra-map setups, sidebar menu, i18n) at a high level.changes/changes.md— fix the 11.0.0 breaking-change entry's registry + upgrade-path references; unlock the version.setup/backend/backend-telemetry.md+academy/diagnose-service-mesh-network-performance-with-ebpf.md— Helmui.image.repository=apache/skywalking-ui, decouple the UI tag from the OAP$TAG.guides/How-to-release.md— distinguish Docker Hub (releases) from GHCR (per-commit dev).Verified against the Horizon UI source (
apache/skywalking-horizon-ui, incl.publish-image.yaml,horizon.example.yaml,docs/) and theskywalking-helmchart (ui-svc.yaml: Service port80→ targetPort8081, andvalues.yamlwhich documents the same registry policy).CHANGESlog. (Documentation correction — no new functional change to log; this PR corrects an existing 11.0.0 entry.)