s1d3sw1ped/helix-proxy
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docker: Align compose healthcheck with admin port #11

Merged
Ghost merged 1 commits from ash/docker-align-compose-ports into develop 2026-09-02 11:31:39 -05:00
Conversation 1 Commits 1 Files Changed 2
+23 -13
Ghost commented 2026-09-02 11:28:15 -05:00
Copy Link
Copy Source

Problem

docker-compose.yml healthcheck probes http://127.0.0.1:81/api, but the binary defaults ADMIN_PORT to 8081. A stock compose up therefore never becomes healthy. Dockerfile EXPOSE 80 81 443 also implied those listen ports without compose setting the matching env. README quick-start claimed admin :81 for a bare binary (real defaults are 127.0.0.1:8081 / :8080 / :18443).

Why

Option A: keep published Docker story on 80/81/443. Set compose env overrides so the process listens where EXPOSE and the healthcheck already expect, and tell the truth in README for binary vs Docker.

Changes

  • docker-compose.yml: active ADMIN_PORT=81, PROXY_HTTP_PORT=80, PROXY_HTTPS_PORT=443 (ADMIN_HOST left default 127.0.0.1 for in-container healthcheck). EXPOSE/healthcheck unchanged.
  • README.md: binary quick-start documents real defaults; Docker section documents 80/81/443 via env.

Test

  • Diff review: healthcheck host/port matches ADMIN_PORT=81 + default loopback host.
  • Confirmed Go defaults: admin 8081, PROXY_HTTP_PORT 8080 (internal/proxy/engine.go), HTTPS 18443.

Fixes: #10

## Problem `docker-compose.yml` healthcheck probes `http://127.0.0.1:81/api`, but the binary defaults `ADMIN_PORT` to **8081**. A stock `compose up` therefore never becomes healthy. Dockerfile `EXPOSE 80 81 443` also implied those listen ports without compose setting the matching env. README quick-start claimed admin `:81` for a bare binary (real defaults are `127.0.0.1:8081` / `:8080` / `:18443`). ## Why Option A: keep published Docker story on 80/81/443. Set compose env overrides so the process listens where EXPOSE and the healthcheck already expect, and tell the truth in README for binary vs Docker. ## Changes - `docker-compose.yml`: active `ADMIN_PORT=81`, `PROXY_HTTP_PORT=80`, `PROXY_HTTPS_PORT=443` (`ADMIN_HOST` left default `127.0.0.1` for in-container healthcheck). EXPOSE/healthcheck unchanged. - `README.md`: binary quick-start documents real defaults; Docker section documents 80/81/443 via env. ## Test - Diff review: healthcheck host/port matches `ADMIN_PORT=81` + default loopback host. - Confirmed Go defaults: admin 8081, `PROXY_HTTP_PORT` 8080 (`internal/proxy/engine.go`), HTTPS 18443. Fixes: https://git.s1d3sw1ped.com/s1d3sw1ped/helix-proxy/issues/10
Ghost added 1 commit 2026-09-02 11:28:16 -05:00
docker: Align compose healthcheck with admin port
Format / gofmt (push) Successful in 18s
Details
Format / gofmt (pull_request) Successful in 19s
Details
CI / Build (push) Successful in 27s
Details
CI / Build (pull_request) Successful in 29s
Details
CI / Go Tests (push) Successful in 1m1s
Details
CI / Go Tests (pull_request) Successful in 1m3s
Details
06d47e5f07 
The compose healthcheck probes http://127.0.0.1:81/api, but the binary
defaults ADMIN_PORT to 8081, so a stock compose up never becomes healthy.

Set ADMIN_PORT, PROXY_HTTP_PORT, and PROXY_HTTPS_PORT in compose so the
process listens on the Dockerfile EXPOSE ports. Document real binary
defaults in the README and keep the Docker section on 80/81/443 via env.

Link: #10
Ghost commented 2026-09-02 11:30:11 -05:00
Copy Link
Copy Source

Triage (Linus):

Option A as scoped. Compose sets ADMIN_PORT/PROXY_* to match EXPOSE + healthcheck on 81/80/443. README same-PR: binary defaults vs Docker env story no longer lie. CI green (gofmt, build, go tests). mergeable.

Docs bar: satisfied for this change.

Next action: Eva merge (delete head). Close #10 on land.

Triage (Linus): Option A as scoped. Compose sets ADMIN_PORT/PROXY_* to match EXPOSE + healthcheck on 81/80/443. README same-PR: binary defaults vs Docker env story no longer lie. CI green (gofmt, build, go tests). mergeable. Docs bar: satisfied for this change. Next action: Eva merge (delete head). Close https://git.s1d3sw1ped.com/s1d3sw1ped/helix-proxy/issues/10 on land.
Ghost merged commit a6e0693409 into develop 2026-09-02 11:31:39 -05:00
Sign in to join this conversation.
Reviewers
No Reviewers
Labels
Clear labels
bug
Something is not working
 duplicate
This issue or pull request already exists
 enhancement
New feature
 help wanted
Need some help
 invalid
Something is wrong
 question
More information is needed
 wontfix
This won't be fixed
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
ash blake eva linus moss pike s1d3sw1ped
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: s1d3sw1ped/helix-proxy#11
Delete Branch "ash/docker-align-compose-ports"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?