Skip to content

GETTING_STARTED

github-actions[bot] edited this page Jun 24, 2026 · 12 revisions

Getting Started with Multi-Room Audio

Time to first audio: 5 minutes | Difficulty: Beginner

New in 4.0: The setup wizard now guides you through initial configuration automatically. Just install and follow the prompts!


The Problem

You want whole-home audio but:

  • Commercial systems are expensive - Sonos, HEOS, and similar cost $200-500 per room
  • You have unused audio gear - DACs, amplifiers, and speakers sitting idle
  • You want software control - Integration with Music Assistant
  • You need flexibility - Different rooms, different requirements

The Solution

Multi-Room Audio Controller turns any Docker host into a multi-zone audio server:

  1. Connect USB DACs or use built-in audio outputs
  2. Run one container that manages all players
  3. Each player appears as a controllable zone in Music Assistant
  4. Control everything from a web interface
Your Server (NAS, Pi, etc.)
         |
    [Container]
    /    |    \
 DAC1  DAC2  DAC3
   |     |     |
Kitchen Bedroom Patio

Choose Your Path

Your Situation Start Here
I run Docker on a NAS/server/Pi Quick Start (Docker)
I run Home Assistant OS Quick Start (HAOS)

Quick Start (Docker)

Prerequisites

  • Docker installed and running
  • Music Assistant running (for audio control)
  • (Optional) USB DAC connected

Step 1: Deploy the Container

docker run -d \
  --name multiroom-audio \
  -p 8096:8096 \
  --device /dev/snd:/dev/snd \
  -v /proc/asound:/host/asound:ro \
  ghcr.io/chrisuthe/multiroom-audio:latest

Note: The /proc/asound mount enables device capability detection (sample rates, bit depths). It's optional but recommended for the full feature set.

Step 2: Open the Web Interface

Navigate to: http://YOUR-SERVER-IP:8096

First-time users: The Setup Wizard launches automatically to guide you through:

  1. Detecting your audio hardware
  2. Configuring sound card profiles (if applicable)
  3. Creating your first players
  4. Testing audio output

Returning users: You'll see the main dashboard with your existing players.

Step 3: Follow the Setup Wizard (New Installations)

The wizard walks you through configuration:

  1. Welcome: Overview of what you'll set up
  2. Hardware: Review detected audio devices
  3. Configure: Set up sound card profiles for multi-channel devices
  4. Create Players: Name your zones and assign devices
  5. Test: Verify audio plays correctly
  6. Done: Start using your multi-room system

Tip: You can skip the wizard and configure manually, or re-run it anytime from Settings > Run Setup Wizard.

Step 3 (Alternative): Create Players Manually

If you skipped the wizard or need to add more players:

  1. Click "Add Player"
  2. Fill in the form:
    • Name: Test Player (or your room name)
    • Audio Device: Select your device, or null for testing
  3. Click "Create Player"
  4. Click "Start" on your new player

Step 4: Verify It Works

  1. Open Music Assistant
  2. Go to Settings > Players
  3. Your player should appear within 30-60 seconds

Success! What's Next?

  • Add persistent storage so config survives restarts
  • Create more players for each room
  • Check Troubleshooting if something is not working

Advanced: Custom ALSA Configuration

If you have a custom /etc/asound.conf on your host (for virtual devices, dmix, multi-channel routing, etc.), mount it into the container:

docker run -d \
  --name multiroom-audio \
  -p 8096:8096 \
  --device /dev/snd:/dev/snd \
  -v /etc/asound.conf:/etc/asound.conf:ro \
  ghcr.io/chrisuthe/multiroom-audio:latest

Or in Docker Compose:

volumes:
  - ./config:/app/config
  - /etc/asound.conf:/etc/asound.conf:ro
  - /proc/asound:/host/asound:ro  # Optional: enables device capability detection

After restarting the container, your custom ALSA devices will appear in the device selection dropdown.


Quick Start (HAOS)

Prerequisites

  • Home Assistant OS or Supervised installation
  • Music Assistant add-on (recommended)

Step 1: Add the Repository

  1. Go to Settings > Add-ons > Add-on Store
  2. Click the three-dot menu (top right)
  3. Select Repositories
  4. Add: https://github.com/chrisuthe/Multi-SendSpin-Player-Container
  5. Click Add, then Close

Step 2: Install the Add-on

  1. Refresh the add-on store page
  2. Find "Multi-Room Audio Controller"
  3. Click Install
  4. Wait for installation to complete

Step 3: Start and Access

  1. Go to the add-on's Info tab
  2. Click Start
  3. Enable Show in sidebar (optional but recommended)
  4. Click Open Web UI

Step 4: Follow the Setup Wizard

On first launch, the Setup Wizard guides you through:

  1. Hardware detection: See all available audio devices
  2. Sound card configuration: Set up profiles for multi-channel devices
  3. Player creation: Create players for each room/zone
  4. Audio testing: Verify everything works

The wizard makes setup simple - just follow the prompts!

Tip: Re-run the wizard anytime from Settings > Run Setup Wizard when adding new hardware.

Step 4 (Alternative): Manual Setup

If you prefer manual configuration or need to add more players:

  1. Click "Add Player"
  2. Fill in the form:
    • Name: Your room name (e.g., "Kitchen")
    • Audio Device: Select from available devices
  3. Click "Create Player"
  4. Click "Start"

Step 5: Verify in Music Assistant

  1. Open Music Assistant
  2. Go to Settings > Players
  3. Your new player should appear

Success! What's Next?

  • Connect USB DACs for more zones
  • Check Troubleshooting if needed

Common First-Time Issues

"No audio devices found"

Docker: Ensure you passed --device /dev/snd:/dev/snd

HAOS: USB devices appear after add-on restart. Try:

  1. Restart the add-on
  2. Check Settings > System > Hardware for your device

"Player won't start"

  1. Try creating a player with null device first (tests without audio)
  2. Check the player logs in the web interface
  3. Verify Music Assistant is running and reachable

"Player not appearing in Music Assistant"

  1. Wait 30-60 seconds for discovery
  2. Restart Music Assistant
  3. Check both are on the same network

Next Steps

Goal Documentation
See all new features What's New in 4.0
Full HAOS setup HAOS Add-on Guide
Split multi-channel DAC Custom Sinks Guide
Configure sound cards Sound Card Setup
Understand the architecture Architecture
Something not working Troubleshooting

Clone this wiki locally