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!

  • Navidrome is currently offered as a BETA application, and will be made available for installation via UCP once we have concluded it to be stable in our shared server infrastructure.

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 append -d /path/to/other/directory to the installation or upgrade command of Navidrome.

  • Login to your service via SSH.
  • Execute the following command:
app-navidrome install -p <password>

There is no forgot password mechanism for the admin account of Navidrome yet.
Please save Navidrome's admin account credentials in a password manager.

  • Once the installation has finished, you should see the below output in your terminal:
    • Do note that username, hostname, and port will be replaced with your specific details.
{"data": {"url": "https://ultradocs.hostname.usbx.me/navidrome", "port": XXXXX, "username": "ultradocs", "password": "XXXXXXXXXXXXXXX", "media_directory": "/home/ultradocs/media/Music"}, "result": true}
  • Copy the URL from the terminal output and paste into your browser to visit the Navidrome WebUI.
  • 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.

Update and Repair

  • To update and repair Navidrome, execute 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, run the installation script again with the following SSH command:
app-navidrome uninstall
  • Wait for uninstallation to complete.
Back to top