docker: Align compose healthcheck with admin port
Format / gofmt (push) Successful in 14s
CI / Build (push) Successful in 22s
CI / Go Tests (push) Successful in 57s
Format / gofmt (pull_request) Successful in 14s
CI / Build (pull_request) Successful in 26s
CI / Go Tests (pull_request) Successful in 58s

Set compose ADMIN_PORT/PROXY_* to 81/80/443 so healthcheck and EXPOSE match;
document binary defaults vs Docker ports in README.

Fixes #10
This commit was merged in pull request #11.
This commit is contained in:
s1d3sw1ped_bot
2026-09-02 11:31:39 -05:00
parent 6615cc218e
commit a6e0693409
2 changed files with 23 additions and 13 deletions
+11 -5
View File
@@ -13,22 +13,28 @@ A pure-Go reverse proxy with embedded web UI. Supports proxy hosts, TCP/UDP stre
```bash ```bash
make # builds UI (placeholder) + Go binary with embed make # builds UI (placeholder) + Go binary with embed
./helix-proxy ./helix-proxy
# Admin UI + API on :81 # Admin UI + API on 127.0.0.1:8081
# Proxy on :8080 (or 80/443 when you have perms / run in docker) # Proxy HTTP on :8080, HTTPS on :18443
``` ```
Visit http://localhost:81 Visit http://localhost:8081
Data (db, certs, logs, www html) lives in `./data` relative to where you ran the binary. Data (db, certs, logs, www html) lives in `./data` relative to where you ran the binary.
## Docker (recommended) ## Docker (recommended)
```bash ```bash
docker compose up -d docker compose up -d
# compose sets ADMIN_PORT=81 PROXY_HTTP_PORT=80 PROXY_HTTPS_PORT=443
# proxy :80/:443 published; admin binds 127.0.0.1:81 (not published by default)
# or # or
docker build -t helix-proxy:dev . docker build -t helix-proxy:dev .
docker run -p 81:81 -v $PWD/data:/app/data --workdir /app helix-proxy:dev docker run -p 80:80 -p 443:443 \
-e ADMIN_PORT=81 -e PROXY_HTTP_PORT=80 -e PROXY_HTTPS_PORT=443 \
-v $PWD/data:/app/data --workdir /app helix-proxy:dev
``` ```
Publishing admin (`-p 81:81`) also needs `-e ADMIN_HOST=0.0.0.0`. Do not publish :81 on untrusted networks.
PUID/PGID + DISABLE_IPV6 example (see docker-compose.yml for full): PUID/PGID + DISABLE_IPV6 example (see docker-compose.yml for full):
```yaml ```yaml
# user: "0:0" # root to allow chown+drop inside # user: "0:0" # root to allow chown+drop inside
@@ -41,7 +47,7 @@ environment:
Binary auto-chowns data tree (if started root) then drops privs (unless PUID_NO_DROP); umask support via UMASK env. Files 0600, dirs 0755. Binary auto-chowns data tree (if started root) then drops privs (unless PUID_NO_DROP); umask support via UMASK env. Files 0600, dirs 0755.
Note: privilege drop happens early (before listeners); low-port binds require either root (with PUID_NO_DROP), capabilities, high ports in config, or external setuid wrapper. Note: privilege drop happens early (before listeners); low-port binds require either root (with PUID_NO_DROP), capabilities, high ports in config, or external setuid wrapper.
See docker-compose.yml for full example (exposes 80/81/443, volume for data/). See docker-compose.yml for full example (listens on 80/81/443 via env, publishes 80/443, volume for data/).
## Paths (all overridable) ## Paths (all overridable)
- `data/db.bolt` (or `DATA_DIR`) - `data/db.bolt` (or `DATA_DIR`)
+12 -8
View File
@@ -12,14 +12,18 @@ services:
- ./data:/app/data - ./data:/app/data
# user: "0:0" # required when using PUID/PGID != built-in to allow binary to chown+drop # user: "0:0" # required when using PUID/PGID != built-in to allow binary to chown+drop
# working_dir: /app # binary uses CWD for relative data/ + data/www/ # working_dir: /app # binary uses CWD for relative data/ + data/www/
# environment: environment:
# - JWT_SECRET= # optional; otherwise a random secret is stored in data/.jwt_secret - ADMIN_PORT=81
# - DATA_DIR=/app/data - PROXY_HTTP_PORT=80
# - WWW_DIR=/app/data/www - PROXY_HTTPS_PORT=443
# - PUID=1000 # ADMIN_HOST defaults to 127.0.0.1 (healthcheck hits 127.0.0.1:81)
# - PGID=1000 # - JWT_SECRET= # optional; otherwise a random secret is stored in data/.jwt_secret
# - DISABLE_IPV6=1 # - DATA_DIR=/app/data
# # PUID_NO_DROP=1 # if using low ports (80/443) + PUID: chown as root but skip drop (stay root for bind; default drop runs as PUID after, requires high ports or NET_BIND_SERVICE cap) # - WWW_DIR=/app/data/www
# - PUID=1000
# - PGID=1000
# - DISABLE_IPV6=1
# # PUID_NO_DROP=1 # if using low ports (80/443) + PUID: chown as root but skip drop (stay root for bind; default drop runs as PUID after, requires high ports or NET_BIND_SERVICE cap)
# To use optional SQL backend instead of default yaml: # To use optional SQL backend instead of default yaml:
# - DB_TYPE=postgres # - DB_TYPE=postgres
# - DB_POSTGRES_HOST=db # - DB_POSTGRES_HOST=db