From 6de6049326009c9ae42db3ae16227e766334424f Mon Sep 17 00:00:00 2001 From: aymhce Date: Sat, 27 Jan 2018 22:14:56 +0100 Subject: [PATCH 1/6] update readme for YunoHost/apps#410 --- README.md | 61 ++++++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 58 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ad1a18f..21fa330 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,59 @@ -# Ampache package for YunoHost +Ampache for YunoHost +--------------------- -* [Ampache website](http://ampache.org/) -* [YunoHost website](https://yunohost.org) +[Ampache](http://ampache.org) for the love of music. A web based audio/video +streaming application and file manager allowing you to access your +music & videos from anywhere, using almost any internet enabled device. + +**Shipped version:** 3.8.3 + +[![Install Ampache with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=ampache) +![](http://ampache.org/img/previews/visualizer.jpg) + +## Features + +In addition to Ampache core features, the following are made available with +this package: + + * Config for high quality streaming with high bandwith + * Quick loading for mobile devices with potential low bandwith + * Integrate with YunoHost users - same username and password + * Allow one user to be the administrator (set at the installation) + +## Getting start + + * **Add your first catalog to load music files** + * Go to *Admin panel* [](https://raw.githubusercontent.com/ampache/ampache/develop/themes/reborn/images/icons/icon_admin.png) + * Click on *Add a Catalog* + * Fill up fields and click *Add Calalog* + * Next, enjoy :) + + * **Update a catalog for load new music files** + * Go to *Admin panel* [](https://raw.githubusercontent.com/ampache/ampache/develop/themes/reborn/images/icons/icon_admin.png) + * Click on *Show Catalogs* + * Select *Update* in *Actions* list and click *Go* + + * **Change interface Language** + * Go to *Preferences panel* [](https://raw.githubusercontent.com/ampache/ampache/develop/themes/reborn/images/icons/icon_edit.png) + * Click on *Interface* + * Change *Language* field + +## Ampache on mobile devices + + * [For Android](https://play.google.com/store/apps/details?id=com.antoniotari.reactiveampacheapp) + * [For iOS](http://iampache.com/) + + * Full list of existings clients : https://github.com/ampache/ampache/wiki/Clients + +## Limitations + +The user panel button was disabled because it hide an essential part of the ampache user interface. + +Also, the SSO authentication not fully working from user panel, we have to work about this. +In fact, it's can disrupt external Ampache clients like Subsonic. + +## Links + + * Report a bug: https://github.com/YunoHost-Apps/ampache_ynh/issues + * Ampache website: http://ampache.org/ + * YunoHost website: https://yunohost.org/ From df9872a31b3be32cdc85e84114d4496335acdfb3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?D=C3=A9veloppeur=20libre?= Date: Sat, 27 Jan 2018 22:59:02 +0100 Subject: [PATCH 2/6] fix icons --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 21fa330..8550343 100644 --- a/README.md +++ b/README.md @@ -23,18 +23,18 @@ this package: ## Getting start * **Add your first catalog to load music files** - * Go to *Admin panel* [](https://raw.githubusercontent.com/ampache/ampache/develop/themes/reborn/images/icons/icon_admin.png) + * Go to *Admin panel* ![](https://raw.githubusercontent.com/ampache/ampache/develop/themes/reborn/images/icons/icon_admin.png) * Click on *Add a Catalog* * Fill up fields and click *Add Calalog* * Next, enjoy :) * **Update a catalog for load new music files** - * Go to *Admin panel* [](https://raw.githubusercontent.com/ampache/ampache/develop/themes/reborn/images/icons/icon_admin.png) + * Go to *Admin panel* ![](https://raw.githubusercontent.com/ampache/ampache/develop/themes/reborn/images/icons/icon_admin.png) * Click on *Show Catalogs* * Select *Update* in *Actions* list and click *Go* * **Change interface Language** - * Go to *Preferences panel* [](https://raw.githubusercontent.com/ampache/ampache/develop/themes/reborn/images/icons/icon_edit.png) + * Go to *Preferences panel* ![](https://raw.githubusercontent.com/ampache/ampache/develop/themes/reborn/images/icons/icon_edit.png) * Click on *Interface* * Change *Language* field From b97346a034e3f6f63662c76934b9a559fd8db921 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?D=C3=A9veloppeur=20libre?= Date: Sat, 27 Jan 2018 23:09:20 +0100 Subject: [PATCH 3/6] fix grammar --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8550343..e44e7c7 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ this package: * Integrate with YunoHost users - same username and password * Allow one user to be the administrator (set at the installation) -## Getting start +## Getting started * **Add your first catalog to load music files** * Go to *Admin panel* ![](https://raw.githubusercontent.com/ampache/ampache/develop/themes/reborn/images/icons/icon_admin.png) From f814669983013314c9d57a60e117de95e50a38d0 Mon Sep 17 00:00:00 2001 From: Maniack Crudelis Date: Sat, 27 Jan 2018 23:32:30 +0100 Subject: [PATCH 4/6] Update readme for official app --- README.md | 62 +++++++++++++++++++++++++++++++++++++++++++------------ 1 file changed, 49 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index e44e7c7..953d633 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,30 @@ -Ampache for YunoHost ---------------------- +# Ampache for YunoHost +[![Integration level](https://dash.yunohost.org/integration/ampache.svg)](https://ci-apps.yunohost.org/jenkins/job/ampache%20%28Official%29/lastBuild/consoleFull) +[![Install Ampache with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=ampache) + +> *This package allow you to install ampache quickly and simply on a YunoHost server. +If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.* + +## Overview [Ampache](http://ampache.org) for the love of music. A web based audio/video streaming application and file manager allowing you to access your music & videos from anywhere, using almost any internet enabled device. **Shipped version:** 3.8.3 -[![Install Ampache with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=ampache) +## Screenshots + ![](http://ampache.org/img/previews/visualizer.jpg) -## Features +## Configuration + +## Documentation + + * Official documentation: + * YunoHost documentation: There no other documentations, feel free to contribute. + +## YunoHost specific features In addition to Ampache core features, the following are made available with this package: @@ -20,7 +34,22 @@ this package: * Integrate with YunoHost users - same username and password * Allow one user to be the administrator (set at the installation) -## Getting started +#### Multi-users support + +? + +#### Supported architectures + +* Tested on x86_64 + +## Limitations + +* The user panel button was disabled because it hides an essential part of the ampache user interface. +* Also, the SSO authentication not fully working from user panel, we have to work about this. +In fact, it can disrupt external Ampache clients like Subsonic. + +## Additionnal informations +### Getting started * **Add your first catalog to load music files** * Go to *Admin panel* ![](https://raw.githubusercontent.com/ampache/ampache/develop/themes/reborn/images/icons/icon_admin.png) @@ -38,22 +67,29 @@ this package: * Click on *Interface* * Change *Language* field -## Ampache on mobile devices +### Ampache on mobile devices * [For Android](https://play.google.com/store/apps/details?id=com.antoniotari.reactiveampacheapp) * [For iOS](http://iampache.com/) * Full list of existings clients : https://github.com/ampache/ampache/wiki/Clients -## Limitations - -The user panel button was disabled because it hide an essential part of the ampache user interface. - -Also, the SSO authentication not fully working from user panel, we have to work about this. -In fact, it's can disrupt external Ampache clients like Subsonic. - ## Links * Report a bug: https://github.com/YunoHost-Apps/ampache_ynh/issues * Ampache website: http://ampache.org/ * YunoHost website: https://yunohost.org/ + +--- + +Developers infos +---------------- + +Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/ampache_ynh/tree/testing). + +To try the testing branch, please proceed like that. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/ampache_ynh/tree/testing --verbose +or +sudo yunohost app upgrade ampache -u https://github.com/YunoHost-Apps/ampache_ynh/tree/testing --verbose +``` From 2b25ce47101857ce5753f26035353c01f4ff1405 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?D=C3=A9veloppeur=20libre?= Date: Sun, 28 Jan 2018 00:35:45 +0100 Subject: [PATCH 5/6] add tested on armhf --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 953d633..544dfb8 100644 --- a/README.md +++ b/README.md @@ -41,6 +41,7 @@ this package: #### Supported architectures * Tested on x86_64 +* Tested on armhf ## Limitations From 6744bc78cfc95fe9c065a01f562995ebe9c06bc5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?D=C3=A9veloppeur=20libre?= Date: Sun, 28 Jan 2018 16:21:41 +0100 Subject: [PATCH 6/6] fill multi-users part for YunoHost/apps#41 --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 544dfb8..55bb47e 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,8 @@ this package: #### Multi-users support -? + * Ampache is connect to Yunohost LDAP + * No auto SSO yet #### Supported architectures