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

Auto-update README

Browse source
This commit is contained in:
Yunohost-Bot 2021-10-23 14:53:03 +00:00 committed by Yunohost-Bot
parent 8b6831c506
commit 21d8aa8e87
2 changed files with 45 additions and 65 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

55
README.md
View file

@ -1,3 +1,8 @@
<!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
It shall NOT be edited by hand.
-->
# Funkwhale for YunoHost # 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) [![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)* *[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.* If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
## Overview ## 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. Modern, convivial and free music server
**Shipped version:** 1.1.4 **Shipped version:** 1.1.4~ynh1
**Demo:** https://demo.funkwhale.audio
## Screenshots ## 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 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`
@ -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**. 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 * Official app website: https://funkwhale.audio/
* Official user documentation: https://docs.funkwhale.audio/users/index.html
## YunoHost specific features * Official admin documentation: https://docs.funkwhale.audio/admin/index.html
* Upstream app code repository: https://dev.funkwhale.audio/funkwhale
* Are LDAP and HTTP auth supported? **Yes** * YunoHost documentation for this app: https://yunohost.org/app_funkwhale
* Can the app be used by multiple users? **Yes** * Report a bug: https://github.com/YunoHost-Apps/funkwhale_ynh/issues
#### 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/
---
## Developer info ## Developer info
@ -69,3 +60,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/funkwhale_ynh/tree/te
or or
sudo yunohost app upgrade funkwhale -u https://github.com/YunoHost-Apps/funkwhale_ynh/tree/testing --debug 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

55
README_fr.md
View file

@ -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) [![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) [![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. > *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.* Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
## Vue d'ensemble ## 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. Serveur de musique moderne, convivial et gratuit
**Version incluse :** 1.1.4 **Version incluse :** 1.1.4~ynh1
**Démo :** https://demo.funkwhale.audio
## Captures d'écran ## 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. 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/`. 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` `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**.
## Documentation
* Documentation officielle : https://docs.funkwhale.audio ## Documentations et ressources
## Caractéristiques spécifiques YunoHost * Site officiel de l'app : https://funkwhale.audio/
* Documentation officielle utilisateur : https://docs.funkwhale.audio/users/index.html
#### Support multi-utilisateur * 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
* L'authentification LDAP et HTTP est-elle prise en charge ? **OUI** * Documentation YunoHost pour cette app : https://yunohost.org/app_funkwhale
* L'application peut-elle être utilisée par plusieurs utilisateurs ? **OUI** * Signaler un bug : https://github.com/YunoHost-Apps/funkwhale_ynh/issues
#### 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/
---
## Informations pour les développeurs ## Informations pour les développeurs
@ -68,3 +53,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/funkwhale_ynh/tree/te
ou ou
sudo yunohost app upgrade funkwhale -u https://github.com/YunoHost-Apps/funkwhale_ynh/tree/testing --debug 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