Skip to main content

Navidrome

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!

Installation

Do note, media directory cannot be changed in Navidrome's UI post-installation. If not specified during installation, home/username/media/Music will be used as the default media directory. Should you want a different media directory location, you can specify it during the installation. You can change the media directory of an existing installation by executing app-navidrome upgrade -d /path/to/other/directory via SSH.

  • Install Navidrome from the Installers tab on the User Control Panel. Make sure to choose a strong password.
  • Once the installation has been completed, you can access the Navidrome web UI from the Apps tab on the UCP.
  • Log in with the credentials you set during the installation.

  • If you did not specifically set a custom media directory during installation, all music data present in ~/media/Music will be scanned and available for streaming.

Helpful Information

Configuration File

  • The Navidrome configuration file is located here: ~/.apps/navidrome/navidrome.toml
  • It has the following settings:
MusicFolder = "/home/your_username/media/Music"
ScanSchedule = "@every 24h"
LogLevel = "info"
  • You cannot change Music Folder by editing the path in the config file. To change it you would need to upgrade or re-install Navidrome and specify the path by appending -d /path/to/other/directory to the install/upgrade command.
  • For more options, please visit the Navidrome documentation page.

Upgrade and Repair

  • You can upgrade and repair Navidrome from the Apps tab on the UCP, or by executing the following command:
app-navidrome upgrade
  • Or, if you want to set a new media directory:
app-navidrome upgrade -d /path/to/other/directory
  • The execution time of the command can take up to 1-2 minutes, be patient.

Uninstall Navidrome

  • To uninstall Navidrome, go to the Apps tab on the User Control Panel, or run the installation script again with the following SSH command:
app-navidrome uninstall
  • Wait for uninstallation to complete.