README
¶
Navidrome Music Server 
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!
Note: The master branch may be in an unstable or even broken state during development.
Please use releases instead of
the master branch in order to get a stable set of binaries.
Check out our Live Demo!
Any feedback is welcome! If you need/want a new feature, find a bug or think of any way to improve Navidrome, please file a GitHub issue or join the discussion in our Subreddit. If you want to contribute to the project in any other way (ui/backend dev, translations, themes), please join the chat in our Discord server.
Installation
See instructions on the project's website
Cloud Hosting
PikaPods has partnered with us to offer you an officially supported, cloud-hosted solution. A share of the revenue helps fund the development of Navidrome at no additional cost for you.
Features
- Handles very large music collections
- Streams virtually any audio format available
- Reads and uses all your beautifully curated metadata
- Great support for compilations (Various Artists albums) and box sets (multi-disc albums)
- Multi-user, each user has their own play counts, playlists, favourites, etc...
- Very low resource usage
- Multi-platform, runs on macOS, Linux and Windows. Docker images are also provided
- Ready to use binaries for all major platforms, including Raspberry Pi
- Automatically monitors your library for changes, importing new files and reloading new metadata
- Supports lyrics from sidecar .ttml, .yaml/.yml Lyricsfile, .elrc, .lrc, .srt, .txt files and embedded TTML, Enhanced LRC, LRC, SRT, and plain-text tags (via
lyricspriority) - Themeable, modern and responsive Web interface based on Material UI
- Compatible with all Subsonic/Madsonic/Airsonic clients
- Transcoding on the fly. Can be set per user/player. Opus encoding is supported
- Translated to various languages
Translations
Navidrome uses POEditor for translations, and we are always looking for more contributors
Documentation
All documentation can be found in the project's website: https://www.navidrome.org/docs. Here are some useful direct links:
Screenshots
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
adapters
|
|
|
gotaglib
Package gotaglib provides an alternative metadata extractor using go-taglib, a pure Go (WASM-based) implementation of TagLib.
|
Package gotaglib provides an alternative metadata extractor using go-taglib, a pure Go (WASM-based) implementation of TagLib. |
|
buildtags
Package buildtags provides compile-time enforcement of required build tags.
|
Package buildtags provides compile-time enforcement of required build tags. |
|
artwork/blurhash
Package blurhash implements the blurhash encoding (https://github.com/woltapp/blurhash), parameterized to match Jellyfin so clients see equivalent hashes.
|
Package blurhash implements the blurhash encoding (https://github.com/woltapp/blurhash), parameterized to match Jellyfin so clients see equivalent hashes. |
|
artwork/dominant
Package dominant extracts an image's dominant colour, for use as a flat placeholder while the real artwork loads.
|
Package dominant extracts an image's dominant colour, for use as a flat placeholder while the real artwork loads. |
|
artwork/thumbhash
Package thumbhash implements the ThumbHash encoding algorithm (https://github.com/evanw/thumbhash).
|
Package thumbhash implements the ThumbHash encoding algorithm (https://github.com/evanw/thumbhash). |
|
matcher
Package matcher matches song results from external agents (Last.fm, Deezer, etc.) to tracks in the local music library, prioritizing accuracy over recall.
|
Package matcher matches song results from external agents (Last.fm, Deezer, etc.) to tracks in the local music library, prioritizing accuracy over recall. |
|
playback
Package playback implements audio playback using PlaybackDevices.
|
Package playback implements audio playback using PlaybackDevices. |
|
criteria
Package criteria implements the smart playlist criteria DSL.
|
Package criteria implements the smart playlist criteria DSL. |
|
capabilities
Package capabilities defines Go interfaces for Navidrome plugin capabilities.
|
Package capabilities defines Go interfaces for Navidrome plugin capabilities. |
|
host
Package host provides host services that can be called by plugins via Extism host functions.
|
Package host provides host services that can be called by plugins via Extism host functions. |
|
cmd/ndpgen
module
|
|
|
pdk/go
module
|
|
|
nolint:unused
|
nolint:unused |
|
events
Package events based on https://thoughtbot.com/blog/writing-a-server-sent-events-server-in-go
|
Package events based on https://thoughtbot.com/blog/writing-a-server-sent-events-server-in-go |
|
imghttp
Package imghttp holds the HTTP caching contract shared by the subsonic, public, and jellyfin image handlers, so they apply identical headers without importing each other.
|
Package imghttp holds the HTTP caching contract shared by the subsonic, public, and jellyfin image handlers, so they apply identical headers without importing each other. |
|
subsonic/e2e
Package e2e provides end-to-end integration tests for the Navidrome Subsonic API.
|
Package e2e provides end-to-end integration tests for the Navidrome Subsonic API. |
|
harness
Package harness holds the pieces shared by the API e2e suites (server/subsonic/e2e and server/jellyfin/e2e): golden-database lifecycle, snapshot restore, fixture-FS registration, and service doubles.
|
Package harness holds the pieces shared by the API e2e suites (server/subsonic/e2e and server/jellyfin/e2e): golden-database lifecycle, snapshot restore, fixture-FS registration, and service doubles. |
|
gg
Package gg implements simple "extensions" to Go language.
|
Package gg implements simple "extensions" to Go language. |
|
httpclient
Package httpclient provides a shared http.Client factory that identifies Navidrome via the User-Agent header on all outgoing requests.
|
Package httpclient provides a shared http.Client factory that identifies Navidrome via the User-Agent header on all outgoing requests. |
|
jsoncommentstrip
Package jsoncommentstrip provides an io.Reader that strips JavaScript-style comments (// line and /* block */) from JSON input while preserving comment-like sequences inside JSON string values.
|
Package jsoncommentstrip provides an io.Reader that strips JavaScript-style comments (// line and /* block */) from JSON input while preserving comment-like sequences inside JSON string values. |
|
natural
Package natural provides natural (alphanumeric) string comparison.
|
Package natural provides natural (alphanumeric) string comparison. |
|
pl
Package pl implements some Data Pipeline helper functions.
|
Package pl implements some Data Pipeline helper functions. |
Click to show internal directories.
Click to hide internal directories.