github/Bose-SoundTouch
1
0
Fork 0
mirror of https://github.com/gesellix/Bose-SoundTouch.git synced 2026-08-19 00:56:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix(docs,service): persist the Docker data dir at /app/data + warn when empty (refs #517)

Browse Source 
The walkthrough mounted the volume at /data, but the image's DATA_DIR is
/app/data, so the documented docker run never actually persisted the
datastore, settings or CA; a recreated container silently lost all state.
Correct the mount path, document what lives under /app/data and the cost
of losing it, and add a Windows/macOS Docker Desktop note (host
networking is Linux-only; publish ports; DNS interception needs :53/:443).
The service also logs a clear notice on startup when the data dir looks
empty.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
Tobias Gesellchen
2026-06-27 19:58:19 +02:00
co-authored by Claude Opus 4.8
parent 18f3eabd67
commit 462b4179f1
2 changed files with 22 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
cmd/soundtouch-service/main.go
+6
View File
@@ -485,6 +485,12 @@ func main() {
if persisted.ServerURL == "" {
log.Printf("Creating default settings.json in %s", sanitizeLog(config.dataDir))
log.Printf("Data directory %s looks empty (first run). If you did NOT expect this "+
"(e.g. after recreating a Docker container), your previous settings, datastore and "+
"CA were not persisted; mount a persistent volume at the data dir (Docker: "+
"-v <volume>:/app/data) so device state and the CA survive restarts. A lost CA "+
"forces re-migrating speakers and re-trusting the new CA.",
sanitizeLog(config.dataDir))
persisted = createDefaultSettings(ds, config)
}
docs/content/docs/guides/EXTERNAL-HOST-WALKTHROUGH.md
+16 -1
View File
@@ -66,13 +66,28 @@ docker run -d \
--name aftertouch \
--network host \
-e SERVER_URL=http://192.0.2.10:8000 \
-v aftertouch-data:/data \
-v aftertouch-data:/app/data \
ghcr.io/gesellix/bose-soundtouch:latest
```
Replace `192.0.2.10` with the host machine's LAN IP. The `--network host` flag
is required so AfterTouch can reach the speakers and respond to mDNS discovery.
> **Persist the data directory.** The container stores everything stateful under
> `/app/data` (`DATA_DIR`): the datastore, `settings.json`, and the service CA.
> Mount a volume there (`-v <volume>:/app/data`, as above) or this state is lost
> when the container is recreated. Losing the CA forces you to re-migrate every
> speaker and re-trust the new CA, so back this volume up before upgrading.
> **Windows / macOS (Docker Desktop):** `--network host` does not work the same
> way as on Linux, so publish the ports explicitly instead, e.g.
> `-p 8000:8000 -p 8443:8443`. mDNS discovery across the Docker Desktop network
> boundary is unreliable; add speakers by IP in the Devices tab. If you also use
> DNS interception (so the speaker resolves Bose hostnames to AfterTouch), you
> additionally need to publish the DNS port (`-p 53:53/udp -p 53:53/tcp`) and
> make AfterTouch reachable on `:443` (the hardcoded Bose hosts are plain HTTPS),
> e.g. `-p 443:8443`. Keep the same `-v <volume>:/app/data` mount.
---
## Step 2 — Note your host's LAN IP and open the Admin UI