init

2026-03-23 23:56:11 +08:00
commit a36a5feb6a
3 changed files with 142 additions and 0 deletions
@@ -0,0 +1,36 @@
+# xboard-node — Docker Compose
+
+## Quick start
+
+```bash
+git clone -b compose --depth 1 https://github.com/cedar2025/xboard-node.git
+cd xboard-node
+# Edit config/config.yml: panel.url, panel.token, panel.node_id
+docker compose up -d
+```
+
+## Update / logs / stop
+
+```bash
+cd compose
+docker compose pull && docker compose up -d
+docker compose logs -f
+docker compose down
+```
+
+## Layout
+
+| Path | Purpose |
+|------|---------|
+| `compose.yml` | Service definition |
+| `config/config.yml.example` | Template (safe to commit) |
+| `config/config.yml` | Your secrets (**do not commit**; add to `.gitignore` upstream) |
+| `.env.example` | Optional env overrides |
+
+## Host network
+
+`network_mode: host` is set so the node uses the host network stack (same as `docker run --network host`). Free the ports your protocols need.
+
+## Image
+
+Default: `ghcr.io/cedar2025/xboard-node:latest`.