Skip to content

daemonless/navidrome

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Navidrome

Build Status Last Commit

Modern Music Server and Streamer compatible with Subsonic/Airsonic.

Port 4533
Registry ghcr.io/daemonless/navidrome
Source https://www.navidrome.org/
Website https://www.navidrome.org/

Version Tags

Tag Description Best For
latest Upstream Binary. Built from official release. Most users. Matches Linux Docker behavior.

Prerequisites

Before deploying, ensure your host environment is ready. See the Quick Start Guide for host setup instructions.

Deployment

Podman Compose

services:
  navidrome:
    image: "ghcr.io/daemonless/navidrome:latest"
    container_name: navidrome
    environment:
      - PUID=1000  # User ID for the application process
      - PGID=1000  # Group ID for the application process
      - TZ=UTC  # Timezone for the container
      - ND_SCANNER_SCHEDULE="@every 1h"  # Schedule for automatic scans.
      - ND_LOGLEVEL=info  # Log level. Useful for troubleshooting.
    volumes:
      - "/path/to/containers/navidrome:/config"
      - "/path/to/music:/music"
    ports:
      - "4533:4533"
    restart: unless-stopped

AppJail Director

.env:

# .env

DIRECTOR_PROJECT=navidrome
PUID=1000
PGID=1000
TZ=UTC
ND_SCANNER_SCHEDULE="@every 1h"
ND_LOGLEVEL=info

appjail-director.yml:

# appjail-director.yml

options:
  - virtualnet: ':<random> default'
  - nat:
services:
  navidrome:
    name: navidrome
    options:
      - container: 'boot args:--pull'
      - expose: '4533:4533 proto:tcp' \
    oci:
      user: root
      environment:
        - PUID: !ENV '${PUID}'
        - PGID: !ENV '${PGID}'
        - TZ: !ENV '${TZ}'
        - ND_SCANNER_SCHEDULE: !ENV '${ND_SCANNER_SCHEDULE}'
        - ND_LOGLEVEL: !ENV '${ND_LOGLEVEL}'
    volumes:
      - navidrome: /config
      - music: /music
volumes:
  navidrome:
    device: '/path/to/containers/navidrome'
  music:
    device: 'music'

Makejail:

# Makejail 

ARG tag=latest

OPTION overwrite=force
OPTION from=ghcr.io/daemonless/navidrome:${tag}

Note: Exposing ports in AppJail means that your service can be reached from remote hosts. If that is not your intention, do not expose the ports and communicate with the service using the IPv4 address assigned by the virtual network.

Podman CLI

podman run -d --name navidrome \
  -p 4533:4533 \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=UTC \
  -e ND_SCANNER_SCHEDULE="@every 1h" \
  -e ND_LOGLEVEL=info \
  -v /path/to/containers/navidrome:/config \
  -v /path/to/music:/music \
  ghcr.io/daemonless/navidrome:latest

AppJail

appjail oci run -Pd \
  -o overwrite=force \
  -o container="args:--pull" \
  -o virtualnet=":<random> default" \
  -o nat \
  -o expose="4533:4533 proto:tcp" \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=UTC \
  -e ND_SCANNER_SCHEDULE="@every 1h" \
  -e ND_LOGLEVEL=info \
  -o fstab="/path/to/containers/navidrome /config <pseudofs>" \
  -o fstab="/path/to/music /music <pseudofs>" \
  ghcr.io/daemonless/navidrome:latest navidrome

Note: Exposing ports in AppJail means that your service can be reached from remote hosts. If that is not your intention, do not expose the ports and communicate with the service using the IPv4 address assigned by the virtual network.

Ansible

- name: Deploy navidrome
  containers.podman.podman_container:
    name: navidrome
    image: "ghcr.io/daemonless/navidrome:latest"
    state: started
    restart_policy: always
    env:
      PUID: "1000"
      PGID: "1000"
      TZ: "UTC"
      ND_SCANNER_SCHEDULE: ""@every 1h""
      ND_LOGLEVEL: "info"
    ports:
      - "4533:4533"
    volumes:
      - "/path/to/containers/navidrome:/config"
      - "/path/to/music:/music"

Access at: http://localhost:4533

Parameters

Environment Variables

Variable Default Description
PUID 1000 User ID for the application process
PGID 1000 Group ID for the application process
TZ UTC Timezone for the container
ND_SCANNER_SCHEDULE "@every 1h" Schedule for automatic scans.
ND_LOGLEVEL info Log level. Useful for troubleshooting.

Volumes

Path Description
/config Configuration and data directory
/music Folder where your music library is stored

Ports

Port Protocol Description
4533 TCP Web UI

First run

Architectures: amd64 User: bsd (UID/GID via PUID/PGID, defaults to 1000:1000) Base: FreeBSD 15


Need help? Join our Discord community.

About

Modern Music Server and Streamer compatible with Subsonic/Airsonic

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors