mirrors/navidrome
1
0
Fork 0
mirror of https://github.com/navidrome/navidrome.git synced 2025-04-06 14:07:36 +03:00
Code Issues Projects Releases Packages Wiki Activity

Rewrite README

Browse source
This commit is contained in:
Deluan 2020-01-23 22:57:51 -05:00
parent 137a20dd9e
commit 15744c362b
2 changed files with 85 additions and 46 deletions
Download patch file Download diff file Expand all files Collapse all files

5
API_COMPATIBILITY.md
View file

@ -12,6 +12,11 @@ Navidrome and Subsonic:
`scrobble` is called with `submission=true` `scrobble` is called with `submission=true`
* Next features to be implemented: Playlists (WIP), MultiUser (WIP), Jukebox, Sharing, Podcasts, Bookmarks, Internet Radio. * Next features to be implemented: Playlists (WIP), MultiUser (WIP), Jukebox, Sharing, Podcasts, Bookmarks, Internet Radio.
Navidrome is actively being tested with:
[DSub](http://www.subsonic.org/pages/apps.jsp#dsub),
[Music Stash](https://play.google.com/store/apps/details?id=com.ghenry22.mymusicstash) and
[Jamstash](http://www.subsonic.org/pages/apps.jsp#jamstash))
| ENDPOINT | NOTES | | ENDPOINT | NOTES |
|------------------------|-------| |------------------------|-------|

126
README.md
View file

@ -1,71 +1,105 @@
# Navidrome Music Streamer # Navidrome Music Streamer
[![Build Status](https://github.com/deluan/navidrome/workflows/Build/badge.svg)](https://github.com/deluan/navidrome/actions) [![Build Status](https://github.com/deluan/navidrome/workflows/Build/badge.svg)](https://github.com/deluan/navidrome/actions)
[![Go Report Card](https://goreportcard.com/badge/github.com/deluan/navidrome)](https://goreportcard.com/report/github.com/deluan/navidrome)
Navidrome is a music collection server and streamer, allowing you to listen to your music collection from anywhere. Navidrome is an open source web-based music collection server and streamer. It gives you freedom to listen to your
It relies on the huge selection of available mobile and web apps compatible with [Subsonic](http://www.subsonic.org), music collection from any browser or mobile device.
[Airsonic](https://airsonic.github.io/) and [Madsonic](https://www.madsonic.org/)
It is already functional (see [Installation](#installation) below), but still in its early stages. ## Features
Version 1.0 main goals are: - Handles very large music collections
- Be fully compatible with available [Subsonic clients](http://www.subsonic.org/pages/apps.jsp) - Streams virtually any audio format available
(actively being tested with - Reads and uses all your beautifully curated metadata (id3 tags)
[DSub](http://www.subsonic.org/pages/apps.jsp#dsub), - Multi-user, each user has their own play counts, playlists, favourites, etc..
[Music Stash](https://play.google.com/store/apps/details?id=com.ghenry22.mymusicstash) and - Very low resource usage: Ex: with a library of 300GB (~29000 songs), it uses less than 50MB of RAM
[Jamstash](http://www.subsonic.org/pages/apps.jsp#jamstash)) - Multi-platform, runs on macOS, Linux and Windows. Docker images are also provided
- Implement smart/dynamic playlists (similar to iTunes) - Automatically monitors your library for changes, importing new files and reloading new metadata
- Optimized ro run on cheap hardware (Raspberry Pi) and VPS - Responsive Web interface to manage users and browse your library
- Compatible with the huge selection of clients for [Subsonic](http://www.subsonic.org),
[Airsonic](https://airsonic.github.io/) and [Madsonic](https://www.madsonic.org/).
See the [complete list of available mobile and web apps](https://airsonic.github.io/docs/apps/)
### Supported Subsonic API version ## Upcoming features
Check the (almost) up to date [compatibility chart](API_COMPATIBILITY.md) This project is being actively worked on. Expect a more polished experience and new features/releases
for what is working. on a frequent basis. Some upcoming features planned:
### Installation - Transcoding/Downsampling on-the-fly
- Last.FM integration
- Integrated music player
- Pre-build binaries for all platforms
- Smart/dynamic playlists (similar to iTunes)
- Jukebox mode
- Sharing links to albums/songs/playlists
- Podcasts
As this is a work in progress, there are no installers yet. To have the server running in your computer, follow ## Installation
the steps in the [Development Environment](#development-environment) section below, then run it with:
``` Currently there are no downloadable binaries (WIP). You current options are:
$ export SONIC_MUSICFOLDER="/path/to/your/music/folder"
$ make #### Run it with Docker
```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:
SONIC_MUSICFOLDER: /music
SONIC_PORT: 4533
SONIC_SCANINTERVAL: 10s
SONIC_LOGLEVEL: debug
volumes:
- "./data:/data"
- "/Users/deluan/Music/iTunes/iTunes Media/Music:/music"
``` ```
The server should start listening for requests on the default port 4533. The first time you start the app it will #### Build it yourself / Development Environment
create a new user "admin" with a random password. Check the logs for a line like this:
```
Creating initial user. Please change the password! password=be32e686-d59b-4f57-b780-d04dc5e9cf04 user=admin
```
You can change this password using the UI. Just login in with this temporary password at http://localhost:4533 You will need to install [Go 1.13](https://golang.org/dl/) and [Node 13.7](http://nodejs.org).
You'll also need [ffmpeg](ffmpeg.org) installed in your system
To change any configuration, create a file named `navidrome.toml` in the project folder. For all options see the After the prerequisites above are installed, build the application with:
[configuration.go](conf/configuration.go) file
### Development Environment
You will need to install [Go 1.13](https://golang.org/dl/) and [Node 13.7](http://nodejs.org)
Then install dependencies:
``` ```
$ make setup $ make setup
$ make buildall
``` ```
Some useful commands: This will generate the `navidrome` binary in the project's root folder. Start the server with:
```shell script
./navidrome
```
The server should start listening for requests on the default port __4533__
```bash #### First time password
# Start local server (with hot reload) The first time you start the app it will create a new user "admin" with a random password.
$ make Check the logs for a line like this:
```
# Run all tests Creating initial user. Please change the password! password=XXXXXX user=admin
$ make test
``` ```
### Copying You can change this password using the UI. Just browse to http://localhost:4533/app#/user
and login with this temporary password.
Navidrome - Copyright (C) 2017-2020 Deluan Cotts Quintao ## Screenshots
The source code is licensed under GNU Affero GPL v3. License is available [here](/LICENSE) <p align="center">
<p float="left">
<img width="300" src="https://raw.githubusercontent.com/deluan/navidrome/master/static/screenshot-login-mobile.png">
<img width="300" src="https://raw.githubusercontent.com/deluan/navidrome/master/static/screenshot-mobile.png">
<img width="600"src="https://raw.githubusercontent.com/deluan/navidrome/master/static/screenshot-desktop.png">
</p>
</p>
### Subsonic API Version Compatibility
Check the up to date [compatibility table](https://github.com/deluan/navidrome/blob/master/API_COMPATIBILITY.md)
for the latest Subsonic features available.