Installation on Navidrome

Windows Install

Mon, 19 Aug 2024 00:00:00 +0000

MSI Install

Download and install the latest Navidrome MSI for the correct version of Windows (most likely AMD64). The installer will prompt for basic configuration options (port, directories etc). These can be left as default or customised to your setup. The service will be installed and started automatically, once the installer has completed you can go to [http://127.0.0.1:4533] (or whichever port you chose) in a browser and setup the first user. The navidrome.ini configuration file will be located in the installation folder (default: C:\Program Files\Navidrome).

Installing with Docker

Thu, 05 Jan 2017 00:00:00 +0000

Docker images are available for the linux/amd64, linux/arm/v6, linux/arm/v7 and linux/arm64 platforms. They include everything needed to run Navidrome.

Using `docker-compose` :

Create a docker-compose.yml file with the following content (or add the navidrome service below to your existing file):

services:
 navidrome:
 image: deluan/navidrome:latest
 user: 1000:1000 # must own the data folder and be able to read music folder(s). See Permissions below
 ports:
 - "4533:4533"
 restart: unless-stopped
 environment:
 # Optional: put your config options customization here. Examples:
 # ND_LOGLEVEL: debug
 volumes:
 - "/path/to/data:/data"
 - "/path/to/your/music/folder:/music:ro"

Start it with docker-compose up -d. Note that the environment variables above are just an example and are not required. The values in the example are already the defaults

Linux Install

Thu, 05 Jan 2017 00:00:00 +0000

NOTE: These instructions were created for the Ubuntu distribution, and even though they contain specific Ubuntu/Debian instructions (ex: apt) the concepts are generic enough and can be applied on most Linux distributions, even on those not based on Debian (ex: CentOS and OpenSUSE)

Important note

The following steps have been tested on KGARNER7’s MACHINE! WHICH IS: Ubuntu 18.04 and should work on all version 16.04 and above as well as other Debian based distros. Throughout these instructions the commands will have placeholders for the user (<user>) and group (<group>) you want to run Navidrome under and the music folder path (<library_path>). If you are using an existing media library ensure the user has permissions to the media library.

Installing with Podman

Thu, 05 Jan 2017 00:00:00 +0000

Container images are available for the linux/amd64, linux/arm/v7 and linux/arm64 platforms. They include everything needed to run Navidrome.

Using `Podman Quadlet` :

Podman is created to run as both rootful (root user), and rootless (non-root user) modes. Quadlet is a generator tool embeded directly into Podman that translate your *.container files into systemd service. So you can enable/disable it to auto load at each session, like normal systemd service.

macOS Install

Wed, 04 Jan 2017 00:00:00 +0000

You can start Navidrome by double-clicking the binary, or by running it in a terminal. However, it then stops when you close the terminal window, and it does not start again when the Mac restarts.

To run Navidrome in the background, install it as a service with the navidrome service command. The service starts when the Mac starts, even before anyone logs in, and macOS restarts it if it crashes.

Get Navidrome

Create a folder for Navidrome, and make your user its owner:

FreeBSD Install

Tue, 03 Jan 2017 00:00:00 +0000

The following steps have been tested on FreeBSD 12 and 13. They should work on all versions 11.4 and above as well as other supported versions. All prerequisites will be automatically installed when using a package or if building from ports. Throughout these instructions the commands will have placeholders for the user (<user>) and group (<group>) you want to run Navidrome under and the music folder path (<library_path>). If you are using an existing media library ensure the user has permissions to the media library.

Community Maintained Packages

Mon, 01 Feb 2016 00:00:00 +0000

DISCLAIMER: These packages are not maintained by the Navidrome project, any issues should be reported to their authors.

Even though the Navidrome project does not provide any pre-packaged installation for specific platforms, there are some packages created and maintained by the community, that can simplify the setup on some systems.

Here is the list of packages for various OSes/Distributions, provided by Repology:

More packages available, with links to download/install instructions:

Managed Hosting

Sun, 10 Jan 2016 00:00:00 +0000

The following providers offer managed hosting for Navidrome. This can be a good option if you don’t want to manage your own server.

The providers below have partnered with us to offer officially supported, cloud-hosted solutions*.

PikaPods

Offers 1-click deployments for Navidrome with $5 free welcome credit. EU and US regions available. Includes daily backups and regular app updates.

Zenith Hosting

Offers 1-click deployments for Navidrome. Upload and manage music in your browser and use your own domain for Navidrome.

Build from sources

Tue, 05 Jan 2016 00:00:00 +0000

Currently these instructions only work for Unix-based systems (Linux, macOS, BSD, …). If you are getting trouble trying to build Navidrome in a Windows system, please join our Discord server and ask for help, we will be glad to assist you

If you can’t find a pre-built binary for your platform, you should open an issue in the project’s GitHub page.

If you don’t want to wait, you can try to build the binary yourself, with the following steps.

Installation on Navidrome

Windows Install

MSI Install

Installing with Docker

Using docker-compose :

Linux Install

Installing with Podman

Using Podman Quadlet :

macOS Install

Get Navidrome

FreeBSD Install

Community Maintained Packages

Managed Hosting

PikaPods

Zenith Hosting

Build from sources

Using `docker-compose` :

Using `Podman Quadlet` :