unbridled-41 opened a new issue, #5470:
URL: https://github.com/apache/rocketmq-dashboard/issues/5470

   ### Studio Version
   branch: `rocketmq-studio` @ `6a68042f` (the revision verified; the branch is 
based on it)
   deployed as: docker compose
   
   ### Which Documentation
   
   `CONTRIBUTING.md` (Run the full stack) and the port line in `README.md` / 
`README_zh.md`.
   
   ### What Is Wrong
   
   CONTRIBUTING states that after the documented full-stack command the studio 
is available at `<http://127.0.0.1:6789>` (frontend) **and** 
`<http://127.0.0.1:8888>` (backend). The backend port is never published to the 
host:
   
   ```
   $ docker compose -f deploy/docker-compose.yml config
     mysql:           published 3306
     rocketmq-web:    published 6789
     rocketmq-server: expose 8888          # no host mapping
   ```
   
   `deploy/nginx.conf` proxies `/api/` to `http://rocketmq-server:8888`, so the 
API is reachable through 6789. The 8888 URL is only valid when the backend runs 
outside compose (`mvn spring-boot:run`, which the next CONTRIBUTING section 
does).
   
   ### Suggested Change
   
   Correct the sentence to say the API is served through 6789, that 8888 is 
container-internal, and qualify the port line in both READMEs.
   
   ### Evidence
   
   - `CONTRIBUTING.md:40`, `README.md`/`README_zh.md` port lines, 
`deploy/docker-compose.yml` (`expose: 8888`, no `ports:` for 
`rocketmq-server`), `deploy/nginx.conf` (`location /api/`).
   - Executed `docker compose -f deploy/docker-compose.yml config` (output 
above) and confirmed `curl http://127.0.0.1:8888/...` cannot be reached from 
the host while `http://127.0.0.1:6789/api/...` is the front door.
   
   ### Impact
   
   A contributor following the section tries a URL that refuses the connection 
and is not told which one works.
   
   ### Acceptance Criteria
   
   - The documents say which port is published; no port or manifest changes.
   
   **Corresponding PR:** #5439
   


-- 
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: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to