Portainer Templates logo

Portainer Templates

Navidrome Navidrome

Stack

MultimediaMusic

Navidrome is an open source web-based music collection server and streamer. It gives you freedom to listen to your music collection from any browser or mobile device. It's like your personal Spotify!

Image details

Pulls: 50.7M
Architecture: amd64, arm64, arm/v7, arm/v6, 386, riscv64
Image size: 80 MB
Latest: 0.63.2
User: deluan
Created: Jan 24, 2020
Updated: 5 minutes ago
Status: active

Source details

Repo: deluan/navidrome
Stars: 22.9k
Forks: 2k
Language: Go
License: GPL-3.0
Latest: v0.63.2 · 1 month ago
Updated: 22 minutes ago
Website: www.navidrome.org/

Configuration

Type
Compose
Platform
linux
Image
deluan/navidrome:latest
Ports
4533:4533
Volumes
/data : /portainer/Files/AppData/Config/navidrome/music : /path/to/your/music/folder
Env vars
ND_SCANSCHEDULE=1hND_LOGLEVEL=infoND_BASEURL=PUID=1000PGID=1000PORT=''
Source
Repo

Template by xneo1·Source

Standalone Install

Select an install method, to see config/commands for deploying Navidrome

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select Navidrome, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo
Original stackfile

The compose file this template deploys, straight from its repo:

services:
  navidrome:
    container_name: navidrome
    image: deluan/navidrome:latest
    ports:
      - "4533:4533"
    environment:
      # Optional: put your config options customization here. Examples:
      ND_SCANSCHEDULE: 1h
      ND_LOGLEVEL: info  
      ND_BASEURL: ""
    volumes:
      - "/portainer/Files/AppData/Config/navidrome:/data"
      - "/path/to/your/music/folder:/music:ro"

Or deploy it directly from the source:

git clone https://github.com/xneo1/portainer_templates
cd portainer_templates
docker compose -f Template/Stack/navidrome.yml up -d

More install options in our documentation, or see deluan/navidrome for app-specific guidance.

Navidrome Music Server GitHub

Last Release Build Downloads Docker Pulls Dev Chat Subreddit Contributor Covenant
Navidrome is an open source web-based music collection server and streamer. It gives you freedom to listen to your music collection from any browser or mobile device. It's like your personal Spotify!
Any feedback is welcome! If you need/want a new feature, find a bug or think of any way to improve Navidrome, please file a GitHub issue or join the discussion in our Subreddit. If you want to contribute to the project in any other way (ui/backend dev, translations, themes), please join the chat in our Discord server.

Features

  • Handles very large music collections
  • Streams virtually any audio format available
  • Reads and uses all your beautifully curated metadata (id3 tags)
  • Multi-user, each user has their own play counts, playlists, favourites, etc..
  • Very low resource usage: Ex: with a library of 300GB (~29000 songs), it uses less than 50MB of RAM
  • Multi-platform, runs on macOS, Linux and Windows. Docker images are also provided
  • Ready to use Raspberry Pi binaries and docker images available
  • Automatically monitors your library for changes, importing new files and reloading new metadata
  • Themeable, modern and responsive Web interface based on Material UI, to manage users and
browse your library
  • Compatible with all Subsonic/Madsonic/Airsonic clients. Check out the list of tested clients
  • Transcoding/Downsampling on-the-fly. Can be set per user/player. Opus encoding is supported
  • Integrated music player

Demo Site

To see Navidrome in action, check out our live demo

Hosting

If you plan to host Navidrome in the cloud, a great option is to get a virtual server at BuyVM. Their service is Docker-friendly and they have plans that start at $2/month! If you decide to sign up, please consider using our affliliate link, to help support the project <3

Road map

For information about upcoming features, take a look at the project's road map

Docker usage

Docker images are available for linux/amd64, linux/arm/v7 and linux/arm64. They include everything needed to run Navidrome. Example of usage with Compose:
# This is just an example. Customize it to your needs.

version: "3"
services:
  navidrome:
    image: deluan/navidrome:latest
    ports:
      - "4533:4533"
    environment:
      # Optional: put your config options customization here. Examples:
      ND_SCANSCHEDULE: 1h
      ND_LOGLEVEL: info  
      ND_BASEURL: ""
    volumes:
      - "./data:/data"
      - "/path/to/your/music/folder:/music:ro"

To get the cutting-edge, latest version from master, use the image deluan/navidrome:develop For more details, please head to our (ever improving) documentation site.

Screenshots

<img width="270" src="https://raw.githubusercontent.com/navidrome/navidrome/master/.github/screenshots/ss-mobile-login.png">
<img width="270" src="https://raw.githubusercontent.com/navidrome/navidrome/master/.github/screenshots/ss-mobile-player.png">
<img width="270" src="https://raw.githubusercontent.com/navidrome/navidrome/master/.github/screenshots/ss-mobile-album-view.png">
<img width="900" src="https://raw.githubusercontent.com/navidrome/navidrome/master/.github/screenshots/ss-desktop-player.png">

Subsonic API Version Compatibility

Check the up to date compatibility table for the latest Subsonic features available.

Serve Navidrome on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying navidrome.example.com to http://navidrome:4533

Add this to your Caddyfile

navidrome.example.com {
	reverse_proxy http://navidrome:4533
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs <container>
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:4533 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :4533
  • Stop the other service, or pick a different host port. In 4533:4533 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:4533. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, navidrome can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 4533

Permission denied on volumes

If the logs show "permission denied", the app can't write to its data folder on the host.

  • Fix the ownership: sudo chown -R 1000:1000 /portainer/Files/AppData/Config/navidrome (and the same for the other mapped folders)
  • Or set the PUID and PGID variables (defaults 1000:1000) to match your own user, found with id $USER

Image won't pull

Test the pull directly on the host: docker pull deluan/navidrome:latest

  • "manifest unknown" means the tag no longer exists. This template uses latest, so try pinning a specific version instead.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • This image supports: amd64, arm64, arm/v7, arm/v6, 386, riscv64
  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Required settings are blank

ND_BASEURL, PORT have no default value, and navidrome may crash or misbehave if left empty.

  • Fill them in on the deploy screen before hitting deploy.

Stack won't deploy

Compose stacks fail fast on small mistakes, and Portainer shows the reason just above the editor.

  • YAML only accepts spaces for indentation, a single tab breaks the whole file.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A Compose stack

Navidrome is a Compose stack, a set of containers defined in one file and brought up together by Portainer, then started and stopped as a single app.

The app image

An image is the app packed up ready to go, everything Navidrome needs bundled into one download. This template pulls deluan/navidrome:latest, which Docker fetches once (about 80 MB) and then starts your own copy from.

Where the image comes from

Docker pulls its images from registries, public libraries of ready-built apps. Navidrome's comes from Docker Hub, published by deluan.

Version tags

The bit after the colon in the image name is the version tag. Here it's latest, which always points at the newest build, so a redeploy can bump you to a newer release without you asking. Newest right now is 0.63.2. Pin a specific tag if you would rather stay on one version.

Which machines it runs on

Every image is built for particular CPU types. This one ships for amd64, arm64, arm/v7, arm/v6, 386, riscv64, so it runs on both regular x86 servers and ARM boards like a Raspberry Pi.

Ports

A port is the door the app answers on. A mapping like 4533:4533 means it's reachable on port 4533 of your server, where the left number is yours to change and the right one belongs to the app. It opens:

  • 4533:4533

Volumes

A volume is where Navidrome keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /data from /portainer/Files/AppData/Config/navidrome on the host
  • /music from /path/to/your/music/folder on the host

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Navidrome takes 6 of them, and 2 need a value before it'll start properly:

  • ND_SCANSCHEDULE, defaults to 1h
  • ND_LOGLEVEL, defaults to info
  • ND_BASEURL, needs a value
  • PUID, defaults to 1000
  • PGID, defaults to 1000
  • PORT, needs a value

Users and permissions

The PUID and PGID settings tell it which user and group to act as on your host. Point them at your own account (find yours with id $USER) so the files it writes into your mounted folders come out owned by you rather than root.

Networking

Nothing custom is set, so Navidrome sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.

Container name

Once it's deployed, Portainer names the container navidrome. That's what you'll spot in the containers list and use in commands like docker logs navidrome.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Open source license

Navidrome is open source, released under the GPL-3.0 license. In plain terms the code is out in the open, so you're free to run it and change it to fit what you need.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Navidrome up. Add the template list to Portainer once, then deploying Navidrome is a click rather than a wall of config.