2021-10-08 16:51:09 +02:00
< a href = "https://www.navidrome.org" > < img src = "resources/logo-192x192.png" alt = "Navidrome logo" title = "navidrome" align = "right" height = "60px" / > < / a >
2021-10-05 18:15:44 +02:00
2023-04-11 20:00:44 +02:00
# Navidrome Music Server [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=Tired%20of%20paying%20for%20music%20subscriptions%2C%20and%20not%20finding%20what%20you%20really%20like%3F%20Roll%20your%20own%20streaming%20service%21&url=https://navidrome.org&via=navidrome)
2016-02-25 00:28:23 +01:00
2021-06-19 17:32:22 +02:00
[![Last Release ](https://img.shields.io/github/v/release/navidrome/navidrome?logo=github&label=latest&style=flat-square )](https://github.com/navidrome/navidrome/releases)
2022-12-22 00:41:22 +01:00
[![Build ](https://img.shields.io/github/actions/workflow/status/navidrome/navidrome/pipeline.yml?branch=master&logo=github&style=flat-square )](https://nightly.link/navidrome/navidrome/workflows/pipeline/master)
2021-06-19 17:32:22 +02:00
[![Downloads ](https://img.shields.io/github/downloads/navidrome/navidrome/total?logo=github&style=flat-square )](https://github.com/navidrome/navidrome/releases/latest)
[![Docker Pulls ](https://img.shields.io/docker/pulls/deluan/navidrome?logo=docker&label=pulls&style=flat-square )](https://hub.docker.com/r/deluan/navidrome)
[![Dev Chat ](https://img.shields.io/discord/671335427726114836?logo=discord&label=discord&style=flat-square )](https://discord.gg/xh7j7yF)
[![Subreddit ](https://img.shields.io/reddit/subreddit-subscribers/navidrome?logo=reddit&label=/r/navidrome&style=flat-square )](https://www.reddit.com/r/navidrome/)
2021-04-01 23:38:55 +02:00
[![Contributor Covenant ](https://img.shields.io/badge/Contributor%20Covenant-v2.0-ff69b4.svg?style=flat-square )](CODE_OF_CONDUCT.md)
2016-02-26 16:56:57 +01:00
2022-11-12 03:23:01 +01:00
Navidrome is an open source web-based music collection server and streamer. It gives you freedom to listen to your
2020-02-05 14:40:15 +01:00
music collection from any browser or mobile device. It's like your personal Spotify!
2020-01-25 18:35:28 +01:00
2022-11-12 03:23:01 +01:00
**Note**: The `master` branch may be in an unstable or even broken state during development.
Please use [releases ](https://github.com/navidrome/navidrome/releases ) instead of
the `master` branch in order to get a stable set of binaries.
## [Check out our Live Demo!](https://www.navidrome.org/demo/)
2020-01-26 04:01:37 +01:00
__Any feedback is welcome!__ If you need/want a new feature, find a bug or think of any way to improve Navidrome,
2020-08-02 05:29:27 +02:00
please file a [GitHub issue ](https://github.com/navidrome/navidrome/issues ) or join the discussion in our
2020-03-31 21:11:33 +02:00
[Subreddit ](https://www.reddit.com/r/navidrome/ ). If you want to contribute to the project in any other way
2020-05-03 06:01:33 +02:00
([ui/backend dev](https://www.navidrome.org/docs/developers/),
[translations ](https://www.navidrome.org/docs/developers/translations/ ),
[themes ](https://www.navidrome.org/docs/developers/creating-themes )), please join the chat in our
2020-04-01 01:54:38 +02:00
[Discord server ](https://discord.gg/xh7j7yF ).
2020-01-27 14:04:55 +01:00
2020-06-10 17:34:51 +02:00
## Installation
2023-03-14 00:34:47 +01:00
See instructions on the [project's website ](https://www.navidrome.org/docs/installation/ )
2020-06-10 17:34:51 +02:00
2023-03-14 00:32:13 +01:00
## Cloud Hosting
[PikaPods ](https://www.pikapods.com ) has partnered with us to offer you an
[officially supported, cloud-hosted solution ](https://www.navidrome.org/docs/installation/managed/#pikapods ).
A share of the revenue helps fund the development of Navidrome at no additional cost for you.
[![PikaPods ](https://www.pikapods.com/static/run-button.svg )](https://www.pikapods.com/pods?run=navidrome)
2021-12-09 18:24:43 +01:00
2020-06-10 17:34:51 +02:00
## Features
- Handles very **large music collections**
- Streams virtually **any audio format** available
- Reads and uses all your beautifully curated **metadata**
2020-07-27 21:00:03 +02:00
- Great support for **compilations** (Various Artists albums) and **box sets** (multi-disc albums)
2020-06-10 17:34:51 +02:00
- **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
2020-08-11 22:05:23 +02:00
- Ready to use binaries for all major platforms, including **Raspberry Pi**
2020-06-10 17:34:51 +02:00
- Automatically **monitors your library** for changes, importing new files and reloading new metadata
- **Themeable**, modern and responsive **Web interface** based on [Material UI ](https://material-ui.com )
- **Compatible** with all Subsonic/Madsonic/Airsonic [clients ](https://www.navidrome.org/docs/overview/#apps )
- **Transcoding** on the fly. Can be set per user/player. **Opus encoding is supported**
- Translated to **various languages**
2020-05-03 06:01:33 +02:00
## Documentation
2020-06-10 17:34:51 +02:00
All documentation can be found in the project's website: https://www.navidrome.org/docs.
2020-05-03 06:01:33 +02:00
Here are some useful direct links:
2020-01-25 18:35:28 +01:00
2020-05-03 06:01:33 +02:00
- [Overview ](https://www.navidrome.org/docs/overview/ )
- [Installation ](https://www.navidrome.org/docs/installation/ )
- [Docker ](https://www.navidrome.org/docs/installation/docker/ )
- [Binaries ](https://www.navidrome.org/docs/installation/pre-built-binaries/ )
- [Build from source ](https://www.navidrome.org/docs/installation/build-from-source/ )
- [Development ](https://www.navidrome.org/docs/developers/ )
2020-05-06 14:08:43 +02:00
- [Subsonic API Compatibility ](https://www.navidrome.org/docs/developers/subsonic-api/ )
2020-03-21 12:57:15 +01:00
2020-01-24 04:57:51 +01:00
## Screenshots
2020-05-03 06:01:33 +02:00
< p align = "left" >
< img height = "550" src = "https://raw.githubusercontent.com/navidrome/navidrome/master/.github/screenshots/ss-mobile-login.png" >
< img height = "550" src = "https://raw.githubusercontent.com/navidrome/navidrome/master/.github/screenshots/ss-mobile-player.png" >
< img height = "550" src = "https://raw.githubusercontent.com/navidrome/navidrome/master/.github/screenshots/ss-mobile-album-view.png" >
2020-08-14 23:00:24 +02:00
< img width = "550" src = "https://raw.githubusercontent.com/navidrome/navidrome/master/.github/screenshots/ss-desktop-player.png" >
2020-01-24 04:57:51 +01:00
< / p >