From a5fd752b78772a86f51885122dbbb404197b86c6 Mon Sep 17 00:00:00 2001 From: Lorenzo Argentieri Date: Thu, 28 May 2026 10:25:50 +0200 Subject: [PATCH] fix(casaos): rename to docker-compose.yml so CasaOS recognizes the app CasaOS's compose watcher only picks up the standard docker-compose.yml / docker-compose.yaml names; a custom filename made it treat the app as an uncontrolled container and (in some cache states) skip the x-casaos metadata. Renaming aligns with every other CasaOS-managed app. Co-Authored-By: Claude Opus 4.7 (1M context) --- README.md | 4 ++-- ...r-compose.casaos.yml => docker-compose.yml | 0 docs/DOCKER-CASAOS.md | 20 +++++++++---------- 3 files changed, 12 insertions(+), 12 deletions(-) rename docker-compose.casaos.yml => docker-compose.yml (100%) diff --git a/README.md b/README.md index 49f4a2d9..f0b53d43 100644 --- a/README.md +++ b/README.md @@ -80,7 +80,7 @@ docker pull ruvnet/wifi-densepose:latest docker run -p 3000:3000 ruvnet/wifi-densepose:latest # Open http://localhost:3000 # CasaOS / docker compose? See docs/DOCKER-CASAOS.md (ready-made -# docker-compose.casaos.yml with an app tile) +# docker-compose.yml with an app tile) # Option 2: Live sensing with ESP32-S3 hardware ($9) # Flash firmware, provision WiFi, and start sensing: @@ -563,7 +563,7 @@ Verify the plugin structure: `bash plugins/ruview/scripts/smoke.sh`. Full detail | Document | Description | |----------|-------------| | [User Guide](docs/user-guide.md) | Step-by-step guide: installation, first run, API usage, hardware setup, training | -| [Docker & CasaOS](docs/DOCKER-CASAOS.md) | Run the sensing server via Docker / `docker-compose.casaos.yml`, import as a CasaOS app tile, and connect ESP32-S3 nodes | +| [Docker & CasaOS](docs/DOCKER-CASAOS.md) | Run the sensing server via Docker / `docker-compose.yml`, import as a CasaOS app tile, and connect ESP32-S3 nodes | | [Build Guide](docs/build-guide.md) | Building from source (Rust and Python) | | [Claude Code / Codex Plugin](plugins/ruview/README.md) | The `ruview` plugin + marketplace — skills, `/ruview-*` commands, agents, and the Codex prompt mirror | | [Architecture Decisions](docs/adr/README.md) | 96 ADRs — why each technical choice was made, organized by domain (hardware, signal processing, ML, platform, infrastructure) | diff --git a/docker-compose.casaos.yml b/docker-compose.yml similarity index 100% rename from docker-compose.casaos.yml rename to docker-compose.yml diff --git a/docs/DOCKER-CASAOS.md b/docs/DOCKER-CASAOS.md index cd30eb2b..dde6b1fa 100644 --- a/docs/DOCKER-CASAOS.md +++ b/docs/DOCKER-CASAOS.md @@ -18,7 +18,7 @@ host does **not** need to compile the Rust workspace. ```bash cd ruview -CSI_SOURCE=simulated docker compose -f docker-compose.casaos.yml up -d +CSI_SOURCE=simulated docker compose -f docker-compose.yml up -d ``` Then open the dashboard: @@ -38,14 +38,14 @@ the dashboard, API, and vital-sign/pose visualizations without any hardware. Stop / remove: ```bash -docker compose -f docker-compose.casaos.yml down +docker compose -f docker-compose.yml down ``` --- ## 2. Ports -The compose file (`docker-compose.casaos.yml`) publishes these host ports: +The compose file (`docker-compose.yml`) publishes these host ports: | Service | Container | Host | Notes | |------------------------|-----------|------|-------| @@ -54,7 +54,7 @@ The compose file (`docker-compose.casaos.yml`) publishes these host ports: | ESP32 CSI ingest | 5005/udp | **5005** | ESP32-S3 nodes stream CSI frames here | If a host port clashes on your machine, edit the `published:` values in -`docker-compose.casaos.yml` (and update `port_map` / `webui_port` in the +`docker-compose.yml` (and update `port_map` / `webui_port` in the `x-casaos` block to match the new UI port). The dashboard's WebSocket URL is derived from the page host, so keep the API and WS ports reachable from the same hostname. @@ -96,7 +96,7 @@ Leave `RUVIEW_API_TOKEN` empty for LAN-only use. Set it to require `Authorization: Bearer ` on `/api/v1/*`: ```bash -RUVIEW_API_TOKEN=$(openssl rand -hex 32) docker compose -f docker-compose.casaos.yml up -d +RUVIEW_API_TOKEN=$(openssl rand -hex 32) docker compose -f docker-compose.yml up -d ``` --- @@ -111,14 +111,14 @@ description, port map), so CasaOS shows it as a proper app tile. 1. CasaOS dashboard → **App Store** → **Custom Install** (the `+` / "Install a customized app"). 2. Switch to the **Import** / YAML view and paste the contents of - `docker-compose.casaos.yml`. + `docker-compose.yml`. 3. Install. The tile opens `http://:3000/ui/index.html`. **Option B — CLI (CasaOS still detects the container)** ```bash cd ruview -docker compose -f docker-compose.casaos.yml up -d +docker compose -f docker-compose.yml up -d ``` > **Icon:** the manifest points at @@ -157,8 +157,8 @@ detection, pose) needs **Channel State Information** from a CSI-capable node. docker logs ruview -f --tail 100 # Restart / update to the latest image -docker compose -f docker-compose.casaos.yml pull -docker compose -f docker-compose.casaos.yml up -d +docker compose -f docker-compose.yml pull +docker compose -f docker-compose.yml up -d # Status of the running server curl -s http://:3000/api/v1/status @@ -171,4 +171,4 @@ curl -s http://:3000/api/v1/status - *Multiple ESP32 nodes on Docker Desktop for Windows:* multi-source UDP collapses to one source IP at the WSL boundary. Use the host relay (see `docs/TROUBLESHOOTING.md §9`). Native Linux/CasaOS hosts are unaffected. -- *Port clash on 3000/3001:* edit `published:` in `docker-compose.casaos.yml`. +- *Port clash on 3000/3001:* edit `published:` in `docker-compose.yml`.