diff --git a/docs/content/docs/guides/MIGRATION-GUIDE.md b/docs/content/docs/guides/MIGRATION-GUIDE.md index f5d50fe..1a6e211 100644 --- a/docs/content/docs/guides/MIGRATION-GUIDE.md +++ b/docs/content/docs/guides/MIGRATION-GUIDE.md @@ -23,15 +23,28 @@ For a shorter overview, see the [Survival Guide](SURVIVAL-GUIDE.md). For safety Choose the option that fits your setup. -### Binary (go install) +### Download a pre-built binary (no Go required) + +Download the latest release for your platform from the +[GitHub releases page](https://github.com/gesellix/Bose-SoundTouch/releases). +Unzip, make executable, and run: ```bash -go install github.com/gesellix/bose-soundtouch/cmd/soundtouch-service@latest -soundtouch-service +# Linux / macOS example +chmod +x soundtouch-service +./soundtouch-service ``` The service starts on port 8000. Open `http://localhost:8000` in your browser. +### Install script (Raspberry Pi or on-device) + +A one-line installer handles download, installation as a system service, and +auto-start on boot. See the +[On-Device Install Walkthrough](ON-DEVICE-INSTALL-WALKTHROUGH.md) and +[External Host Walkthrough](EXTERNAL-HOST-WALKTHROUGH.md) for the exact +commands for each platform. + ### Docker Compose (recommended for home servers and VMs) The repository ships a `docker-compose.yml` ready for this use case. Clone or download it, copy the example config, then edit `.env` before starting: @@ -76,8 +89,17 @@ docker run -d \ On macOS/Windows, device discovery via mDNS won't work inside the container — you'll add devices by IP address in Step 4. +### go install (if you have Go installed) + +```bash +go install github.com/gesellix/bose-soundtouch/cmd/soundtouch-service@latest +soundtouch-service +``` + See [Raspberry Pi Setup](RASPBERRY-PI.md) and the [SoundTouch Service Guide](SOUNDTOUCH-SERVICE.md) for more deployment options. +> **Data directory**: all methods store device state, presets, and settings in a `data/` directory next to the binary (or mounted at `/app/data` in Docker). This directory is the single thing you need to back up — copying it is enough to restore a complete AfterTouch installation on a new machine. + --- ## Step 2: Configure the service URL diff --git a/docs/content/docs/guides/SOUNDTOUCH-SERVICE.md b/docs/content/docs/guides/SOUNDTOUCH-SERVICE.md index 28c7166..f8c0ef6 100644 --- a/docs/content/docs/guides/SOUNDTOUCH-SERVICE.md +++ b/docs/content/docs/guides/SOUNDTOUCH-SERVICE.md @@ -28,10 +28,13 @@ The service consists of several key components: ### BMX Services (Bose Media eXchange) - **TuneIn Integration**: Direct playback of radio stations and podcasts +- **RadioBrowser Integration**: Open community radio directory alongside TuneIn - **Custom Streams**: Flexible playback of any internet radio URL via dynamic proxy - **Service Registry**: Media service discovery and configuration - **Playback Control**: Stream URL resolution and audio metadata +![soundtouch-web TuneIn search — browsing smooth jazz stations](/images/soundtouch-web-tunein.png) + ### Marge Services (Account & Device Management) - **Account Management**: User account simulation and device association - **Preset Synchronization**: Cross-device preset storage and sync diff --git a/docs/static/images/soundtouch-web-tunein.png b/docs/static/images/soundtouch-web-tunein.png new file mode 100644 index 0000000..6a58cf7 Binary files /dev/null and b/docs/static/images/soundtouch-web-tunein.png differ