From bc4e605783d5be153469a2d29288dc444e4f71d9 Mon Sep 17 00:00:00 2001 From: yunohost-bot Date: Sun, 19 Jun 2022 23:41:52 +0000 Subject: [PATCH] Auto-update README --- README.md | 55 +++++++++++++++++++------------------------------- README_fr.md | 57 ++++++++++++++++++++-------------------------------- 2 files changed, 43 insertions(+), 69 deletions(-) diff --git a/README.md b/README.md index 87bb290..a6faeba 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,11 @@ -# Mosquitto (MQTT Broker) for YunoHost + -[![Integration level](https://dash.yunohost.org/integration/mosquitto.svg)](https://dash.yunohost.org/appci/app/mosquitto) -![](https://ci-apps.yunohost.org/ci/badges/mosquitto.status.svg) -![](https://ci-apps.yunohost.org/ci/badges/mosquitto.maintain.svg) +# Mosquitto for YunoHost +[![Integration level](https://dash.yunohost.org/integration/mosquitto.svg)](https://dash.yunohost.org/appci/app/mosquitto) ![Working status](https://ci-apps.yunohost.org/ci/badges/mosquitto.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/mosquitto.maintain.svg) [![Install Mosquitto with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=mosquitto) *[Lire ce readme en français.](./README_fr.md)* @@ -15,50 +17,35 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in [Mosquitto](https://mosquitto.org/) gives you interconnect your objects and applications with an open source MQTT broker. Client can publish or subscribe after authentication (username, password). -**Shipped version:** 2.0.8 -## Configuration +**Shipped version:** 2.0.8~ynh1 -How to configure this app: From an admin panel or a plain file with SSH. +**Demo:** https://demo.example.com +## Disclaimers / important information -## Documentation +## TODO - * Official documentation: https://mosquitto.org/documentation/ +- [ ] Add MQTTS (MQTT with TLS) -## YunoHost specific features +## Documentation and resources -#### Multi-user support - - * Are LDAP and HTTP auth supported? **No** - * Can the app be used by multiple users? **No** - -#### Supported architectures - - * x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/mosquitto.svg)](https://ci-apps.yunohost.org/ci/apps/mosquitto/) - * ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/mosquitto.svg)](https://ci-apps-arm.yunohost.org/ci/apps/mosquitto/) - -## Links - - * Report a bug: https://github.com/YunoHost-Apps/mosquitto_ynh/issues - * App website: https://mosquitto.org/ - * Upstream app repository: https://github.com/eclipse/mosquitto - * YunoHost website: https://yunohost.org/ - ---- +* Official app website: +* Official user documentation: +* Official admin documentation: +* Upstream app code repository: +* YunoHost documentation for this app: +* Report a bug: ## Developer info Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/mosquitto_ynh/tree/testing). To try the testing branch, please proceed like that. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/mosquitto_ynh/tree/testing --debug or sudo yunohost app upgrade mosquitto -u https://github.com/YunoHost-Apps/mosquitto_ynh/tree/testing --debug ``` ---- - -## Todo - -- [ ] Add MQTTS (MQTT with TLS) +**More info regarding app packaging:** diff --git a/README_fr.md b/README_fr.md index b3b03f8..d40cfc8 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,64 +1,51 @@ -# Mosquitto (broker MQTT) pour YunoHost + -[![Niveau d'intégration](https://dash.yunohost.org/integration/mosquitto.svg)](https://dash.yunohost.org/appci/app/mosquitto) -![](https://ci-apps.yunohost.org/ci/badges/mosquitto.status.svg) -![](https://ci-apps.yunohost.org/ci/badges/mosquitto.maintain.svg) +# Mosquitto pour YunoHost +[![Niveau d'intégration](https://dash.yunohost.org/integration/mosquitto.svg)](https://dash.yunohost.org/appci/app/mosquitto) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/mosquitto.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/mosquitto.maintain.svg) [![Installer Mosquitto avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=mosquitto) *[Read this readme in english.](./README.md)* > *Ce package vous permet d'installer Mosquitto 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 [Mosquitto](https://mosquitto.org/) vous permet d'interconnecter vos objets et applications avec un broker MQTT open source. Le client peut publier ou s'abonner après authentification (nom d'utilisateur, mot de passe). -**Version incluse :** 2.0.8 -## Configuration +**Version incluse :** 2.0.8~ynh1 -Comment configurer cette application : via le panneau d'administration ou un fichier brut en SSH. +**Démo :** https://demo.example.com +## Avertissements / informations importantes -## Documentation +## A faire - * Documentation officielle : https://mosquitto.org/documentation/ +- [ ] Ajouter MQTTS (MQTT avec TLS) -## Caractéristiques spécifiques YunoHost +## Documentations et ressources -#### Support multi-utilisateur - - * L'authentification LDAP et HTTP est-elle prise en charge ? **Non** - * L'application peut-elle être utilisée par plusieurs utilisateurs ? **Non** - -#### Architectures supportées - - * x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/mosquitto.svg)](https://ci-apps.yunohost.org/ci/apps/mosquitto/) - * ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/mosquitto.svg)](https://ci-apps-arm.yunohost.org/ci/apps/mosquitto/) - -## Liens - - * Signaler un bug : https://github.com/YunoHost-Apps/mosquitto_ynh/issues - * Site de l'application : https://mosquitto.org/ - * Dépôt de l'application principale : https://github.com/eclipse/mosquitto - * Site web YunoHost : https://yunohost.org/ - ---- +* Site officiel de l'app : +* Documentation officielle utilisateur : +* Documentation officielle de l'admin : +* Dépôt de code officiel de l'app : +* Documentation YunoHost pour cette app : +* Signaler un bug : ## Informations pour les développeurs Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/mosquitto_ynh/tree/testing). Pour essayer la branche testing, procédez comme suit. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/mosquitto_ynh/tree/testing --debug ou sudo yunohost app upgrade mosquitto -u https://github.com/YunoHost-Apps/mosquitto_ynh/tree/testing --debug ``` ---- - -## A faire - -- [ ] Ajouter MQTTS (MQTT avec TLS) +**Plus d'infos sur le packaging d'applications :**