Currently these instructions only work for Unix-based systems (Linux, macOS, BSD, …).
This is just a summary on how to get started. More information will soon be available.
If you are stuck or have any questions, please join our Discord server and
give us a shout on the
Install GoLang 1.15. Make sure to add
Install Node 14
sudo apt install libtag1-dev
brew install taglib
Clone the project from https://github.com/deluan/navidrome
Install development tools:
make buildall. This command should create a
navidromeexecutable in the project’s folder
navidrome.tomlconfig file in the project’s folder with the following options:
# Set your music folder, preferable a specific development music library with few songs, # to make scan fast MusicFolder = "/path/to/music/folder" # Make logging more verbose LogLevel = "debug" # This will always create an `admin` user with the specified password, so you don't have to # create a user every time you delete your dev database DevAutoCreateAdminPassword = "password" # Move the data/DB folder to a different location DataFolder = "./data" # If developing in macOS with the firewall enabled, this avoids having to accept incoming # network connections every time the server restarts Address = "localhost"
To start Navidrome in development mode, just run
make dev. This will start both the backend
and the frontend in “watch” mode, so any changes will automatically be reloaded.
If you get errors on any of these steps, join our chat for support.
Was this page helpful?
Glad to hear it! Please tell us how we can make it even better.
Sorry to hear that. Please tell us how we can improve.