mirror of
https://github.com/gesellix/Bose-SoundTouch.git
synced 2026-08-19 00:56:16 +00:00
Adds a "Download diagnostic report" button on the Health tab that
produces an age-encrypted .age file the user can attach to a GitHub
issue without exposing sensitive data.
Archive contents (tar.gz, then age-encrypted with the maintainer's
SSH ed25519 public key):
- diagnostic.json structured health/device summary (no secrets)
- datastore/…/*.xml raw on-disk XML verbatim for diff vs HTTP
- http/service/… live service HTTP responses per account/device
- http/speaker/… live speaker API responses (port 8090)
- ssh/speaker/… CA bundles + logread (last 20 min, 127.0.0.1
filtered) + dmesg fetched via SSH
- system/ca.pem service CA cert
- system/resolv.conf host DNS resolver config
- settings.json service settings (OAuth secrets redacted)
- env.txt filtered process environment
- logs/service.txt in-memory service log buffer
Supporting tooling:
- scripts/setup-diagnostic-key.sh one-time SSH key-pair generation
- scripts/decrypt-diagnostic.go go run helper for maintainer decryption
- keys/public/diagnostic.pub committed public key (matches github.com/gesellix.keys)
- docs/DIAGNOSTIC-EXPORT.md maintainer setup + user workflow guide
- docs/concepts/ENCRYPTED-EXPORT.md research notes and architecture rationale
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
5.2 KiB
5.2 KiB
Table of Contents
User Guides
- Device-Local Install Journeys
- Cloud Shutdown Survival Guide
- Self-Hosting AfterTouch
- Connecting Music Services
- Migration & Safety Guide
- CLI Reference
- Backup Tool
- Getting Started
- SoundTouch Service
- Initial Device Setup
- Capture Device Pairing Traffic
- Capture Migration Traffic
- Device Setup Flow
- MAC Address Mapping
- HTTPS Setup
- Deployment
- Raspberry Pi Guide
- Troubleshooting
- IoT Implementation Guide
- Migration Guide
- MQTT Integration Design
- Useful Links
Useful Links
Technical Reference
- API Cookbook
- API Endpoints
- Spotify Account Addition
- Cloud API Emulation
- System Endpoints
- Speaker Endpoint
- WebSocket Events
- Device Pairing Flow
- Discovery
- Zone Management
- Preset Management
- Source Selection
- Volume Controls
- RadioBrowser
- Bass Controls
- Key Controls
- Feature Mapping
Concepts
- Request Recording
- Spotify Priming Strategy
- Spotify OAuth
- Encrypted Export
- Diagnostic Export (Maintainer Setup)
- soundtouch-web Roadmap
Analysis & Research
- API Coverage Analysis
- Supported URLs
- Upstream URLs
- Anonymization Summary
- Device Redirect Methods
- Telnet (Port 17000) Migration Method
- Telnet Command Reference
- Setup WebSocket Experiment
- Factory Reset Protocol
- Wiki API Comparison
- IoT Config Summary
- IoT Configuration Analysis
- Bose Lab Runbook
- Missing Routes Spotify
- Bose App ADB Emulator
- Community Tools
Parity Analysis
Appendix (Other Documents)
- External Services Abstraction
- API Navigation Reference
- Claude Instructions
- Content Selection Implementation
- Device Customization Setup
- Device Logging
- Feature History
- Host/Port Parsing
- Manual Network Discovery
- Navigation Guide
- Official API Verification
- Preset Quickstart
- Project Patterns
- Service Availability Implementation
- SoundTouch Service Announcement
- Undocumented Community Features
- Unimplemented Endpoints
- Preset Store
- SCMUDC Enrichment Implementation
- Device Lifecycle and Power On Enhancement
- Device Lifecycle Summary
- Power On Implementation Guide
- SCMUDC Events Analysis
- Parity Improvements
- Parity SoundCork
- Stockholm Port Guide