docs: Finish README conflict resolution for promote
Keep master ADMIN_PASSWORD / binary defaults; adopt develop compose port align (ADMIN_PORT=81, admin unpublished by default).
This commit is contained in:
@@ -12,7 +12,6 @@ A pure-Go reverse proxy with embedded web UI. Supports proxy hosts, TCP/UDP stre
|
|||||||
## Quick start (binary)
|
## Quick start (binary)
|
||||||
```bash
|
```bash
|
||||||
make # builds UI (placeholder) + Go binary with embed
|
make # builds UI (placeholder) + Go binary with embed
|
||||||
<<<<<<< HEAD
|
|
||||||
ADMIN_PASSWORD='choose-a-real-password' ./helix-proxy
|
ADMIN_PASSWORD='choose-a-real-password' ./helix-proxy
|
||||||
# Defaults (overridable via env):
|
# Defaults (overridable via env):
|
||||||
# Admin UI + API: 127.0.0.1:8081 (ADMIN_HOST / ADMIN_PORT)
|
# Admin UI + API: 127.0.0.1:8081 (ADMIN_HOST / ADMIN_PORT)
|
||||||
@@ -21,14 +20,6 @@ ADMIN_PASSWORD='choose-a-real-password' ./helix-proxy
|
|||||||
```
|
```
|
||||||
|
|
||||||
Visit http://127.0.0.1:8081
|
Visit http://127.0.0.1:8081
|
||||||
=======
|
|
||||||
./helix-proxy
|
|
||||||
# Admin UI + API on 127.0.0.1:8081
|
|
||||||
# Proxy HTTP on :8080, HTTPS on :18443
|
|
||||||
```
|
|
||||||
|
|
||||||
Visit http://localhost:8081
|
|
||||||
>>>>>>> origin/develop
|
|
||||||
|
|
||||||
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.
|
||||||
|
|
||||||
@@ -39,21 +30,12 @@ docker compose up -d
|
|||||||
# proxy :80/:443 published; admin binds 127.0.0.1:81 (not published by default)
|
# 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 .
|
||||||
<<<<<<< HEAD
|
|
||||||
docker run --env ADMIN_PASSWORD='choose-a-real-password' \
|
|
||||||
-e ADMIN_PORT=81 -e ADMIN_HOST=0.0.0.0 -e PROXY_HTTP_PORT=80 -e PROXY_HTTPS_PORT=443 \
|
|
||||||
-p 80:80 -p 81:81 -p 443:443 -v $PWD/data:/app/data --workdir /app helix-proxy:dev
|
|
||||||
```
|
|
||||||
|
|
||||||
Without those env overrides the binary still defaults to admin `127.0.0.1:8081` and proxy `:8080` / `:18443` inside the container.
|
|
||||||
=======
|
|
||||||
docker run -p 80:80 -p 443:443 \
|
docker run -p 80:80 -p 443:443 \
|
||||||
-e ADMIN_PORT=81 -e PROXY_HTTP_PORT=80 -e PROXY_HTTPS_PORT=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
|
-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.
|
Publishing admin (`-p 81:81`) also needs `-e ADMIN_HOST=0.0.0.0`. Do not publish :81 on untrusted networks.
|
||||||
>>>>>>> origin/develop
|
|
||||||
|
|
||||||
PUID/PGID + DISABLE_IPV6 example (see docker-compose.yml for full):
|
PUID/PGID + DISABLE_IPV6 example (see docker-compose.yml for full):
|
||||||
```yaml
|
```yaml
|
||||||
@@ -67,11 +49,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.
|
||||||
|
|
||||||
<<<<<<< HEAD
|
See docker-compose.yml for a full example (ADMIN_PORT=81 / proxy 80/443 via env; publishes 80/443; admin stays on loopback unless you set `ADMIN_HOST` / publish the admin port).
|
||||||
See docker-compose.yml for a full example (publishes 80/443; admin stays on loopback unless you set `ADMIN_HOST` / publish the admin port).
|
|
||||||
=======
|
|
||||||
See docker-compose.yml for full example (listens on 80/81/443 via env, publishes 80/443, volume for data/).
|
|
||||||
>>>>>>> origin/develop
|
|
||||||
|
|
||||||
## Paths (all overridable)
|
## Paths (all overridable)
|
||||||
- `data/db.bolt` (or `DATA_DIR`)
|
- `data/db.bolt` (or `DATA_DIR`)
|
||||||
|
|||||||
Reference in New Issue
Block a user