Files
navidrome/README.md
T
Deluan Quintão a4f75cf6c4 docs: update contribution policy and PR/Issues templates (#6417)
* docs(contributing): propose updated contribution policy

Draft proposal for maintainer review. Rewrite the contribution guide around prior scope agreement, personal review, AI disclosure and maintainability, while keeping the commit conventions and DCO sign-off. Add AI use and review items to the PR template, keeping its headings.

Simplify the bug form so only what happened, the version and the Code of Conduct are required, and it no longer asks for an upgrade or a duplicate-search attestation. Update the selector text and point README feature requests to Discussions.

Keep the pull-requests anchor because the stale workflow links to it.

Signed-off-by: Deluan <deluan@navidrome.org>

* docs(contributing): allow AI-assisted PR text and review replies

Let contributors use AI tools to draft, edit, or translate PR explanations and review replies, as long as they review the final text, agree with it, and take responsibility for it. The PR template description hint now says the same instead of asking for the contributor's own words.

Signed-off-by: Deluan <deluan@navidrome.org>

* docs(contributing): route closed-issue regressions and no-agreement PRs

The bug form told reporters to add details to a matching report, but the lock workflow locks inactive issues and asks for a new issue instead. It now says to use a matching open report, or open a new one that links a closed issue.

The PR template and guide only offered the small-change exception when prior agreement isn't needed, which doesn't fit translation updates. Both now ask contributors to explain why agreement isn't needed.

Signed-off-by: Deluan <deluan@navidrome.org>

* docs(contributing): ask contributors to be mindful of the maintainer's time

Add the request to the end of the communication paragraph in the guide and to the PR template's description hint.

Signed-off-by: Deluan <deluan@navidrome.org>

* docs(issues): require reproducing bugs on the latest release

Restore a required checkbox in the bug form, placed before the version field: "I'm using the latest Navidrome release and can reproduce the issue on it." Drop the version help sentence that said upgrading isn't required, since it now contradicts the checkbox.

Signed-off-by: Deluan <deluan@navidrome.org>

* docs(issues): turn the bug form search guidance into a checkbox

The long intro paragraph was easy to skip. It now only thanks the reporter and links private security reporting. A required checkbox, grouped with the latest-release one at the top, confirms the reporter searched open and closed issues. The "What happened" help asks reporters to link a matching closed issue.

The steps help now says "If it happens only sometimes" instead of mentioning problems that can't be reproduced, so it no longer conflicts with the required reproduction checkbox.

Signed-off-by: Deluan <deluan@navidrome.org>

* docs(pr-template): ask for AI use with Yes and No checkboxes

Replace the free-text "Yes / No" line with two checkboxes. Contributors tick exactly one, so empty boxes clearly mean the question wasn't answered.

Signed-off-by: Deluan <deluan@navidrome.org>

---------

Signed-off-by: Deluan <deluan@navidrome.org>
2026-11-08 13:20:09 -05:00

6.6 KiB

Navidrome logo

Navidrome Music Server  Tweet

Last Release Build Downloads Docker Pulls Dev Chat Subreddit Contributor Covenant Gurubase

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 find a bug, please file a GitHub issue. If you need/want a new feature or think of any way to improve Navidrome, please share it in Discussions or join the discussion in our Subreddit. Before contributing code, please read the Contribution Guide. 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

Several cloud hosting providers partner with us to offer officially supported, cloud-hosted solutions. If you sign up with any of these providers, a share of the revenue funds the development of Navidrome at no additional cost for you.

Run on PikaPods
Deploy with Zenith
Deploy on ElfHosted

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