1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/airsonic_ynh.git synced 2024-09-03 18:06:14 +02:00
airsonic_ynh/README.md

69 lines
3.4 KiB
Markdown
Raw Normal View History

2019-05-22 22:10:48 +02:00
# Airsonic for YunoHost
2019-02-06 19:37:46 +01:00
2020-08-18 23:34:20 +02:00
[![Integration level](https://dash.yunohost.org/integration/airsonic.svg)](https://dash.yunohost.org/appci/app/airsonic) ![](https://ci-apps.yunohost.org/ci/badges/airsonic.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/airsonic.maintain.svg)
2020-12-19 23:28:10 +01:00
[![Install Airsonic with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=airsonic)
2019-02-06 19:37:46 +01:00
2020-08-18 23:34:20 +02:00
> *This package allow you to install Airsonic quickly and simply on a YunoHost server.
2019-02-06 19:37:46 +01:00
If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.*
## Overview
2020-03-25 20:01:25 +01:00
2019-05-22 22:10:48 +02:00
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.
If you have constrained bandwidth, you may set an upper limit for the bit rate of the music streams. Airsonic will then automatically re sample the music to a suitable bit rate.
In addition to being a streaming media server, Airsonic works very well as a local jukebox. The intuitive web interface, as well as search and index facilities, are optimized for efficient browsing through large media libraries. Airsonic also comes with an integrated Podcast receiver, with many of the same features as you find in iTunes.
2019-02-06 19:37:46 +01:00
**Shipped version:** 10.6.2
2019-02-06 19:37:46 +01:00
## Screenshots
2020-03-25 20:01:25 +01:00
![Sreenshot of home page of Airsonic](screenshot_01.png)
2019-02-06 19:37:46 +01:00
## Demo
2019-05-22 22:10:48 +02:00
* [Official demo](https://airsonic.github.io/demo/)
2019-02-06 19:37:46 +01:00
## Configuration
2019-05-22 22:10:48 +02:00
How to configure this app: by an admin panel.
2019-02-06 19:37:46 +01:00
## Documentation
2020-12-03 13:01:51 +01:00
* Official documentation: https://airsonic.github.io/docs
2019-02-06 19:37:46 +01:00
## YunoHost specific features
2020-08-18 23:34:20 +02:00
* YunoHost LDAP accounts supported: you can login with them
2020-03-25 20:01:25 +01:00
* [Multimedia](https://github.com/YunoHost-Apps/yunohost.multimedia) handled
2020-08-18 23:34:20 +02:00
* Memory RAM limit set to 256 MB because Airsonic was often killed by lack of RAM (hello OOM killer)
2020-12-03 13:01:51 +01:00
* See https://www.reddit.com/r/airsonic/comments/doscco/jvm_memory_issues/
2019-02-06 19:37:46 +01:00
2020-03-25 20:01:25 +01:00
## Supported architectures
2019-02-06 19:37:46 +01:00
2020-08-18 23:34:20 +02:00
* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/airsonic%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/airsonic/)
2019-05-22 22:10:48 +02:00
* 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/)
2019-02-06 19:37:46 +01:00
## Links
2020-03-25 20:01:25 +01:00
* Report a bug: https://github.com/YunoHost-Apps/airsonic_ynh/issues
* App website: https://airsonic.github.io/
* Upstream app repository: https://github.com/airsonic/airsonic
* YunoHost website: https://yunohost.org/
2019-02-06 19:37:46 +01:00
---
2020-03-25 20:01:25 +01:00
## Developers info
2019-02-06 19:37:46 +01:00
2019-05-22 22:10:48 +02:00
Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/airsonic_ynh/tree/testing).
2019-02-06 19:37:46 +01:00
To try the testing branch, please proceed like that.
2020-03-25 20:01:25 +01:00
```bash
2019-05-22 22:10:48 +02:00
sudo yunohost app install https://github.com/YunoHost-Apps/airsonic_ynh/tree/testing --debug
2019-02-06 19:37:46 +01:00
or
2019-05-22 22:10:48 +02:00
sudo yunohost app upgrade airsonic -u https://github.com/YunoHost-Apps/airsonic_ynh/tree/testing --debug
2019-02-06 19:37:46 +01:00
```