mirror of
https://github.com/YunoHost-Apps/airsonic_ynh.git
synced 2024-09-03 18:06:14 +02:00
Enhance README
This commit is contained in:
parent
72d530415c
commit
b0ae6889aa
3 changed files with 16 additions and 15 deletions
21
README.md
21
README.md
|
@ -7,6 +7,7 @@
|
||||||
If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.*
|
If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.*
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
Airsonic is a free, web-based media streamer, providing ubiquitous access to your music. Use it to share your music with friends, or to listen to your own music while at work. You can stream to multiple players simultaneously, for instance to one player in your kitchen and another in your living room.
|
Airsonic is a free, web-based media streamer, providing ubiquitous access to your music. Use it to share your music with friends, or to listen to your own music while at work. You can stream to multiple players simultaneously, for instance to one player in your kitchen and another in your living room.
|
||||||
|
|
||||||
Airsonic is designed to handle very large music collections (hundreds of gigabytes). Although optimized for MP3 streaming, it works for any audio or video format that can stream over HTTP, for instance AAC and OGG. By using transcoder plug-ins, Airsonic supports on-the-fly conversion and streaming of virtually any audio format, including WMA, FLAC, APE, Musepack, WavPack and Shorten.
|
Airsonic is designed to handle very large music collections (hundreds of gigabytes). Although optimized for MP3 streaming, it works for any audio or video format that can stream over HTTP, for instance AAC and OGG. By using transcoder plug-ins, Airsonic supports on-the-fly conversion and streaming of virtually any audio format, including WMA, FLAC, APE, Musepack, WavPack and Shorten.
|
||||||
|
@ -19,7 +20,7 @@ In addition to being a streaming media server, Airsonic works very well as a loc
|
||||||
|
|
||||||
## Screenshots
|
## Screenshots
|
||||||
|
|
||||||
![](https://airsonic.github.io/demo/screenshot_01.png)
|
![Sreenshot of home page of Airsonic](screenshot_01.png)
|
||||||
|
|
||||||
## Demo
|
## Demo
|
||||||
|
|
||||||
|
@ -31,19 +32,19 @@ How to configure this app: by an admin panel.
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|
||||||
* Official documentation: https://airsonic.github.io/docs/
|
* Official documentation: <https://airsonic.github.io/docs>
|
||||||
|
|
||||||
## YunoHost specific features
|
## YunoHost specific features
|
||||||
|
|
||||||
#### Multi-users support
|
* YunoHost LDAP accounts supported : you can logon with them
|
||||||
|
* [Multimedia](https://github.com/YunoHost-Apps/yunohost.multimedia) handled
|
||||||
|
* Memory RAM limit set to 256Mb because airsonic was often killed by lack of RAM (hello OOM killer)
|
||||||
|
* See <https://www.reddit.com/r/airsonic/comments/doscco/jvm_memory_issues/>
|
||||||
|
|
||||||
Are LDAP and HTTP auth supported? **Yes**
|
## Supported architectures
|
||||||
|
|
||||||
#### Supported architectures
|
|
||||||
|
|
||||||
* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/airsonic%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/airsonic/)
|
* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/airsonic%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/airsonic/)
|
||||||
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/airsonic%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/airsonic/)
|
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/airsonic%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/airsonic/)
|
||||||
* Jessie x86-64b - [![Build Status](https://ci-stretch.nohost.me/ci/logs/airsonic%20%28Apps%29.svg)](https://ci-stretch.nohost.me/ci/apps/airsonic/)
|
|
||||||
|
|
||||||
**More information on the documentation page:**
|
**More information on the documentation page:**
|
||||||
https://yunohost.org/packaging_apps
|
https://yunohost.org/packaging_apps
|
||||||
|
@ -57,14 +58,14 @@ https://yunohost.org/packaging_apps
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
Developers info
|
## Developers info
|
||||||
----------------
|
|
||||||
|
|
||||||
**Only if you want to use a testing branch for coding, instead of merging directly into master.**
|
**Only if you want to use a testing branch for coding, instead of merging directly into master.**
|
||||||
Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/airsonic_ynh/tree/testing).
|
Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/airsonic_ynh/tree/testing).
|
||||||
|
|
||||||
To try the testing branch, please proceed like that.
|
To try the testing branch, please proceed like that.
|
||||||
```
|
|
||||||
|
```bash
|
||||||
sudo yunohost app install https://github.com/YunoHost-Apps/airsonic_ynh/tree/testing --debug
|
sudo yunohost app install https://github.com/YunoHost-Apps/airsonic_ynh/tree/testing --debug
|
||||||
or
|
or
|
||||||
sudo yunohost app upgrade airsonic -u https://github.com/YunoHost-Apps/airsonic_ynh/tree/testing --debug
|
sudo yunohost app upgrade airsonic -u https://github.com/YunoHost-Apps/airsonic_ynh/tree/testing --debug
|
||||||
|
|
|
@ -6,7 +6,7 @@
|
||||||
"en": "Stream and manage your music collection",
|
"en": "Stream and manage your music collection",
|
||||||
"fr": "Streamez et gérez votre collection de musique"
|
"fr": "Streamez et gérez votre collection de musique"
|
||||||
},
|
},
|
||||||
"version": "10.5.0~ynh2",
|
"version": "10.5.0~ynh3",
|
||||||
"url": "http://airsonic.github.io",
|
"url": "http://airsonic.github.io",
|
||||||
"license": "GPL-3.0-or-later",
|
"license": "GPL-3.0-or-later",
|
||||||
"maintainer": {
|
"maintainer": {
|
||||||
|
|
BIN
screenshot_01.png
Normal file
BIN
screenshot_01.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 400 KiB |
Loading…
Reference in a new issue