Skip to content

navidrome

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History
 
 

navidrome

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
README.md
README.md
 
 
docker-compose.yml
docker-compose.yml
 
 

README.md

Navidrome

Navidrome Logo

Website • Documentation • GitHub • Discord

Navidrome is a modern, open-source music server and streamer. Compatible with Subsonic/Airsonic clients, it lets you enjoy your music collection from anywhere.

Features

  • Subsonic API Compatible — Works with dozens of mobile apps
  • Modern Web UI — Beautiful, responsive interface
  • Fast & Lightweight — Handles large collections efficiently
  • Multi-User — Each user gets their own playlists and favorites
  • On-the-Fly Transcoding — Stream in any format/bitrate
  • Smart Playlists — Auto-generated playlists based on criteria
  • Last.fm Scrobbling — Track your listening history

Prerequisites

  • Docker and Docker Compose
  • External Docker network
  • Reverse proxy (Caddy, Nginx, Traefik)
  • Music library accessible to the container

Quick Start

1. Prepare Music Directory

Ensure your music directory exists and is organized:

/path/to/your/music/
├── Artist 1/
│   ├── Album 1/
│   └── Album 2/
└── Artist 2/
    └── Album 1/

2. Update Docker Compose

Edit docker-compose.yml:

  • Replace your-network with your Docker network name
  • Update /path/to/your/music/folder to your music directory

3. Deploy

docker compose up -d

4. Initial Setup

  1. Access Navidrome at http://your-server:4533
  2. Create an admin account on first login
  3. Wait for the initial music scan to complete

Configuration

Environment Variables

Uncomment and configure in docker-compose.yml:

Variable Description Default
ND_SCANSCHEDULE Music scan schedule 1h
ND_LOGLEVEL Log verbosity info
ND_SESSIONTIMEOUT Session timeout 24h
ND_BASEURL Base URL if using subpath /
ND_ENABLETRANSCODINGCONFIG Allow transcoding config true

Reverse Proxy (Caddy)

music.example.com {
    reverse_proxy http://localhost:4533
}

Ports

Port Service Description
4533 HTTP Web interface

Data Persistence

Path Description
./data Navidrome database and cache
/music Music library (read-only)

Compatible Apps

Navidrome works with Subsonic-compatible apps:

  • Android: DSub, Ultrasonic, Symfonium
  • iOS: play:Sub, Amperfy, SubStreamer
  • Desktop: Sublime Music, Sonixd
  • Web: Built-in web player

File Permissions

The container runs as user 1000:1000. Ensure your music folder is readable:

# Check current ownership
ls -la /path/to/your/music

# If needed, adjust permissions
chmod -R 755 /path/to/your/music

Support the Project

License

Navidrome is released under the GPL-3.0 License.