From a2fbf65b63db2dccb6d5a7a6dfcdb86afb0c179e Mon Sep 17 00:00:00 2001 From: tituspijean Date: Wed, 26 May 2021 18:18:42 +0200 Subject: [PATCH] Update READMEs --- README.md | 71 ++++++++++++++++++++++++++-------------------------- README_fr.md | 67 +++++++++++++++++++++---------------------------- 2 files changed, 64 insertions(+), 74 deletions(-) diff --git a/README.md b/README.md index c269223..71b6b81 100644 --- a/README.md +++ b/README.md @@ -1,63 +1,60 @@ + + +--- + + + # Jellyfin for YunoHost -[![Integration level](https://dash.yunohost.org/integration/jellyfin.svg)](https://dash.yunohost.org/appci/app/jellyfin) ![](https://ci-apps.yunohost.org/ci/badges/jellyfin.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/jellyfin.maintain.svg) -[![Install Jellyfin with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=jellyfin) +[![Integration level](https://dash.yunohost.org/integration/jellyfin.svg)](https://dash.yunohost.org/appci/app/jellyfin) ![](https://ci-apps.yunohost.org/ci/badges/jellyfin.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/jellyfin.maintain.svg) +[![Install jellyfin with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=jellyfin) *[Lire ce readme en français.](./README_fr.md)* -> *This package allows you to install Jellyfin quickly and simply on a YunoHost server. +> *This package allows you to install jellyfin 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 -Jellyfin enables you to collect, manage, and stream your media. Run the Jellyfin server on your system and gain access to the leading free-software entertainment system, bells and whistles included. -**Shipped version:** 10.7.5 +Media System that manage and stream your media. + +**Shipped version:** 10.7.5~ynh2 + +**Demo:** https://demo.jellyfin.org/stable/web/index.html + ## Screenshots -![](https://jellyfin.org/images/screenshots/movie_full.png) -## Demo + ![](./doc/screenshots/jellyfin.png) -* [Official demo](https://demo.jellyfin.org/) -## Configuration - * How to configure this app: From an admin panel. -## Documentation +## Disclaimers / important information - * Official documentation: https://jellyfin.org/docs/ - * YunoHost documentation: If specific documentation is needed, feel free to contribute. +* The app relies on YunoHost's LDAP server for users to log in: + * Standard users need the `main` permission; + * Users with the `admin` permission will have access to the administration panel. -## YunoHost specific features +* Starting version 10.7.5~ynh2, you can ask for the discovery ports (1900 and 7359) to be opened. +They ease the setting up of your media center between clients and server. + * If you are upgrading to this version and above, set `discovery: '1'` in `/etc/yunohost/apps/jellyfin/settings.yml` +if you want the upgrade to open them for you. -#### Multi-user support - * Are LDAP and HTTP auth supported? **Yes** - * Can the app be used by multiple users? **Yes** -#### Supported architectures +## Documentation and resources -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/jellyfin%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/jellyfin/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/jellyfin%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/jellyfin/) +* Official app website: https://jellyfin.org +* Official user documentation: https://jellyfin.org/docs/ -## Limitations - -* Any known limitations. - -## Additional information - -* Other info you would like to add about this app. - -## Links - - * Report a bug: https://github.com/YunoHost-Apps/jellyfin_ynh/issues - * App website: https://jellyfin.org/ - * Upstream app repository: https://github.com/jellyfin/jellyfin - * YunoHost website: https://yunohost.org/ - ---- +* Upstream app code repository: https://github.com/jellyfin/jellyfin +* YunoHost documentation for this app: https://yunohost.org/app_jellyfin +* Report a bug: https://github.com/YunoHost-Apps/jellyfin_ynh/issues ## Developer info @@ -69,3 +66,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/jellyfin_ynh/tree/tes or sudo yunohost app upgrade jellyfin -u https://github.com/YunoHost-Apps/jellyfin_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 66a499a..dddf777 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,63 +1,52 @@ # Jellyfin pour YunoHost -[![Niveau d'intégration](https://dash.yunohost.org/integration/jellyfin.svg)](https://dash.yunohost.org/appci/app/jellyfin) ![](https://ci-apps.yunohost.org/ci/badges/jellyfin.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/jellyfin.maintain.svg) -[![Installer Jellyfin avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=jellyfin) +[![Niveau d'intégration](https://dash.yunohost.org/integration/jellyfin.svg)](https://dash.yunohost.org/appci/app/jellyfin) ![](https://ci-apps.yunohost.org/ci/badges/jellyfin.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/jellyfin.maintain.svg) +[![Installer jellyfin avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=jellyfin) *[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* -> *Ce package vous permet d'installer Jellyfin 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.* +> *This package allows you to install jellyfin 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.* ## Vue d'ensemble -Jellyfin vous permet de collecter, gérer et diffuser vos médias. Exécutez le serveur Jellyfin sur votre système et accédez au principal système de divertissement à logiciel libre. -**Version incluse :** 10.7.5 +Système multimédia qui gère et diffuse vos médias. + +**Version incluse:** 10.7.5~ynh2 + +**Démo:** https://demo.jellyfin.org/stable/web/index.html + ## Captures d'écran -![](https://jellyfin.org/images/screenshots/movie_full.png) -## Démo + ![](./doc/screenshots/jellyfin.png) -* [Démo officielle](https://demo.jellyfin.org/) -## Configuration -Comment configurer cette application : via le panneau d'administration. -## Documentation +## Avertissements / informations importantes - * Documentation officielle : https://jellyfin.org/docs/ - * Documentation YunoHost : Si une documentation spécifique est nécessaire, n'hésitez pas à contribuer. +* L'app repose sur le serveur LDAP de YunoHost pour gérer les connexions: + * Les utilisateurs standards doivent avoir la permission `main` ; + * Les utilisateurs doivent avoir la permission `admin` pour pouvoir accéder au panneau d'administration. -## Caractéristiques spécifiques YunoHost +* À partir de la version 10.7.5~ynh2, vous pouvez demander l'ouverture des ports de découverte (1900 et 7359). +Ils facilitent la mise en place de votre système multimédia entre les clients et le serveur. + * Si vous mettez à jour vers cette version et les suivantes, mettez `discovery: '1'` dans `/etc/yunohost/apps/jellyfin/settings.yml` +si vous voulez que la mise à jour les ouvre pour vous. -#### 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 +## Documentations et ressources -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/jellyfin%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/jellyfin/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/jellyfin%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/jellyfin/) +* Site official de l'app : https://jellyfin.org +* Documentation officielle utilisateur: https://jellyfin.org/docs/ -## Limitations - -* Limitations connues. - -## Informations additionnelles - -* Autres informations que vous souhaitez ajouter sur cette application. - -## Liens - - * Signaler un bug : https://github.com/YunoHost-Apps/jellyfin_ynh/issues - * Site de l'application : https://jellyfin.org/ - * Dépôt de l'application principale : https://github.com/jellyfin/jellyfin - * Site web YunoHost : https://yunohost.org/ - ---- +* Dépôt de code officiel de l'app: https://github.com/jellyfin/jellyfin +* Documentation YunoHost pour cette app: https://yunohost.org/app_jellyfin +* Signaler un bug: https://github.com/YunoHost-Apps/jellyfin_ynh/issues ## Informations pour les développeurs @@ -66,6 +55,8 @@ Merci de faire vos pull request sur la [branche testing](https://github.com/Yuno Pour essayer la branche testing, procédez comme suit. ``` sudo yunohost app install https://github.com/YunoHost-Apps/jellyfin_ynh/tree/testing --debug -ou +or sudo yunohost app upgrade jellyfin -u https://github.com/YunoHost-Apps/jellyfin_ynh/tree/testing --debug ``` + +**Plus d'infos sur le packaging d'applications:** https://yunohost.org/packaging_apps \ No newline at end of file