diff --git a/README.md b/README.md index e42ad47..9f456d5 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,8 @@ + + # 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) @@ -5,27 +10,27 @@ *[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 consult [the guide](https://yunohost.org/#/install) to learn how to install it.* ## Overview -A modern, convivial and free music server on YunoHost -Installation requires a dedicated domain or subdomain. Installing in a subpath is not supported by the upstream project due to dependency requirements. +Funkwhale is a community-driven project that lets you listen and share music and audio within a decentralized, open network. -**Shipped version:** 1.1.4 +**Shipped version:** 1.1.4~ynh2 + +**Demo:** https://demo.funkwhale.audio ## Screenshots -![](https://upload.wikimedia.org/wikipedia/commons/d/d8/Capture_d%27%C3%A9cran_de_la_page_d%27accueil_de_Funkwhale.png) +![](./doc/screenshots/screenshot1.png) -## Demo +## Disclaimers / important information -* [Official demo](https://demo.funkwhale.audio) +* Any known limitations, constrains or stuff not working, such as (but not limited to): + * Installation requires a dedicated domain or subdomain. Installing in a subpath is not supported by the upstream project due to dependency requirements. -**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 interface is accessible at the address: `your.domain.fr/api/admin` @@ -36,28 +41,14 @@ foo@bar:~$sudo ln -s /your/music/collection /home/yunohost.app/funkwhale/data/mu ``` The files can then be added to your library from the *uploading* tab in a music library under the heading **Import music from your server**. -## Documentation +## Documentation and resources - * Official documentation: https://docs.funkwhale.audio - -## YunoHost specific features - - * Are LDAP and HTTP auth supported? **Yes** - * Can the app be used by multiple users? **Yes** - -#### Supported architectures - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/funkwhale.svg)](https://ci-apps.yunohost.org/ci/apps/funkwhale/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/funkwhale.svg)](https://ci-apps-arm.yunohost.org/ci/apps/funkwhale/) - -## Links - - * Report a bug: https://github.com/YunoHost-Apps/funkwhale_ynh/issues - * App website: https://docs.funkwhale.audio - * Upstream app repository: https://dev.funkwhale.audio/funkwhale/funkwhale - * YunoHost website: https://yunohost.org/ - ---- +* Official app website: https://funkwhale.audio/ +* Official user documentation: https://docs.funkwhale.audio/users/index.html +* Official admin documentation: https://docs.funkwhale.audio/admin/index.html +* Upstream app code repository: https://dev.funkwhale.audio/funkwhale +* YunoHost documentation for this app: https://yunohost.org/app_funkwhale +* Report a bug: https://github.com/YunoHost-Apps/funkwhale_ynh/issues ## Developer info @@ -69,3 +60,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/funkwhale_ynh/tree/te or sudo yunohost app upgrade funkwhale -u https://github.com/YunoHost-Apps/funkwhale_ynh/tree/testing --debug ``` + +**More info regarding app packaging:** https://yunohost.org/packaging_apps \ No newline at end of file diff --git a/README_fr.md b/README_fr.md index 8865e54..ef076b5 100644 --- a/README_fr.md +++ b/README_fr.md @@ -3,29 +3,29 @@ [![Niveau d'intégration](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) [![Installer Funkwhale avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=funkwhale) -*[Read this readme in english.](./README.md)* +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.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.* +> *Ce package vous permet d'installer Funkwhale rapidement et simplement sur un serveur YunoHost. +Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.* ## 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. +Funkwhale est un projet communautaire qui vous permet d'écouter et de partager de la musique et de l'audio au sein d'un réseau ouvert et décentralisé. -**Version incluse :** 1.1.4 +**Version incluse :** 1.1.4~ynh2 + +**Démo :** https://demo.funkwhale.audio ## Captures d'écran -![](https://upload.wikimedia.org/wikipedia/commons/d/d8/Capture_d%27%C3%A9cran_de_la_page_d%27accueil_de_Funkwhale.png) +![](./doc/screenshots/screenshot1.png) -## Démo +## Avertissements / informations importantes -* [Démo officielle](https://demo.funkwhale.audio) +* 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. -**Nom d’utilisateur :** demo **Mot de passe :** demo - -## Admin +* 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. @@ -33,30 +33,15 @@ L'interface d'administration est accessible à l'adresse : votre.domaine.fr/api/ Pour ajouter une collection de fichiers musicaux à une bibliothèque dans votre installation YunoHost de Funkwhale, créez un lien symbolique vers votre collection intitulée "music" dans `/home/yunohost.app/funkwhale/data/`. `foo@bar:~$sudo ln -s /your/music/collection /home/yunohost.app/funkwhale/data/music` Les fichiers peuvent ensuite être ajoutés à votre bibliothèque à partir de l'onglet *Envoi* dans une bibliothèque musicale sous la rubrique **Importer de la musique de votre serveur**. -## Documentation - * Documentation officielle : https://docs.funkwhale.audio +## Documentations et ressources -## 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.svg)](https://ci-apps.yunohost.org/ci/apps/funkwhale/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/funkwhale.svg)](https://ci-apps-arm.yunohost.org/ci/apps/funkwhale/) - -## Liens - - * Signaler un bug : https://github.com/YunoHost-Apps/funkwhale_ynh/issues - * 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/ - ---- +* Site officiel de l'app : https://funkwhale.audio/ +* Documentation officielle utilisateur : https://docs.funkwhale.audio/users/index.html +* Documentation officielle de l'admin : https://docs.funkwhale.audio/admin/index.html +* Dépôt de code officiel de l'app : https://dev.funkwhale.audio/funkwhale +* Documentation YunoHost pour cette app : https://yunohost.org/app_funkwhale +* Signaler un bug : https://github.com/YunoHost-Apps/funkwhale_ynh/issues ## Informations pour les développeurs @@ -68,3 +53,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/funkwhale_ynh/tree/te ou sudo yunohost app upgrade funkwhale -u https://github.com/YunoHost-Apps/funkwhale_ynh/tree/testing --debug ``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file diff --git a/doc/DESCRIPTION.md b/doc/DESCRIPTION.md new file mode 100644 index 0000000..213775f --- /dev/null +++ b/doc/DESCRIPTION.md @@ -0,0 +1 @@ +Funkwhale is a community-driven project that lets you listen and share music and audio within a decentralized, open network. \ No newline at end of file diff --git a/doc/DESCRIPTION_fr.md b/doc/DESCRIPTION_fr.md new file mode 100644 index 0000000..0541ed9 --- /dev/null +++ b/doc/DESCRIPTION_fr.md @@ -0,0 +1 @@ +Funkwhale est un projet communautaire qui vous permet d'écouter et de partager de la musique et de l'audio au sein d'un réseau ouvert et décentralisé. \ No newline at end of file diff --git a/doc/DISCLAIMER_fr.md b/doc/DISCLAIMER_fr.md index 8343524..c8de072 100644 --- a/doc/DISCLAIMER_fr.md +++ b/doc/DISCLAIMER_fr.md @@ -1,10 +1,10 @@ -* 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. +* 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. * 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'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 -Pour ajouter une collection de fichiers musicaux à une bibliothèque dans votre installation YunoHost de Funkwhale, créez un lien symbolique vers votre collection intitulée "music" dans `/home/yunohost.app/funkwhale/data/`. +L'interface d'administration est accessible à l'adresse : votre.domaine.fr/api/admin +Pour ajouter une collection de fichiers musicaux à une bibliothèque dans votre installation YunoHost de Funkwhale, créez un lien symbolique vers votre collection intitulée "music" dans `/home/yunohost.app/funkwhale/data/`. `foo@bar:~$sudo ln -s /your/music/collection /home/yunohost.app/funkwhale/data/music` -Les fichiers peuvent ensuite être ajoutés à votre bibliothèque à partir de l'onglet *Envoi* dans une bibliothèque musicale sous la rubrique **Importer de la musique de votre serveur**. +Les fichiers peuvent ensuite être ajoutés à votre bibliothèque à partir de l'onglet *Envoi* dans une bibliothèque musicale sous la rubrique **Importer de la musique de votre serveur**. diff --git a/manifest.json b/manifest.json index 1ffe232..a31b8df 100644 --- a/manifest.json +++ b/manifest.json @@ -6,7 +6,7 @@ "en": "Modern, convivial and free music server", "fr": "Serveur de musique moderne, convivial et gratuit" }, - "version": "1.1.4~ynh1", + "version": "1.1.4~ynh2", "url": "https://funkwhale.audio", "upstream": { "license": "AGPL-3.0-or-later", @@ -36,13 +36,11 @@ "install" : [ { "name": "domain", - "type": "domain", - "example": "example.com" + "type": "domain" }, { "name": "admin", - "type": "user", - "example": "johndoe" + "type": "user" }, { "name": "is_public", diff --git a/scripts/install b/scripts/install index c030df1..8048444 100644 --- a/scripts/install +++ b/scripts/install @@ -128,7 +128,6 @@ ynh_add_nginx_config #================================================= ynh_script_progression --message="Creating a data directory..." -datadir=/home/yunohost.app/$app ynh_app_setting_set --app=$app --key=datadir --value=$datadir mkdir -p $datadir diff --git a/scripts/restore b/scripts/restore index 60b5027..37cef64 100644 --- a/scripts/restore +++ b/scripts/restore @@ -39,10 +39,7 @@ datadir=$(ynh_app_setting_get --app=$app --key=datadir) #================================================= ynh_script_progression --message="Validating restoration parameters..." -ynh_webpath_available --domain=$domain --path_url=$path_url \ - || ynh_die --message="Path not available: ${domain}${path_url}" -test ! -d $final_path \ - || ynh_die --message="There is already a directory: $final_path " +test ! -d $final_path || ynh_die --message="There is already a directory: $final_path " #================================================= # STANDARD RESTORATION STEPS