diff --git a/README.md b/README.md index ff5983f..0796aea 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,9 @@ # Funkwhale for YunoHost [![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.svg)](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. If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.* @@ -17,6 +19,12 @@ Installation requires a dedicated domain or subdomain. Installing in a subpath i ![](https://funkwhale.audio/img/desktop.5e79eb16.jpg) +## Demo + +* [Official demo](https://demo.funkwhale.audio) + +**Username:** demo **Password:** demo + ## Admin The admin uses the login you provided at installation. The password is the same you use for YunoHost. @@ -53,7 +61,6 @@ The admin interface is accessible at the address: `your.domain.fr/api/admin` ## Links * 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 * Upstream app repository: https://dev.funkwhale.audio/funkwhale/funkwhale * YunoHost website: https://yunohost.org/ diff --git a/README_fr.md b/README_fr.md new file mode 100644 index 0000000..8d71111 --- /dev/null +++ b/README_fr.md @@ -0,0 +1,81 @@ +# Funkwhale pour YunoHost + +[![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.svg)](https://install-app.yunohost.org/?app=funkwhale) + +*[Read this readme in english.](./README.md)* + +> *Ce package vous permet d'installer Funkwhale rapidement et simplement sur un serveur YunoHost. +Si vous n'avez pas YunoHost, consultez [le guide](https://yunohost.org/#/install) pour apprendre comment l'installer.* + +## Vue d'ensemble +Un serveur de musique moderne, convivial et gratuit sur YunoHost + +L'installation nécessite un domaine ou un sous-domaine dédié. L'installation dans un chemin du domaine n'est pas prise en charge par le projet en amont en raison des exigences de dépendance. + +**Version incluse :** 1.0.1 + +## Captures d'écran + +![](https://funkwhale.audio/img/desktop.5e79eb16.jpg) + +## Démo + +* [Démo officielle](https://demo.funkwhale.audio) + +**Nom d’utilisateur :** demo **Mot de passe :** demo + +## Admin + +L'administrateur utilise le login que vous avez fourni lors de l'installation. Le mot de passe est le même que celui que vous utilisez pour YunoHost. + +L'interface d'administration est accessible à l'adresse : votre.domaine.fr/api/admin + +# État de ce paquet + +* Les éléments suivants ont été testés avec ce paquet et fonctionnent : + + * [x] installer/supprimer/sauvegarder/supprimer/mettre à jour avec x86_64 + * [x] importation des fichiers avec l’interface web, importations depuis youtube, interraction avec MusicBrainz + * [x] [API Subsonic](https://docs.funkwhale.audio/users/apps.html) + * [x] Tests de [Fédération](https://docs.funkwhale.audio/federation.html) + * [x] [Import CLI](https://docs.funkwhale.audio/importing-music.html#from-music-directory-on-the-server) N'oubliez pas de `source $final_path/venv/bin/activate`, puis `source $final_path/load_env` avant de taper en utilisant manage.py. + +* à ajouter : + * [ ] Stocker les fichiers dans HOME, voir https://github.com/YunoHost-Apps/funkwhale_ynh/issues/15 + +## Documentation + + * Documentation officielle : https://docs.funkwhale.audio + +## Caractéristiques spécifiques YunoHost + +#### Support multi-utilisateur + +* L'authentification LDAP et HTTP est-elle prise en charge ? **OUI** +* L'application peut-elle être utilisée par plusieurs utilisateurs ? **OUI** + +#### Architectures supportées + +* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/funkwhale%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/funkwhale/) +* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/funkwhale%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/funkwhale/) + +## Liens + + * Signaler un bug : https://github.com/YunoHost-Apps/funkwhale_ynh + * Site de l’application : https://docs.funkwhale.audio + * Dépôt de l'application principale : https://dev.funkwhale.audio/funkwhale/funkwhale + * Site web YunoHost : https://yunohost.org/ + +--- + +## Informations pour les développeurs + +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/funkwhale_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/funkwhale_ynh/tree/testing --debug +or +sudo yunohost app upgrade funkwhale -u https://github.com/YunoHost-Apps/funkwhale_ynh/tree/testing --debug +```