You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@rocketmq.apache.org by "unbridled-41 (via GitHub)" <gi...@apache.org> on 2026/10/03 04:46:31 UTC
[I] [Doc] deploy/README.md's local compose quickstart omits the shared-network step and cannot start [rocketmq-dashboard]
unbridled-41 opened a new issue, #5463:
URL: https://github.com/apache/rocketmq-dashboard/issues/5463
### Studio Version
branch: `rocketmq-studio` @ `6a68042f` (the revision verified; the branch is based on it)
deployed as: docker compose (reproduced with docker 29.1.3 / compose v2.32.4)
### Which Documentation
`deploy/README.md`, section 本地 Docker Compose (the studio-only compose quickstart).
### What Is Wrong
`deploy/docker-compose.yml` attaches `mysql` and `rocketmq-server` to the externally-declared `rocketmq_net`, but the quickstart only says to copy `.env` and run compose. On a host that has not created the network the command aborts:
```
$ cd deploy && docker compose -f docker-compose.yml up --dry-run --no-start
network rocketmq_net declared as external, but could not be found
```
The other documented entry points already create it (`deploy/rocketmq/README.md`, `deploy/deploy.sh`), and the root README's Quick Start gained the same idempotent step in #5096; this section was the remaining one without it.
### Suggested Change
Add the idempotent step, in the phrasing the root README uses:
```bash
docker network inspect rocketmq_net >/dev/null 2>&1 || docker network create rocketmq_net
```
### Evidence
- `deploy/docker-compose.yml` (the external network and the two services that join it), `deploy/README.md` (the section), `deploy/deploy.sh` and `deploy/rocketmq/README.md` (the step, already present).
- Executed: the dry-run fails as quoted above; after running the documented command the same dry-run proceeds and creates every container (`Container rocketmq-server Created`, `Container rocketmq-web Created`); the temporary network was removed afterwards.
### Impact
Following the local quickstart on a fresh host fails outright, and the working alternative is not stated in that document.
### Acceptance Criteria
- The section's command sequence succeeds on a host without the network.
Related: #5095 (the same class, fixed for the root README by #5096 — this document was not covered).
**Corresponding PR:** #5431
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@rocketmq.apache.org.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] [Doc] deploy/README.md's local compose quickstart omits the shared-network step and cannot start [rocketmq-dashboard]
Posted by "lizhimins (via GitHub)" <gi...@apache.org>.
lizhimins closed issue #5463: [Doc] deploy/README.md's local compose quickstart omits the shared-network step and cannot start
URL: https://github.com/apache/rocketmq-dashboard/issues/5463
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@rocketmq.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [I] [Doc] deploy/README.md's local compose quickstart omits the shared-network step and cannot start [rocketmq-dashboard]
Posted by "lizhimins (via GitHub)" <gi...@apache.org>.
lizhimins commented on issue #5463:
URL: https://github.com/apache/rocketmq-dashboard/issues/5463#issuecomment-6078540218
Resolved by #5438 (merged into `rocketmq-studio` as e45a1e5da); the fix was contributed in #5431, which we folded into that change.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@rocketmq.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org