navidrome service
The service commands install Navidrome as a service in your OS service manager, then start, stop,
and check it. The service manager is systemd on most Linux systems, launchd on macOS, and the
Service Control Manager on Windows. navidrome service --help shows the one your system uses.
The installation guides for Linux, macOS, and Windows show the full setup.
Usage
navidrome service <subcommand> [flags]
The alias svc works too, so navidrome svc status is the same as navidrome service status.
All commands also accept the global flags.
Subcommands
| Subcommand | Description |
|---|---|
install | Install Navidrome as a service |
uninstall | Remove the service |
start | Start the service |
stop | Stop the service |
status | Show whether the service is running |
execute | Run Navidrome in the foreground, as the service manager does |
service install
Installs Navidrome as a system service. Before it installs, it prints the working directory, music folder, data folder, and log location the service will use. You usually need root or Administrator rights to install a service.
navidrome service install [-u <user>] [-w <folder>] [-c <config file>]
If you pass --configfile, the service uses that config file. Without it, the service looks for
navidrome.toml in its working directory. The service manager restarts Navidrome if it fails.
Logs go to the data folder, unless you set LogFile.
On Linux, the systemd unit also reads environment variables from /etc/sysconfig/navidrome if that
file exists.
Flags
| Flag | Default | Description |
|---|---|---|
-u, --user | OS user that runs the service | |
-w, --working-directory | Folder of the navidrome binary | Working directory of the service |
Examples
# Install the service with a config file, run by the navidrome user
sudo navidrome service install --user navidrome --configfile /etc/navidrome/navidrome.toml
# Install with a different working directory
sudo navidrome svc install --working-directory /var/lib/navidrome
service uninstall
Removes the service from the service manager. Your music and data folders stay as they are.
navidrome service uninstall
Flags
This subcommand has no flags.
Examples
sudo navidrome svc uninstall
service start
Starts the service.
navidrome service start
Flags
This subcommand has no flags.
Examples
sudo navidrome svc start
service stop
Stops the service. Navidrome gets 10 seconds to shut down cleanly.
navidrome service stop
Flags
This subcommand has no flags.
Examples
sudo navidrome svc stop
service status
Prints whether the service is Running, Stopped, or Unknown.
navidrome service status
Flags
This subcommand has no flags.
Examples
navidrome svc status
service execute
Runs Navidrome in the foreground as a service. The service manager runs this command to start
Navidrome, so you don’t need it. To run Navidrome in the foreground yourself, run navidrome.
navidrome service execute
Flags
This subcommand has no flags.
The service command is for native installs. In Docker, Compose, or Kubernetes, the container
platform starts and stops Navidrome.
Feedback
Was this page helpful?
Glad to hear it! Please tell us how we can make this documentation even better.
Sorry to hear that. Please tell us how we can improve this documentation.