Navidrome is an open-source music streaming server that lets you browse and listen to your music collection in a web browser. It runs as a lightweight service on a self-managed server and provides features such as library organization, metadata handling, and audio streaming to compatible clients.

This article demonstrates how to deploy Navidrome on a Linux server using Docker Compose. It covers service configuration, storage setup, and initial access to the Navidrome dashboard.

Prerequisites

Before you begin, you need to:

• Have access to a Linux-based server (with at least 2 CPU cores and 4 GB of RAM) as a non-root user with sudo privileges.
• Install Docker and Docker Compose.
• Configure a domain name, such as navidrome.example.com, to point to your server’s public IP address.

Set Up the Directory Structure, Configuration, and Environment Variables

Navidrome needs directories to store application data and music files, along with environment variables that define paths, timezone, and domain settings. This section prepares the directory structure and the .env file used by Docker Compose.

1. Create the project directory and required subdirectories.

   console Copy

   $ mkdir -p ~/navidrome/{data,music}
   

   Explain Code
   • data stores the Navidrome database, cache, and application metadata.
   • music stores your music library files that Navidrome scans and streams.

2. Navigate to the project directory.

   console Copy

   $ cd ~/navidrome
   

   Explain Code

3. Create a .env file to store environment variables.

   console Copy

   $ nano .env
   

   Explain Code

4. Add the following variables.

   ini Copy

   TZ=Asia/Kolkata
   
   ND_MUSICFOLDER=/music
   ND_DATAFOLDER=/data
   ND_LOGLEVEL=info
   ND_PORT=4533
   
   DOMAIN=navidrome.example.com
   EMAIL=admin@example.com
   

   Explain Code

   Replace:

   • Asia/Kolkata with your preferred timezone.
   • navidrome.example.com with your actual domain name pointing to this server.
   • admin@example.com with your email address.

   Save and close the file.

Deploy Navidrome with Docker Compose

The Docker Compose configuration defines two services - Navidrome, which handles music streaming, and Traefik, which acts as a reverse proxy. Traefik terminates HTTPS traffic using a Let's Encrypt certificate and routes incoming requests to Navidrome based on the domain name defined in the .env file.

1. Add your user to the Docker group.

   console Copy

   $ sudo usermod -aG docker $USER
   

   Explain Code

2. Apply the group membership change.

   console Copy

   $ newgrp docker
   

   Explain Code

3. Create a Docker Compose file.

   console Copy

   $ nano docker-compose.yml
   

   Explain Code

4. Add the following configuration.

   yaml Copy

   services:
     traefik:
       image: traefik:v3.6
       container_name: traefik
       restart: unless-stopped
       command:
         - "--providers.docker=true"
         - "--providers.docker.exposedbydefault=false"
         - "--entrypoints.web.address=:80"
         - "--entrypoints.websecure.address=:443"
         - "--entrypoints.web.http.redirections.entrypoint.to=websecure"
         - "--entrypoints.web.http.redirections.entrypoint.scheme=https"
         - "--certificatesresolvers.le.acme.httpchallenge=true"
         - "--certificatesresolvers.le.acme.httpchallenge.entrypoint=web"
         - "--certificatesresolvers.le.acme.email=${EMAIL}"
         - "--certificatesresolvers.le.acme.storage=/letsencrypt/acme.json"
       ports:
         - "80:80"
         - "443:443"
       volumes:
         - /var/run/docker.sock:/var/run/docker.sock:ro
         - traefik_letsencrypt:/letsencrypt
   
     navidrome:
       image: deluan/navidrome:0.60.3
       container_name: navidrome
       restart: unless-stopped
       environment:
         - ND_MUSICFOLDER=${ND_MUSICFOLDER}
         - ND_DATAFOLDER=${ND_DATAFOLDER}
         - ND_LOGLEVEL=${ND_LOGLEVEL}
         - TZ=${TZ}
       volumes:
         - ./music:${ND_MUSICFOLDER}
         - ./data:${ND_DATAFOLDER}
       labels:
         - "traefik.enable=true"
         - "traefik.http.routers.navidrome.rule=Host(`${DOMAIN}`)"
         - "traefik.http.routers.navidrome.entrypoints=websecure"
         - "traefik.http.routers.navidrome.tls=true"
         - "traefik.http.routers.navidrome.tls.certresolver=le"
         - "traefik.http.services.navidrome.loadbalancer.server.port=${ND_PORT}"
   
   volumes:
     traefik_letsencrypt:
   

   Explain Code

   Save and close the file.

   The above Docker Compose configuration includes the following services.

   navidrome service

   • Runs Navidrome using the deluan/navidrome image.
   • Reads music files from the ./music directory mounted inside the container.
   • Stores application data in the ./data directory to preserve the database and settings.
   • Uses environment variables from the .env file to set paths, log level, and timezone.
   • Exposes the web interface internally on port 4533 for Traefik to route traffic.

   traefik service

   • Runs Traefik as a reverse proxy and HTTPS router.
   • Exposes ports 80 and 443 on the host.
   • Automatically redirects HTTP traffic to HTTPS.
   • Requests and renews TLS certificates using Let’s Encrypt.
   • Routes requests for the configured domain to the Navidrome container using Docker labels.

5. Start the services.

   console Copy

   $ docker compose up -d
   

   Explain Code

6. Verify that both containers are running.

   console Copy

   $ docker compose ps
   

   Explain Code

   The output lists the navidrome and traefik services with the status set to Up.

   Note

   For more information about managing Docker Compose applications, refer to the How to Use Docker Compose documentation.

Access and Configure Navidrome

1. Open your web browser and navigate to your domain over HTTPS, such as https://navidrome.example.com.

2. Enter a username and password, then click Create Admin to create the administrator account. Navidrome stores the credentials in the persistent data directory.

   

3. After the administrator account is created, Navidrome opens the main dashboard. If no music files are present in the configured music directory, the interface displays an empty library.

   

Add Music to the Library and Test Streaming

Navidrome scans the configured music directory and indexes supported audio files automatically. The following steps add a sample file and verify that streaming works through the web interface.

1. Download a public-domain audio file directly into the Navidrome music directory.

   console Copy

   $ sudo wget https://archive.org/download/testmp3testfile/mpthreetest.mp3 -P ~/navidrome/music/
   

   Explain Code

2. Ensure the file is readable by the container.

   console Copy

   $ sudo chmod -R 755 ~/navidrome/music
   

   Explain Code
   Note

   Navidrome monitors the music directory. After the file is added, the library updates automatically.

3. Wait for the automatic scan to complete, then verify that the album appears in the library.

   

4. Select the track and start playback in the built-in audio player to confirm that streaming works.

   

Conclusion

You have successfully deployed Navidrome using Docker Compose and secure access through Traefik with automatic HTTPS. The configuration persists application data and music files on the host, allowing the service to index and stream your collection through a web browser. For additional configuration options and advanced features, refer to the official Navidrome documentation.