mirror of
https://github.com/gesellix/Bose-SoundTouch.git
synced 2026-08-09 20:26:13 +00:00
Completes the docs-tier RFC-5737 rollout by sweeping the remaining
192.168.1.x references that lived outside .md / .txt / test files:
- .env.example — active PREFERRED_DEVICES default + examples
- .github/ISSUE_TEMPLATE/*.yml + workflows — issue template + CI examples
- cmd/websocket-demo/main.go, doc.go — top-level docs
- examples/*/main.go (7 files) — example program comments
- pkg/client/client.go — godoc examples
- pkg/models/doc.go — package godoc
- pkg/service/{amazon,spotify,zeroconf}/zeroconf.go — godoc comments
- pkg/service/handlers/web/index.html — placeholder text in the UI
- scripts/prepare-release.sh — example invocations
- scripts/spotify/spotify-prime-speaker.sh — usage comment
- tests/integration/http-client/http-client.env.json — fixture IPs
Same mapping as the docs commit (136d24a): 192.168.1.X → 192.0.2.X
preserving the last octet.
One semantic carve-out: the three zeroconf `zcBaseURL` godoc comments
in pkg/service/{amazon,spotify,zeroconf}/zeroconf.go switched to
192.168.10.10 instead of the doc range, because validateZcBaseURL
only accepts RFC-1918 / loopback / link-local. The comment must show
a value the validator actually accepts — see the matching test fix
in 92f66a2 for the same reason.
go build ./... clean. go test ./... clean except the pre-existing
TestDocsConsistency (untracked DEVICE-LOCAL-INSTALL.md, unrelated).
golangci-lint run ./... — 0 issues after a gofmt fix on
examples/zone-slave-operations/main.go.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
80 lines
2.9 KiB
Bash
80 lines
2.9 KiB
Bash
# Bose SoundTouch Configuration
|
|
# Copy this file to .env and customize for your setup
|
|
|
|
# Docker/Service Settings
|
|
SOUNDTOUCH_HOSTNAME=soundtouch.local
|
|
SOUNDTOUCH_VERSION=latest
|
|
|
|
# Stockholm frontend (used by make prepare-stockholm and by the Go service at startup)
|
|
# BACKEND_URL is the base URL your speakers and browser can reach the service at.
|
|
# Corresponds to SERVER_URL in the Go service.
|
|
# BACKEND_URL=http://soundtouch.local:8000
|
|
#
|
|
# STREAMING_URL is used for streaming.bose.com rewrites (defaults to BACKEND_URL).
|
|
# Set to $(BACKEND_URL)/marge only when routing through a soundcork backend.
|
|
# STREAMING_URL=http://soundtouch.local:8000
|
|
#
|
|
# AUTH_SERVICE_URL is written into config.json as the auth endpoint (defaults to BACKEND_URL).
|
|
# A trailing slash is added automatically; the JS appends paths like "oauth/account/..." directly.
|
|
# AUTH_SERVICE_URL=http://soundtouch.local:8000
|
|
#
|
|
# STOCKHOLM_BASE_PATH mounts the Stockholm UI under a URL prefix, freeing / for the management UI.
|
|
# The bridge API (/api/native/*, /api/http-proxy) remains at root regardless of this setting.
|
|
# Defaults to /stockholm. Set to empty to serve at root.
|
|
# STOCKHOLM_BASE_PATH=/stockholm
|
|
|
|
# Discovery Settings
|
|
DISCOVERY_TIMEOUT=5s
|
|
UPNP_ENABLED=true
|
|
|
|
# HTTP Client Settings
|
|
HTTP_TIMEOUT=10s
|
|
USER_AGENT="Bose-SoundTouch-Go-Client/1.0"
|
|
|
|
# Cache Settings
|
|
CACHE_ENABLED=true
|
|
CACHE_TTL=30s
|
|
|
|
# Preferred Devices Configuration
|
|
# Format: name@host:port;name@host:port;...
|
|
# - name is optional (will default to "SoundTouch-{host}")
|
|
# - port is optional (will default to 8090)
|
|
# - Multiple devices are separated by semicolons
|
|
|
|
# Examples:
|
|
# Single device with default port:
|
|
# PREFERRED_DEVICES="192.0.2.100"
|
|
|
|
# Single device with custom name:
|
|
# PREFERRED_DEVICES="Living Room@192.0.2.100"
|
|
|
|
# Single device with custom port:
|
|
# PREFERRED_DEVICES="192.0.2.100:8091"
|
|
|
|
# Multiple devices with mixed configurations:
|
|
PREFERRED_DEVICES="Living Room@192.0.2.100:8090;Kitchen@192.0.2.101;192.0.2.102:8091"
|
|
|
|
# Example — replace with your speakers' names and IPs:
|
|
# PREFERRED_DEVICES="Living Room SoundTouch@192.0.2.10;Kitchen SoundTouch@192.0.2.11"
|
|
|
|
# Alternative format examples:
|
|
# PREFERRED_DEVICES="192.0.2.10;192.0.2.11"
|
|
# PREFERRED_DEVICES="SoundTouch 10@192.0.2.10;SoundTouch 20@192.0.2.11"
|
|
|
|
# Spotify Integration
|
|
# Create an app at https://developer.spotify.com/dashboard
|
|
# SPOTIFY_CLIENT_ID=your_client_id
|
|
# SPOTIFY_CLIENT_SECRET=your_client_secret
|
|
# Auth confirmation url using GET, works in browsers
|
|
# SPOTIFY_REDIRECT_URI=https://your-server.example.com/mgmt/spotify/callback
|
|
# Auth confirmation url using POST, works with the ueberboese-app (https://github.com/julius-d/ueberboese-app)
|
|
# SPOTIFY_REDIRECT_URI=https://your-server.example.com/mgmt/spotify/confirm
|
|
|
|
# Management API Authentication
|
|
# Protects /mgmt/* endpoints (Spotify token access, account management)
|
|
MGMT_USERNAME=admin
|
|
MGMT_PASSWORD=change_me!
|
|
|
|
# External base URL (required when behind a reverse proxy for OAuth callbacks)
|
|
# BASE_URL=https://your-server.example.com
|