YunoHost-Apps/funkwhale_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/funkwhale_ynh.git synced 2024-09-03 18:36:24 +02:00
Code Issues Activity Actions 1

Readme update

Browse source
This commit is contained in:
Thomas 2020-12-14 21:41:20 +01:00 • committed by GitHub
parent e289550a44
commit feb367b6d2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 24 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
README.md
View file

@ -3,8 +3,10 @@
[![Integration level](https://dash.yunohost.org/integration/funkwhale.svg)](https://dash.yunohost.org/appci/app/funkwhale) ![](https://ci-apps.yunohost.org/ci/badges/funkwhale.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/funkwhale.maintain.svg) [![Integration level](https://dash.yunohost.org/integration/funkwhale.svg)](https://dash.yunohost.org/appci/app/funkwhale) ![](https://ci-apps.yunohost.org/ci/badges/funkwhale.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/funkwhale.maintain.svg)
[![Install Funkwhale with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=funkwhale) [![Install Funkwhale with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=funkwhale)
*[Lire ce readme en français.](./README_fr.md)*
> *This package allows you to install Funkwhale quickly and simply on a YunoHost server. > *This package allows you to install Funkwhale 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.* If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.
## Overview ## Overview
A modern, convivial and free music server on YunoHost A modern, convivial and free music server on YunoHost
@ -17,21 +19,31 @@ Installation requires a dedicated domain or subdomain. Installing in a subpath i
![](https://funkwhale.audio/img/desktop.5e79eb16.jpg) ![](https://funkwhale.audio/img/desktop.5e79eb16.jpg)
## Demo
* [Official demo](https://demo.funkwhale.audio)
**Username:** demo **Password:** demo
## Admin ## Admin
The admin uses the login you provided at installation. The password is the same you use for YunoHost. The admin uses the login you provided at installation. The password is the same you use for YunoHost.
The admin interface is accessible at the address: `your.domain.fr/api/admin` The admin interface is accessible at the address: your.domain.fr/api/admin
# State of this package # State of this package
* The following have been tested with this package and work fine: * The following have been tested with this package and work fine:
* [x] install/remove/backup/remove/upgrade with x86_64 and ARM * [x] install/remove/backup/remove/upgrade with x86_64
* [x] import file with web interface, imports from YouTube, interraction with MusicBrainz * [x] import file with web interface, imports from youtube, interraction with MusicBrainz
* [x] [Subsonic API](https://docs.funkwhale.audio/users/apps.html) * [x] [Subsonic API](https://docs.funkwhale.audio/users/apps.html)
* [x] [Federation](https://docs.funkwhale.audio/federation.html) tests * [x] [Federation](https://docs.funkwhale.audio/federation.html) tests
* [x] [CLI Import](https://docs.funkwhale.audio/importing-music.html#from-music-directory-on-the-server) Remember to `source $final_path/venv/bin/activate`, then `source $final_path/load_env` before typinh using manage.py. * [x] [CLI Import](https://docs.funkwhale.audio/importing-music.html#from-music-directory-on-the-server) Remember to `source $final_path/venv/bin/activate`, then `source $final_path/load_env` before typinh using manage.py.
* [x] ARM support
* end-user configuration required:
* [x] LDAP integration
* to be added: * to be added:
* [ ] Store files in HOME, see https://github.com/YunoHost-Apps/funkwhale_ynh/issues/15 * [ ] Store files in HOME, see https://github.com/YunoHost-Apps/funkwhale_ynh/issues/15
@ -42,8 +54,10 @@ The admin interface is accessible at the address: `your.domain.fr/api/admin`
## YunoHost specific features ## YunoHost specific features
* Are LDAP and HTTP auth supported? **Yes** #### Multi-user support
* Can the app be used by multiple users? **Yes**
* Are LDAP and HTTP auth supported? **YES**
* Can the app be used by multiple users? **YES**
#### Supported architectures #### Supported architectures
@ -53,14 +67,14 @@ The admin interface is accessible at the address: `your.domain.fr/api/admin`
## Links ## Links
* Report a bug about this package: https://github.com/YunoHost-Apps/funkwhale_ynh * Report a bug about this package: https://github.com/YunoHost-Apps/funkwhale_ynh
* Report a bug about Funkwhale itself: https://code.eliotberriot.com/funkwhale/funkwhale/
* App website: https://docs.funkwhale.audio * App website: https://docs.funkwhale.audio
* Upstream app repository: https://dev.funkwhale.audio/funkwhale/funkwhale * Upstream app repository: https://dev.funkwhale.audio/funkwhale/funkwhale
* YunoHost website: https://yunohost.org/ * YunoHost website: https://yunohost.org/
--- ---
## Developers info Developers info
----------------
Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/funkwhale_ynh/tree/testing). Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/funkwhale_ynh/tree/testing).