[doc] align Docker Compose quick-start docs with required .env and loopback binding - #4359
[doc] align Docker Compose quick-start docs with required .env and loopback binding#4359Duansg wants to merge 3 commits into
Conversation
zqr10159
left a comment
There was a problem hiding this comment.
Thanks for aligning the quick-start documentation and release assembly. I verified the exact current head and found two items to address before approval:
- The newly added English and Chinese deployment notes run
docker compose config, but then tell users to restart withdocker-compose up -d. The documented prerequisite checks the Compose v2 plugin, and a v2-only installation is not guaranteed to provide the legacydocker-composeexecutable. Please usedocker compose up -dconsistently in both new notes. script/docker-compose/hertzbeat-postgresql-victoria-metrics/README_CN.mdline 1 contains trailing whitespace, so the PR range failsgit diff --check. Please remove it.
The substantive configuration and packaging behavior otherwise looks correct: all five Compose variants rendered successfully with the loopback defaults and independent bind overrides, the Java 25 startup/release package build passed, and the generated Docker Compose archive contains all five .env.example files with the expected fields.
…itespace - Use the Compose v2 `docker compose up -d` form in the new loopback-binding notes (en/zh), matching the documented `docker compose version` prerequisite. - Remove trailing whitespace on line 1 of the PostgreSQL+VictoriaMetrics README_CN.md so the PR range passes `git diff --check`. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01J5sdG2y5wVq8qwM4iez8wk
|
@zqr10159 Thanks for the careful review, both points are fixed in 30de922.
Re-verified after the fix: |
zqr10159
left a comment
There was a problem hiding this comment.
Re-reviewed the remediation on the current head. The Compose v2 command is now consistent in both deployment notes, the trailing whitespace is removed, the full PR range passes git diff --check, all five Compose variants render successfully, and all current GitHub checks are green. No remaining blocking findings.
What's changed?
Follow-up to #4295 and #4257. The Docker Compose quick-start docs still describe the old flow, which no longer works:
docker compose up -dfails immediately becausePOSTGRES_PASSWORDis now required, but the docs never mention.env.http://ip:1157/, but all published ports now bind to127.0.0.1by default..env.exampleis not included in thedocker-compose.tar.gzassembly, so users of the release package have nothing to copy.Changes:
docker-compose-deploy.md(en / zh-cn): add thecp .env.example .envstep, switch the access URL tolocalhost:1157, and add a note onHERTZBEAT_BIND_ADDRESS/HERTZBEAT_OTLP_BIND_ADDRESSfor remote access.assembly-docker-compose.xml: ship.env.examplewith every variant.hertzbeat-postgresql-victoria-metrics/README*.md: add the.envstep and the same "Listener scope" section that maintenance: scope quick-start listeners #4295 added to the GreptimeDB variant; fix the title, which said IoTDB.upgrade.md: sync the loopback-binding notes already present in the English version.Verified with
markdownlint-cli2(0 errors on the CI-linted files) andscript/ci/check-quickstart-compose.sh.Checklist
Add or update API