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

64 lines
3.5 KiB
Markdown
Raw Normal View History

2021-06-27 11:57:56 +02:00
<!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
It shall NOT be edited by hand.
-->
2022-09-21 22:44:02 +02:00
# Airsonic-Advanced for YunoHost
2019-02-06 19:37:46 +01:00
2022-05-27 15:45:38 +02:00
[![Integration level](https://dash.yunohost.org/integration/airsonic.svg)](https://dash.yunohost.org/appci/app/airsonic) ![Working status](https://ci-apps.yunohost.org/ci/badges/airsonic.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/airsonic.maintain.svg)
2022-09-21 22:44:02 +02:00
[![Install Airsonic-Advanced 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
2021-06-27 11:57:56 +02:00
*[Lire ce readme en français.](./README_fr.md)*
2020-03-25 20:01:25 +01:00
2022-09-21 22:44:02 +02:00
> *This package allows you to install Airsonic-Advanced quickly and simply on a YunoHost server.
2021-06-27 11:57:56 +02:00
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
2019-05-22 22:10:48 +02:00
2021-06-27 11:57:56 +02:00
## Overview
2019-05-22 22:10:48 +02:00
2022-09-21 22:44:02 +02:00
Airsonic-Advanced is a more modern implementation of the Airsonic fork with several key performance and feature enhancements. It adds and supersedes several features in Airsonic.
2022-09-21 12:45:07 +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-05-22 22:10:48 +02:00
2023-01-13 21:52:52 +01:00
**Shipped version:** 11.0.0~ynh3
2019-02-06 19:37:46 +01:00
## Screenshots
2022-09-21 22:44:02 +02:00
![Screenshot of Airsonic-Advanced](./doc/screenshots/screenshot_01.png)
2019-02-06 19:37:46 +01:00
2021-06-27 11:57:56 +02:00
## Disclaimers / important information
2019-02-06 19:37:46 +01:00
## YunoHost specific features
2021-06-27 11:57:56 +02:00
* YunoHost LDAP accounts supported: **Yes**
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)
2021-06-27 11:57:56 +02:00
* See https://www.reddit.com/r/airsonic/comments/doscco/jvm_memory_issues/
2019-02-06 19:37:46 +01:00
2021-06-27 11:57:56 +02:00
## Documentation and resources
2019-02-06 19:37:46 +01:00
2022-05-27 15:45:38 +02:00
* Official admin documentation: <https://airsonic.github.io/docs/>
2022-09-21 22:44:02 +02:00
* Upstream app code repository: <https://github.com/airsonic-advanced/airsonic-advanced>
2022-05-27 15:45:38 +02:00
* YunoHost documentation for this app: <https://yunohost.org/app_airsonic>
* Report a bug: <https://github.com/YunoHost-Apps/airsonic_ynh/issues>
2019-02-06 19:37:46 +01:00
2021-06-27 11:57:56 +02:00
## Developer info
2019-02-06 19:37:46 +01:00
2021-06-27 11:57:56 +02:00
Please send 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.
2022-05-27 15:45:38 +02: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
```
2021-06-27 11:57:56 +02:00
2022-05-27 15:45:38 +02:00
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>