Tobias GesellchenandClaude Opus 4.7
064fe80e18
Bundles the install-time hygiene work for issues #268 and #250. # Install location — #268 Stock SoundTouch rootfs has only a few MB free (~4 MB on the ST20 the reporter captured); the AfterTouch binary is ~12 MB. The previous flow downloaded into tmpfs (/media/aftertouch) and then `mv`'d the binary into /opt/aftertouch on rootfs — which fails with "No space left on device" on any speaker with the standard layout. install.sh now installs to /mnt/nv/aftertouch by default (the persistent partition, ~30 MB free on the same captures) and points /opt/aftertouch at it via a symlink so the init script's hardcoded DAEMON path keeps working unchanged. Power users can override with INSTALL_DIR=/some/other/path. The interactive prompt from the community patch in #268's thread is dropped — STDIN is the curl pipe under the documented `curl | sh` invocation, so a read prompt would hang or read garbage. uninstall.sh is updated to resolve the symlink and remove the target before unlinking, so the 12 MB binary doesn't get orphaned on /mnt/nv when users uninstall. # Logging — #250 Issue #250 surfaced a "running but unreachable" state: the install script reported AfterTouch as running, the init script's status agreed, but `curl :8000` returned connection-refused. start-stop- daemon's --background detaches stdout/stderr, so any panic the daemon emitted before dying went to /dev/null with no diagnostic trail. The fix is to route the daemon's stdout/stderr through `logger -t aftertouch` so output lands in BusyBox syslog — a bounded in-memory ring buffer that never grows on disk (writing to a file in /mnt/nv would have eaten the volume over months). Diagnostic flow is now: logread | grep aftertouch | tail -20 logread -f | grep aftertouch # live tail Matches the recipe already documented in TROUBLESHOOTING.md for the speaker's own logs (Curl 7 section). Tightening on top of the syslog change: - The init script's `status` case now also curls localhost:8000 when the PID is alive — distinguishes "PID alive, listener up" from "PID alive, listener silently died" (which is what fooled everyone on #250). A bare PID-liveness check returned "running" in both cases. - install.sh's post-install verification now does its own 10s curl probe after the init script returns; on failure it tails the aftertouch syslog so the user sees the actual error rather than the install script claiming success. - `exec` is added inside the start-stop-daemon's shell wrapper so --make-pidfile records the daemon's own PID (not the shell's), which keeps `stop` semantics correct. README updated to document the install location, INSTALL_DIR override, and the syslog tag. No automated tests — these are shell scripts the install pipeline runs once on the device. All three scripts pass `bash -n` / `sh -n` syntax checks. Real validation is end-user retest, gated on the next release. Refs #268, refs #250. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Bose SoundTouch Toolkit
Independent project. Not affiliated with or endorsed by Bose Corporation.
Context: Cloud Shutdown
Bose is shutting down SoundTouch cloud services on May 6, 2026. After that, music service browsing, preset sync, and the official SoundTouch app stop working. This toolkit lets you keep your speakers fully functional.
See the Survival Guide for the full picture.
Tools
soundtouch-service — AfterTouch
A local server that replaces the Bose cloud ("AfterTouch"). Once your speaker is redirected to it, you have full control without any Bose cloud dependency. The built-in web UI at http://localhost:8000 handles all setup — no config files needed to get started.
If you want to run a server for this - no problem. The service is small enough to run on the SoundTouch itself. See the On-Device Installer for instructions.
Two scenarios:
Before shutdown — migrate your existing setup
While the Bose cloud is still running, use soundtouch-backup to save your account data. The local service web UI then helps with the migration so your speaker keeps its presets and credentials.
After shutdown or factory reset — start fresh Create a local account, configure your speakers, and start using them immediately. No Bose infrastructure required.
Redirecting your speaker
The service needs a stable address on your local network (e.g. soundtouch.fritz.box or soundtouch.local). The speaker must then be redirected to resolve the Bose cloud hostnames to that address. Two supported methods:
| Method | How it works | Notes |
|---|---|---|
| XML redirect | Upload a config XML via the Web API | Surgical; covers only registered endpoints; best for testing |
| DNS/DHCP | Serve custom DNS on your network | Covers all devices at once; requires port 53 and TLS |
The web UI walks you through each method. DNS redirect requires HTTPS — the service manages its own CA certificate and the web UI guides you through trusting it on each speaker.
Note: A hosts-file method (direct SSH edits to
/etc/hosts) also exists in the codebase but is deprecated and not exposed in the web UI.
Enabling SSH via USB stick
Some setup steps require SSH access to the speaker. Enable it once per device: create a file named remote_services on a FAT-formatted USB drive (the drive may need its bootable flag set — see SoundCork issue #172), and insert it while the speaker is powered on. After reboot, root SSH is available with no password.
See Device Initial Setup and Migration Guide for step-by-step instructions.
soundtouch-backup
Backs up your Bose cloud account (presets, paired devices, music sources) and each speaker's local state before the shutdown. Run soundtouch-backup all to capture everything in one step; it authenticates with the Bose cloud, then polls each paired speaker over the local network.
See the soundtouch-backup README for usage.
soundtouch-cli
Command-line control of any SoundTouch device: play/pause/volume, presets, source selection, multiroom zones, device discovery, and more. Works entirely over the local network — no cloud dependency. Well-suited for scripting and home automation.
See the CLI Reference for full usage.
soundtouch-web
A standalone web UI for device control — play, pause, volume, preset selection, real-time status — served from a local Go binary. Complements soundtouch-service when you want a dedicated device-control interface separate from the setup/admin UI.
See the soundtouch-web README for usage.
Go library
pkg/client provides a Go API for all SoundTouch device endpoints: media control, volume, presets, sources, zones, real-time WebSocket events, and device discovery. Use it to build your own integrations.
go get github.com/gesellix/bose-soundtouch
See the API Reference and pkg.go.dev for documentation.
Documentation
- Getting Started
- Survival Guide
- Migration Guide
- Device Initial Setup
- Migration & Safety Guide
- CLI Reference
- SoundTouch Service Guide
- HTTPS & CA Setup
- API Reference
Related projects
- SoundCork (Deborah Kaplan et al.) — Python service interception; pioneered the cloud emulation approach this project builds on
- SoundCork Stockholm App — Companion app for SoundCork
- SoundTouch Plus (Todd Lucas) — Home Assistant integration; extensive undocumented API documentation
- ÜberBöse API (Julius) — API research and advanced endpoint discovery
- Bose SoundTouch Hook (Adrian Böckenkamp) —
LD_PRELOADhooking for reverse engineering device internals
Support
- Bug reports: GitHub Issues
- Questions & discussions: GitHub Discussions
Star this project ⭐ if you find it useful!
License
MIT — see LICENSE.
SoundTouch is a trademark of Bose Corporation.