mirror of
https://github.com/YunoHost-Apps/ampache_ynh.git
synced 2024-09-03 18:15:55 +02:00
Merge pull request #1 from maniackcrudelis/patch-1
Update readme for official app
This commit is contained in:
commit
ad8b840b15
1 changed files with 49 additions and 13 deletions
62
README.md
62
README.md
|
@ -1,16 +1,30 @@
|
||||||
Ampache for YunoHost
|
# Ampache for YunoHost
|
||||||
---------------------
|
|
||||||
|
|
||||||
|
[](https://ci-apps.yunohost.org/jenkins/job/ampache%20%28Official%29/lastBuild/consoleFull)
|
||||||
|
[](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
|
[Ampache](http://ampache.org) for the love of music. A web based audio/video
|
||||||
streaming application and file manager allowing you to access your
|
streaming application and file manager allowing you to access your
|
||||||
music & videos from anywhere, using almost any internet enabled device.
|
music & videos from anywhere, using almost any internet enabled device.
|
||||||
|
|
||||||
**Shipped version:** 3.8.3
|
**Shipped version:** 3.8.3
|
||||||
|
|
||||||
[](https://install-app.yunohost.org/?app=ampache)
|
## Screenshots
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
## 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
|
In addition to Ampache core features, the following are made available with
|
||||||
this package:
|
this package:
|
||||||
|
@ -20,7 +34,22 @@ this package:
|
||||||
* Integrate with YunoHost users - same username and password
|
* Integrate with YunoHost users - same username and password
|
||||||
* Allow one user to be the administrator (set at the installation)
|
* 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**
|
* **Add your first catalog to load music files**
|
||||||
* Go to *Admin panel* 
|
* Go to *Admin panel* 
|
||||||
|
@ -38,22 +67,29 @@ this package:
|
||||||
* Click on *Interface*
|
* Click on *Interface*
|
||||||
* Change *Language* field
|
* 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 Android](https://play.google.com/store/apps/details?id=com.antoniotari.reactiveampacheapp)
|
||||||
* [For iOS](http://iampache.com/)
|
* [For iOS](http://iampache.com/)
|
||||||
|
|
||||||
* Full list of existings clients : https://github.com/ampache/ampache/wiki/Clients
|
* 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
|
## Links
|
||||||
|
|
||||||
* Report a bug: https://github.com/YunoHost-Apps/ampache_ynh/issues
|
* Report a bug: https://github.com/YunoHost-Apps/ampache_ynh/issues
|
||||||
* Ampache website: http://ampache.org/
|
* Ampache website: http://ampache.org/
|
||||||
* YunoHost website: https://yunohost.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
|
||||||
|
```
|
||||||
|
|
Loading…
Add table
Reference in a new issue