From 5e361d20e6ec339a3b1327d8fbde67e33402bb29 Mon Sep 17 00:00:00 2001 From: Krakinou Date: Sat, 20 Jan 2024 18:18:39 +0100 Subject: [PATCH] Documentation update --- doc/ADMIN_fr.md | 4 ++-- doc/DESCRIPTION.md | 4 ++-- doc/DESCRIPTION_fr.md | 4 ++-- doc/POST_INSTALL_fr.md | 6 ------ doc/POST_INTALL.md | 7 ------- doc/PRE_INSTALL.md | 6 +----- doc/PRE_INSTALL_fr.md | 5 ----- 7 files changed, 7 insertions(+), 29 deletions(-) diff --git a/doc/ADMIN_fr.md b/doc/ADMIN_fr.md index 034ee7e..b437195 100644 --- a/doc/ADMIN_fr.md +++ b/doc/ADMIN_fr.md @@ -7,7 +7,7 @@ Ce broker nécessite un domaine ou un sous-domaine particulier pour fonctionner #### Ajout dans Domoticz -Pour pouvoir l'utiliser, vous devez paramétrer la communication avec entre domoticz et le broker en suivant la [documentation de Domoticz](https://www.domoticz.com/wiki/MQTT#Installing_Mosquitto) dans la partie *Add hardware "MQTT Client Gateway"* +Pour pouvoir l'utiliser, vous devez paramétrer la communication avec entre Domoticz et le broker en suivant la [documentation de Domoticz](https://www.domoticz.com/wiki/MQTT#Installing_Mosquitto) dans la partie *Add hardware "MQTT Client Gateway"* Les users et mot de passe du broker sont automatiquement générés lors de l'installation. Vous pouvez les récupérer avec ```` sudo yunohost app setting domoticz mqtt_user @@ -40,7 +40,7 @@ Si vous souhaitez ouvrir le protocole MQTT depuis l'extérieur afin de pouvoir l -#### Mise à jour depuis les versions n'ayant pas Mosquittoo +#### Mise à jour depuis les versions n'ayant pas Mosquitto Si vous êtes sur le package 2020.2~ynh3 ou inférieur, Mosquitto n'est pas installé par défaut. De même si vous avez choisi de ne pas indiquer de domaine pour Mosquitto lors de l'installation initiale. Pour pouvoir l'installer après coup, faites les actions suivantes : diff --git a/doc/DESCRIPTION.md b/doc/DESCRIPTION.md index 1260245..0df7708 100644 --- a/doc/DESCRIPTION.md +++ b/doc/DESCRIPTION.md @@ -12,5 +12,5 @@ For example this system can be used with: * And more... -The MQTT broker Mosquitto is integrated into the package. It requires its own domain or subdomain. It's an optional setting: during install if you set the same domaine as your main app domain, it won't be installed. -You may also install the Mosquitto package without using the one provided by domoticz_ynh. \ No newline at end of file +The MQTT broker Mosquitto is integrated into the package and requires its own domain or subdomain. It's an optional setting: during install if you set the same domain as your main app domain, it won't be installed. +You may also install the [Mosquitto package](https://github.com/YunoHost-Apps/mosquitto_ynh) without using the one provided by domoticz_ynh. \ No newline at end of file diff --git a/doc/DESCRIPTION_fr.md b/doc/DESCRIPTION_fr.md index 1cafb0b..5d030f0 100644 --- a/doc/DESCRIPTION_fr.md +++ b/doc/DESCRIPTION_fr.md @@ -11,7 +11,7 @@ Il peut par exemple être utilisé avec : * des voltmètres * Et bien d'autres -Le broker MQTT Mosquitto est intégré au package et nécessite un sous-domaine ou un domaine distinct. Il est optionnel et si vous indiquez lors de l'installation le même domaine que le domaine principal, il ne sera pas installé. -Vous pouvez également installer le package pour Mosquitto sans utiliser celui de domoticz_ynh. +Le broker MQTT Mosquitto est intégré au package et nécessite un sous-domaine ou un domaine distinct. Il est optionnel : si vous indiquez lors de l'installation le même domaine que le domaine principal, il ne sera pas installé. +Vous pouvez également installer le [package pour Mosquitto](https://github.com/YunoHost-Apps/mosquitto_ynh) sans utiliser celui de domoticz_ynh. diff --git a/doc/POST_INSTALL_fr.md b/doc/POST_INSTALL_fr.md index d741f8b..51236ed 100644 --- a/doc/POST_INSTALL_fr.md +++ b/doc/POST_INSTALL_fr.md @@ -6,9 +6,3 @@ Les users et mot de passe du broker Mosquitto sont automatiquement générés lo sudo yunohost app setting domoticz mqtt_user sudo yunohost app setting domoticz mqtt_pwd ```` - -### Recommandations - -Il est conseillé de ne pas rendre l'application publique en dehors du SSO YunoHost (public = oui à l'installation ou mettre la permission Domoticz à 'Visiteurs' dans le panel d'administration YunoHost). Si pour quelques raisons que ce soit, vous deviez le faire, je vous recommande : - - d'activer la sécurité de connexion à Domoticz (plutôt avec la login page qu'avec la basic-auth) - - Dans *Configuration/Système/Réseaux Locaux (pas d'authentification)* d'entrer les adresses du proxy NGINX (cela devrait être "::1;127.0.0.1" dans une installation Yunohost Standard) afin que Fail2Ban puisse bloquer les tentatives de connexions (voir les dernières lignes de [ce wiki](https://www.domoticz.com/wiki/WebServer_Proxy) \ No newline at end of file diff --git a/doc/POST_INTALL.md b/doc/POST_INTALL.md index 886bfb1..b0751fb 100644 --- a/doc/POST_INTALL.md +++ b/doc/POST_INTALL.md @@ -6,10 +6,3 @@ User and password for Mosquitto broker are automatically generated during instal sudo yunohost app setting domoticz mqtt_user sudo yunohost app setting domoticz mqtt_pwd ```` - - -### Recommandation - -It is advisable to not make the app publicly available outside of the YunoHost SSO (public = yes at install or setting the Domoticz permission to 'visitors' in the admin panel). If for any reason you need to, I recommend the following: - - Activate the website protection/user management (with login page instead of Basic-auth) - - In *Setup/Settings/System/Local Networks (no username/password)* enter the address of the NGINX proxy (should be "::1;127.0.0.1" in any standard YunoHost installation) so that the Fail2Ban settings is active (see last lines of [this wiki](https://www.domoticz.com/wiki/WebServer_Proxy) \ No newline at end of file diff --git a/doc/PRE_INSTALL.md b/doc/PRE_INSTALL.md index 12a74b8..aca87ed 100644 --- a/doc/PRE_INSTALL.md +++ b/doc/PRE_INSTALL.md @@ -1,8 +1,4 @@ ## Mosquitto Broker -During installation, a [MQTT](https://en.wikipedia.org/wiki/MQTT) broker, [Mosquitto](https://mosquitto.org/), may be installed at the same time as Domoticz. It's an optional setting: during install if you set the same domaine as your main app domain, it won't be installed. +During installation, a [MQTT](https://en.wikipedia.org/wiki/MQTT) broker, [Mosquitto](https://mosquitto.org/), may be installed at the same time as Domoticz. It's an optional setting: during install if you set the same domain as your main app domain, it won't be installed. This broker requires a dedicated domain or subdomain to work (ex: mqtt.your.domain.tld) : creating this domain prior installation is a prerequisite. - -## Installed Version - -For now, Domoticz project does not (yet) provide compiled binaries for each release. So, the installed release is a precompiled version from a [project fork](https://github.com/Krakinou/domoticz_build_on_arch). The source code is exactly the same as the original version. diff --git a/doc/PRE_INSTALL_fr.md b/doc/PRE_INSTALL_fr.md index ec953ef..3a91d2a 100644 --- a/doc/PRE_INSTALL_fr.md +++ b/doc/PRE_INSTALL_fr.md @@ -2,8 +2,3 @@ À l'installation, un broker [MQTT](https://fr.wikipedia.org/wiki/MQTT), [Mosquitto](https://mosquitto.org/), peut être installé en même temps que Domoticz. Il est optionnel et si vous indiquez lors de l'installation le même domaine que le domaine principal, il ne sera pas installé. Ce broker nécessite un domaine ou un sous-domaine particulier pour fonctionner (ex : mqtt.your.domain.tld) : il est nécessaire de créer ce domaine auparavant. - - -## Version installée - -Actuellement, le projet Domoticz ne fournit pas (encore) ses sources compilées par version. La version installée est donc une version compilée sur un [fork du projet](https://github.com/Krakinou/domoticz_build_on_arch). Le code source est celui de la version correspondante de domoticz. \ No newline at end of file