diff --git a/README.md b/README.md index 16b67e3..4375847 100644 --- a/README.md +++ b/README.md @@ -1,62 +1,45 @@ + + # Jitsi Meet for YunoHost [![Integration level](https://dash.yunohost.org/integration/jitsi.svg)](https://dash.yunohost.org/appci/app/jitsi) ![](https://ci-apps.yunohost.org/ci/badges/jitsi.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/jitsi.maintain.svg) -[![Install Jitsi Meet with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=jitsi) +[![Install Jitsi Meet with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=jitsi) *[Lire ce readme en français.](./README_fr.md)* -> *This package allow you to install Jitsi Meet 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.* - -## Disclaimer - -**Jitsi** for YunoHost for now as some limitations: - * Can only be used using Chrome/Chromium - * Is limited to two participants - -Those limitations come from the packaging of the upstream app. Have to be improved. +> *This package allows you to install Jitsi Meet 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 + Jitsi Meet is a libre software (Apache) WebRTC JavaScript app that uses Jitsi Videobridge to provide high quality, secure, and scalable video conferences. -**Shipped version:** 1.0.4466 + +**Shipped version:** 1.0.4466~ynh1 + +**Demo:** https://meet.jit.si/ + +## Screenshots + +![](./doc/screenshots/screenshot.png) + +## Disclaimers / important information ## Important points before installing 1. **Jitsi** requires a dedicated **root domain**, eg. jitsi.domain.tld 2. **Jitsi** requires the ports TCP/4443 and UDP/10000 to be forwarded to your YunoHost (The same way you forwarded 80 (HTTP), 443 (HTTPS), etc... https://yunohost.org/#/isp_box_config) +3. **Jitsi** will stop and disable Metronome XMPP. +## Documentation and resources -## Screenshots - -![](https://jitsi.org/wp-content/uploads/2018/08/brady-bunch-stand-up-1024x632.jpg) - -## Demo - -* [Official demo](https://meet.jit.si/) - -## Configuration - -How to configure this app: Via the admin panel, a plain file with SSH, or any other way. - -## Documentation - - * Official documentation: https://jitsi.org/user-faq/ - -## YunoHost specific features - -#### Supported architectures - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/jitsi%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/jitsi/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/jitsi%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/jitsi/) - -## Links - - * Report a bug: https://github.com/YunoHost-Apps/jitsi_ynh/issues - * App website: https://jitsi.org/ - * Upstream app repository: https://github.com/jitsi/jitsi-meet - * YunoHost website: https://yunohost.org/ - ---- +* Official app website: https://jitsi.org/ +* Official user documentation: https://jitsi.org/user-faq/ +* Upstream app code repository: https://github.com/jitsi/jitsi-meet +* YunoHost documentation for this app: https://yunohost.org/app_jitsi +* Report a bug: https://github.com/YunoHost-Apps/jitsi_ynh/issues ## Developer info @@ -68,3 +51,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/jitsi_ynh/tree/testin or sudo yunohost app upgrade jitsi -u https://github.com/YunoHost-Apps/jitsi_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 db31ceb..19540d1 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,69 +1,43 @@ # Jitsi Meet pour YunoHost -## Avertissements -**Jitsi-meet** pour YunoHost est limité actuellement : - * Il ne peut être utilisé qu'avec Chrome ou un navigateur basé sur Chromium - * Il est limité à 2 participants par réunion - -Ces limitations viennent de la manière dont l'application a été empaquetée pour YunoHost. À améliorer. - [![Niveau d'intégration](https://dash.yunohost.org/integration/jitsi.svg)](https://dash.yunohost.org/appci/app/jitsi) ![](https://ci-apps.yunohost.org/ci/badges/jitsi.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/jitsi.maintain.svg) -[![Installer Jitsi Meet avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=jitsi) +[![Installer Jitsi Meet avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=jitsi) *[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* -> *Ce package vous permet d'installer Jitsi Meet 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 Jitsi Meet 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 + Jitsi Meet est un logiciel libre (Apache) dont Jitsi Videobridge, avec WebRTC Javascript, propose des vidéos-conférences de haute qualité, sécurisées et évolutives. -**Version actuelle :** 1.0.4466 + +**Version incluse :** 1.0.4466~ynh1 + +**Démo :** https://meet.jit.si/ + +## Captures d'écran + +![](./doc/screenshots/screenshot.png) + +## Avertissements / informations importantes ## Points importants à préparer avant l'installation 1. **Jitsi** a besoin d'un **domaine racine** dédié, par exemple : jitsi.domain.tld -2. **Jitsi** nécessite des domaines supplémentaires au niveau du DNS et de votre YunoHost - * auth.jitsi.domain.tld - * conference.jitsi.domain.tld - * jitsi-videobridge.jitsi.domain.tld - * focus.jitsi.domain.tld -3. **Jitsi** demande que les ports TCP/4443 et UDP/10000 soient routés vers votre YunoHost (De la même manière que le sont les ports 80 (HTTP), 443 (HTTPS), etc... https://yunohost.org/#/isp_box_config) +2. **Jitsi** demande que les ports TCP/4443 et UDP/10000 soient routés vers votre YunoHost (De la même manière que le sont les ports 80 (HTTP), 443 (HTTPS), etc... https://yunohost.org/#/isp_box_config) +3. **Jitsi** va arréter et désactiver le service XMPP Metronome. +## Documentations et ressources -## Captures d'écran +* Site officiel de l'app : https://jitsi.org/ +* Documentation officielle utilisateur : https://jitsi.org/user-faq/ +* Dépôt de code officiel de l'app : https://github.com/jitsi/jitsi-meet +* Documentation YunoHost pour cette app : https://yunohost.org/app_jitsi +* Signaler un bug : https://github.com/YunoHost-Apps/jitsi_ynh/issues -![](https://jitsi.org/wp-content/uploads/2018/08/brady-bunch-stand-up-1024x632.jpg) - -## Démo - -* [Démo officielle](https://meet.jit.si/) - -## Configuration - -Comment configurer cette application: via le panneau d'administration, un fichier brut en SSH ou tout autre moyen. - -## Documentation - - * Documentation officielle : https://jitsi.org/user-faq/ - -## Caractéristiques spécifiques YunoHost - -#### Architectures supportées - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/jitsi%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/jitsi/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/jitsi%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/jitsi/) - -## Liens - - * Signaler un bug: https://github.com/YunoHost-Apps/jitsi_ynh/issues - * Site de l'application: https://jitsi.org/ - * Dépôt de l'application principale: https://github.com/jitsi/jitsi-meet - * Site web YunoHost: https://yunohost.org/ - ---- - -Informations pour les développeurs ----------------- +## Informations pour les développeurs Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/jitsi_ynh/tree/testing). @@ -73,3 +47,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/jitsi_ynh/tree/testin ou sudo yunohost app upgrade jitsi -u https://github.com/YunoHost-Apps/jitsi_ynh/tree/testing --debug ``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file