mirror of
https://github.com/navidrome/navidrome.git
synced 2025-04-03 20:47:35 +03:00
Simplify README.md
This commit is contained in:
Deluan
parent
cccd0235cf
commit
cc1205c79d
1 changed files with 18 additions and 141 deletions
159
README.md
159
README.md
|
|
@ -12,151 +12,28 @@ music collection from any browser or mobile device. It's like your personal Spot
|
||||||
__Any feedback is welcome!__ If you need/want a new feature, find a bug or think of any way to improve Navidrome,
|
__Any feedback is welcome!__ If you need/want a new feature, find a bug or think of any way to improve Navidrome,
|
||||||
please fill a [GitHub issue](https://github.com/deluan/navidrome/issues) or join the discussion in our
|
please fill a [GitHub issue](https://github.com/deluan/navidrome/issues) or join the discussion in our
|
||||||
[Subreddit](https://www.reddit.com/r/navidrome/). If you want to contribute to the project in any other way
|
[Subreddit](https://www.reddit.com/r/navidrome/). If you want to contribute to the project in any other way
|
||||||
(ui/backend dev, translations, [themes](ui/src/themes/README.md)), please join the chat in our
|
([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
|
||||||
[Discord server](https://discord.gg/xh7j7yF).
|
[Discord server](https://discord.gg/xh7j7yF).
|
||||||
|
|
||||||
|
## Documentation
|
||||||
|
All documentation can be found in the project's homepage: https://www.navidrome.org/docs.
|
||||||
|
Here are some useful direct links:
|
||||||
|
|
||||||
## Features
|
- [Overview](https://www.navidrome.org/docs/overview/)
|
||||||
|
- [Installation](https://www.navidrome.org/docs/installation/)
|
||||||
- Handles very large music collections
|
- [Docker](https://www.navidrome.org/docs/installation/docker/)
|
||||||
- Streams virtually any audio format available
|
- [Binaries](https://www.navidrome.org/docs/installation/pre-built-binaries/)
|
||||||
- Reads and uses all your beautifully curated metadata (id3 tags)
|
- [Build from source](https://www.navidrome.org/docs/installation/build-from-source/)
|
||||||
- Multi-user, each user has their own play counts, playlists, favourites, etc..
|
- [Development](https://www.navidrome.org/docs/developers/)
|
||||||
- Very low resource usage: Ex: with a library of 300GB (~29000 songs), it uses less than 50MB of RAM
|
- [Subsonic API Version Compatibility](https://www.navidrome.org/docs/developers/subsonic-api/)
|
||||||
- Multi-platform, runs on macOS, Linux and Windows. Docker images are also provided
|
|
||||||
- Ready to use Raspberry Pi binaries available
|
|
||||||
- Automatically monitors your library for changes, importing new files and reloading new metadata
|
|
||||||
- [Themeable](ui/src/themes/README.md), modern and responsive Web interface based on Material UI, to manage users and
|
|
||||||
browse your library
|
|
||||||
- Compatible with all Subsonic/Madsonic/Airsonic clients. See below for a list of tested clients
|
|
||||||
- Transcoding/Downsampling on-the-fly. Can be set per user/player. Opus encoding is supported
|
|
||||||
- Integrated music player (WIP)
|
|
||||||
|
|
||||||
Navidrome should be compatible with all Subsonic clients. The following clients are tested and confirmed to work properly:
|
|
||||||
- Android: [DSub](https://play.google.com/store/apps/details?id=github.daneren2005.dsub),
|
|
||||||
[Ultrasonic](https://play.google.com/store/apps/details?id=org.moire.ultrasonic) and
|
|
||||||
[Music Stash](https://play.google.com/store/apps/details?id=com.ghenry22.mymusicstash)
|
|
||||||
- iOS: [play:Sub](http://michaelsapps.dk/playsubapp/)
|
|
||||||
- Web: [Jamstash](http://jamstash.com),
|
|
||||||
[Aurial](http://shrimpza.github.io/aurial/),
|
|
||||||
[Subfire](http://p.subfireplayer.net/) and
|
|
||||||
[Subplayer](https://github.com/peguerosdc/subplayer)
|
|
||||||
|
|
||||||
For more options, look at the [list of clients](https://airsonic.github.io/docs/apps/) maintained by
|
|
||||||
the Airsonic project. Please open an [issue](https://github.com/deluan/navidrome/issues) if you have any
|
|
||||||
trouble with the client of your choice.
|
|
||||||
|
|
||||||
|
|
||||||
## Road map
|
|
||||||
|
|
||||||
This project is being actively worked on. Expect a more polished experience and new features/releases
|
|
||||||
on a frequent basis. Some upcoming features planned:
|
|
||||||
|
|
||||||
- Complete WebUI, to browse and listen to your library
|
|
||||||
- Last.FM integration
|
|
||||||
- Smart/dynamic playlists (similar to iTunes)
|
|
||||||
- Support for audiobooks (bookmarking)
|
|
||||||
- Jukebox mode
|
|
||||||
- Sharing links to albums/songs/playlists
|
|
||||||
- Podcasts
|
|
||||||
|
|
||||||
|
|
||||||
## Installation
|
|
||||||
|
|
||||||
Various options are available:
|
|
||||||
|
|
||||||
### Pre-built executables
|
|
||||||
|
|
||||||
Just head to the [releases page](https://github.com/deluan/navidrome/releases) and download the latest version for you
|
|
||||||
platform. There are builds available for Linux (amd64 and arm), macOS and Windows (32 and 64 bits).
|
|
||||||
For Raspberry Pi (tested with Raspbian Buster on Pi 4), use the Linux arm builds.
|
|
||||||
|
|
||||||
Remember to install [ffmpeg](https://ffmpeg.org/download.html) in your system, a requirement for Navidrome to work
|
|
||||||
properly. You may find the latest static build for your platform here: https://johnvansickle.com/ffmpeg/
|
|
||||||
|
|
||||||
If you have any issues with these binaries, or need a binary for a different platform, please
|
|
||||||
[open an issue](https://github.com/deluan/navidrome/issues)
|
|
||||||
|
|
||||||
### Docker
|
|
||||||
|
|
||||||
[Docker images](https://hub.docker.com/r/deluan/navidrome) are available. They include everything needed
|
|
||||||
to run Navidrome. Example of usage:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
# This is just an example. Customize it to your needs.
|
|
||||||
|
|
||||||
version: "3"
|
|
||||||
services:
|
|
||||||
navidrome:
|
|
||||||
image: deluan/navidrome:latest
|
|
||||||
ports:
|
|
||||||
- "4533:4533"
|
|
||||||
environment:
|
|
||||||
# All options with their default values:
|
|
||||||
ND_MUSICFOLDER: /music
|
|
||||||
ND_DATAFOLDER: /data
|
|
||||||
ND_SCANINTERVAL: 1m
|
|
||||||
ND_LOGLEVEL: info
|
|
||||||
ND_PORT: 4533
|
|
||||||
ND_TRANSCODINGCACHESIZE: 100MB
|
|
||||||
ND_SESSIONTIMEOUT: 30m
|
|
||||||
ND_BASEURL: ""
|
|
||||||
volumes:
|
|
||||||
- "./data:/data"
|
|
||||||
- "/path/to/your/music/folder:/music:ro"
|
|
||||||
```
|
|
||||||
|
|
||||||
To get the cutting-edge, latest version from master, use the image `deluan/navidrome:develop`
|
|
||||||
|
|
||||||
### Build from source
|
|
||||||
|
|
||||||
You will need to install [Go 1.14](https://golang.org/dl/) and [Node 13](http://nodejs.org).
|
|
||||||
You'll also need [ffmpeg](https://ffmpeg.org) installed in your system. The setup is very strict, and
|
|
||||||
the steps below only work with these specific versions (enforced in the Makefile)
|
|
||||||
|
|
||||||
After the prerequisites above are installed, clone this repository and build the application with:
|
|
||||||
|
|
||||||
```shell script
|
|
||||||
$ git clone https://github.com/deluan/navidrome
|
|
||||||
$ cd navidrome
|
|
||||||
$ make setup # Install tools required for Navidrome's development
|
|
||||||
$ make buildall # Build UI and server, generates a single executable
|
|
||||||
```
|
|
||||||
|
|
||||||
This will generate the `navidrome` executable binary in the project's root folder.
|
|
||||||
|
|
||||||
### Running for the first time
|
|
||||||
|
|
||||||
Start the server with:
|
|
||||||
```shell script
|
|
||||||
./navidrome
|
|
||||||
```
|
|
||||||
The server should start listening for requests on the default port __4533__
|
|
||||||
|
|
||||||
After starting Navidrome for the first time, go to http://localhost:4533. It will ask you to create your first admin
|
|
||||||
user.
|
|
||||||
|
|
||||||
For more options, run `navidrome --help`
|
|
||||||
|
|
||||||
### Running as a service
|
|
||||||
|
|
||||||
Check the [contrib](https://github.com/deluan/navidrome/tree/master/contrib)
|
|
||||||
folder for startup files for your init system.
|
|
||||||
|
|
||||||
|
|
||||||
## Screenshots
|
## Screenshots
|
||||||
|
|
||||||
<p align="center">
|
<p align="left">
|
||||||
<p float="left">
|
<img height="550" src="https://raw.githubusercontent.com/deluan/navidrome/master/.github/screenshots/ss-mobile-login.png">
|
||||||
<img width="270" src="https://raw.githubusercontent.com/deluan/navidrome/master/.github/screenshots/ss-mobile-login.png">
|
<img height="550" src="https://raw.githubusercontent.com/deluan/navidrome/master/.github/screenshots/ss-mobile-player.png">
|
||||||
<img width="270" src="https://raw.githubusercontent.com/deluan/navidrome/master/.github/screenshots/ss-mobile-player.png">
|
<img height="550" src="https://raw.githubusercontent.com/deluan/navidrome/master/.github/screenshots/ss-mobile-album-view.png">
|
||||||
<img width="270" src="https://raw.githubusercontent.com/deluan/navidrome/master/.github/screenshots/ss-mobile-album-view.png">
|
<img height="550" src="https://raw.githubusercontent.com/deluan/navidrome/master/.github/screenshots/ss-desktop-player.png">
|
||||||
<img width="900" src="https://raw.githubusercontent.com/deluan/navidrome/master/.github/screenshots/ss-desktop-player.png">
|
|
||||||
</p>
|
</p>
|
||||||
</p>
|
|
||||||
|
|
||||||
|
|
||||||
## Subsonic API Version Compatibility
|
|
||||||
|
|
||||||
Check the up to date [compatibility table](https://www.navidrome.org/docs/developers/subsonic-api)
|
|
||||||
for the latest Subsonic features available.
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue