From 6e97b74f2a02aaaa5636ad6e85851c4e4099e5b0 Mon Sep 17 00:00:00 2001 From: rednakse Date: Thu, 2 Apr 2026 04:48:09 +0300 Subject: [PATCH] Template Docker compose config --- .gitignore | 2 ++ README.md | 3 ++- compose.yaml => compose.example.yml | 0 docs/PLAN.md | 1 + docs/PROJECT_INDEX.md | 2 +- 5 files changed, 6 insertions(+), 2 deletions(-) rename compose.yaml => compose.example.yml (100%) diff --git a/.gitignore b/.gitignore index 8762013..ce2a852 100644 --- a/.gitignore +++ b/.gitignore @@ -27,3 +27,5 @@ dist-ssr runtime/* !runtime/.gitkeep + +compose.yml diff --git a/README.md b/README.md index b394c30..d2ce5f7 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ Default panel credentials: - login: `admin` - password: `proxy-ui-demo` -For Docker runs these values come from `compose.yaml`: +For Docker runs these values come from your local `compose.yml`, usually created from `compose.example.yml`: - `PANEL_AUTH_LOGIN` - `PANEL_AUTH_PASSWORD` @@ -44,6 +44,7 @@ Once the API is available, dashboard/user traffic values are refreshed from live ## Docker run ```bash +cp compose.example.yml compose.yml docker compose up --build ``` diff --git a/compose.yaml b/compose.example.yml similarity index 100% rename from compose.yaml rename to compose.example.yml diff --git a/docs/PLAN.md b/docs/PLAN.md index a584ea9..ff11e9c 100644 --- a/docs/PLAN.md +++ b/docs/PLAN.md @@ -48,3 +48,4 @@ Updated: 2026-04-02 31. Moved proxy-copy into the Users actions column, added a last-seen/online column from parsed 3proxy logs, and introduced bounded websocket/API reconnect attempts with a visible connection banner and forced logout after full recovery failure. 32. Restored proxy-link copying for plain-`http` deployments by falling back from the Clipboard API to `execCommand('copy')`, and added regression coverage for both clipboard paths. 33. Replaced stale startup mock values with explicit skeleton loading states so the shell no longer flashes fallback dashboard/users/settings data before the first live snapshot arrives. +34. Renamed the tracked Docker Compose file to `compose.example.yml` and ignored local `compose.yml` so production-specific compose settings no longer get overwritten by pulls. diff --git a/docs/PROJECT_INDEX.md b/docs/PROJECT_INDEX.md index 6cc539a..d623745 100644 --- a/docs/PROJECT_INDEX.md +++ b/docs/PROJECT_INDEX.md @@ -7,7 +7,7 @@ Updated: 2026-04-02 - `000_START_HERE.md`: copy-ready continuation prompt for the next agent session - `.dockerignore`: trims Docker build context to runtime-relevant files only - `AGENTS.md`: repository workflow rules for autonomous contributors -- `compose.yaml`: Docker Compose entrypoint for the bundled panel + 3proxy runtime, including panel auth env defaults +- `compose.example.yml`: tracked Docker Compose template for the bundled panel + 3proxy runtime; copy it to local `compose.yml` before production edits - `Dockerfile`: multi-stage image that builds the panel and compiles 3proxy - `README.md`: quick start and current project scope - `package.json`: frontend/backend scripts and dependencies, including combined local `dev` startup and websocket support