1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/navidrome_ynh.git synced 2024-09-03 19:46:30 +02:00
navidrome_ynh/README.md

72 lines
3 KiB
Markdown
Raw Normal View History

2020-08-16 13:57:57 +02:00
# Navidrome for YunoHost
[![Integration level](https://dash.yunohost.org/integration/navidrome.svg)](https://dash.yunohost.org/appci/app/navidrome) ![](https://ci-apps.yunohost.org/ci/badges/navidrome.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/navidrome.maintain.svg)
[![Install Navidrome with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=navidrome)
2020-08-16 13:57:57 +02:00
*[Lire ce readme en français.](./README_fr.md)*
> *This package allows you to install Navidrome quickly and simply on a YunoHost server.
If you don't have YunoHost, please consult [the guide](https://yunohost.org/install) to learn how to install it.*
2020-08-16 13:57:57 +02:00
## Overview
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.
2020-08-16 13:57:57 +02:00
**Shipped version:** 0.42.1
2020-08-16 13:57:57 +02:00
## Screenshots
![](https://raw.githubusercontent.com/deluan/navidrome/master/.github/screenshots/ss-desktop-player.png)
## Demo
2020-10-06 18:37:23 +02:00
* [Official demo](https://demo.navidrome.org/app/#/login)
2020-08-16 13:57:57 +02:00
## Configuration
#### Where are stored your music files
2020-08-16 13:57:57 +02:00
Your music files are stored by default in your shared [multimedia folder](https://github.com/YunoHost-Apps/yunohost.multimedia) `/home/yunohost.multimedia/share/Music`. This folder is accessible from Nextcloud with *External Storages* enabled. This will allow you to easily upload your music files to the server.
2020-08-16 15:15:40 +02:00
You can configure an alternative path to you music files by editing the path `MusicFolder = "/home/yunohost.multimedia/share/Music"` in this file `/var/lib/navidrome/navidrome.toml` using the [documentation](https://www.navidrome.org/docs/usage/configuration-options/).
#### Client player
You must activate *public site* if you want to connect a client player to Navidrome.
2020-08-23 14:32:54 +02:00
2020-08-16 13:57:57 +02:00
## Documentation
* Official documentation: https://www.navidrome.org/docs/
* YunoHost documentation: https://yunohost.org/en/app_navidrome
2020-08-16 13:57:57 +02:00
## YunoHost specific features
#### Multi-user support
* Is LDAP supported? **No**
* Can the app be used by multiple users? **Yes**
#### Supported architectures
* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/navidrome.svg)](https://ci-apps.yunohost.org/ci/apps/navidrome/)
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/navidrome.svg)](https://ci-apps-arm.yunohost.org/ci/apps/navidrome/)
2020-08-16 13:57:57 +02:00
## Links
* Report a bug: https://github.com/YunoHost-Apps/navidrome_ynh/issues
2020-10-23 10:34:44 +02:00
* App website: https://www.navidrome.org/
2020-08-16 13:57:57 +02:00
* Upstream app repository: https://github.com/deluan/navidrome/
* YunoHost website: https://yunohost.org/
---
## Developer info
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/navidrome_ynh/tree/testing).
To try the testing branch, please proceed like that.
```
sudo yunohost app install https://github.com/YunoHost-Apps/navidrome_ynh/tree/testing --debug
or
sudo yunohost app upgrade navidrome -u https://github.com/YunoHost-Apps/navidrome_ynh/tree/testing --debug
```