2021-10-08 06:51:09 -08: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 08:15:44 -08:00
|
|
|
|
2020-08-11 12:05:23 -08:00
|
|
|
# Navidrome Music Server
|
2016-02-24 14:28:23 -09:00
|
|
|
|
2021-06-19 07:32:22 -08:00
|
|
|
[](https://github.com/navidrome/navidrome/releases)
|
2022-12-21 14:41:22 -09:00
|
|
|
[](https://nightly.link/navidrome/navidrome/workflows/pipeline/master)
|
2021-06-19 07:32:22 -08:00
|
|
|
[](https://github.com/navidrome/navidrome/releases/latest)
|
|
|
|
|
[](https://hub.docker.com/r/deluan/navidrome)
|
|
|
|
|
[](https://discord.gg/xh7j7yF)
|
|
|
|
|
[](https://www.reddit.com/r/navidrome/)
|
2021-04-01 13:38:55 -08:00
|
|
|
[](CODE_OF_CONDUCT.md)
|
2016-02-26 06:56:57 -09:00
|
|
|
|
2022-11-11 17:23:01 -09:00
|
|
|
Navidrome is an open source web-based music collection server and streamer. It gives you freedom to listen to your
|
2020-02-05 04:40:15 -09:00
|
|
|
music collection from any browser or mobile device. It's like your personal Spotify!
|
2020-01-25 08:35:28 -09:00
|
|
|
|
2022-11-11 17:23:01 -09: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-25 18:01:37 -09: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-01 19:29:27 -08:00
|
|
|
please file a [GitHub issue](https://github.com/navidrome/navidrome/issues) or join the discussion in our
|
2020-03-31 11:11:33 -08:00
|
|
|
[Subreddit](https://www.reddit.com/r/navidrome/). If you want to contribute to the project in any other way
|
2020-05-02 20:01:33 -08: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-03-31 15:54:38 -08:00
|
|
|
[Discord server](https://discord.gg/xh7j7yF).
|
2020-01-27 04:04:55 -09:00
|
|
|
|
2020-06-10 07:34:51 -08:00
|
|
|
## Installation
|
|
|
|
|
|
|
|
|
|
See instructions in the [project's website](https://www.navidrome.org/docs/installation/)
|
|
|
|
|
|
2023-03-13 15:32:13 -08: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.
|
|
|
|
|
|
|
|
|
|
[](https://www.pikapods.com/pods?run=navidrome)
|
2021-12-09 08:24:43 -09:00
|
|
|
|
2020-06-10 07:34:51 -08:00
|
|
|
## Features
|
|
|
|
|
|
|
|
|
|
- Handles very **large music collections**
|
|
|
|
|
- Streams virtually **any audio format** available
|
|
|
|
|
- Reads and uses all your beautifully curated **metadata**
|
2020-07-27 11:00:03 -08:00
|
|
|
- Great support for **compilations** (Various Artists albums) and **box sets** (multi-disc albums)
|
2020-06-10 07:34:51 -08: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 12:05:23 -08:00
|
|
|
- Ready to use binaries for all major platforms, including **Raspberry Pi**
|
2020-06-10 07:34:51 -08: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-02 20:01:33 -08:00
|
|
|
## Documentation
|
2020-06-10 07:34:51 -08:00
|
|
|
All documentation can be found in the project's website: https://www.navidrome.org/docs.
|
2020-05-02 20:01:33 -08:00
|
|
|
Here are some useful direct links:
|
2020-01-25 08:35:28 -09:00
|
|
|
|
2020-05-02 20:01:33 -08: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 04:08:43 -08:00
|
|
|
- [Subsonic API Compatibility](https://www.navidrome.org/docs/developers/subsonic-api/)
|
2020-03-21 03:57:15 -08:00
|
|
|
|
2020-01-23 18:57:51 -09:00
|
|
|
## Screenshots
|
|
|
|
|
|
2020-05-02 20:01:33 -08: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 13:00:24 -08:00
|
|
|
<img width="550" src="https://raw.githubusercontent.com/navidrome/navidrome/master/.github/screenshots/ss-desktop-player.png">
|
2020-01-23 18:57:51 -09:00
|
|
|
</p>
|
