From 081e321bde9cb9910dc0b201ed4fad3763829c66 Mon Sep 17 00:00:00 2001 From: Krakinou Date: Fri, 30 Dec 2022 13:45:08 +0100 Subject: [PATCH] update documentation --- doc/DESCRIPTION.md | 7 ++----- doc/DESCRIPTION_fr.md | 7 ++----- doc/DISCLAIMER_fr.md | 6 +++--- 3 files changed, 7 insertions(+), 13 deletions(-) diff --git a/doc/DESCRIPTION.md b/doc/DESCRIPTION.md index 28d41cf..215178f 100644 --- a/doc/DESCRIPTION.md +++ b/doc/DESCRIPTION.md @@ -81,9 +81,9 @@ Once installed, just follow instructions from the [wiki](https://www.domoticz.co By default, access for the [JSON API](https://www.domoticz.com/wiki/Domoticz_API/JSON_URL's) is allowed on following path `/yourdomain.tld/api_/domoticzpath`. So if you access domoticz via https://mydomainname.tld/domoticz, use the following webpath for the api : `/mydomainname.tld/api_/domoticz/json.htm?yourapicommand` -By default, only sensor updates and switch toogle are authorized. To authorized a new command, you have (for now) to manually update the nginx config file : +By default, only sensor updates and switch toogle are authorized. To authorized a new command, you have to manually update the nginx config file : ```` -sudo nano /etc/nginx/conf.d/yourdomain.tld.d/domoticz.conf +sudo nano /etc/nginx/conf.d/yourdomain.tld.d/api_domoticz.conf ```` Then edit the following block by adding the regex of the command you want to allow: ```` @@ -96,9 +96,6 @@ Then edit the following block by adding the regex of the command you want to all ```` For example, to add the json command to retrieve the status of a device (/json.htm?type=devices&rid=IDX),modify the line as this: ```` - #set the list of authorized json command here in regex format - #you may retrieve the command from https://www.domoticz.com/wiki/Domoticz_API/JSON_URL's - #By default, sensors updates and toggle switch are authorized if ( $args ~* type=command¶m=udevice&idx=[0-9]*&nvalue=[0-9]*&svalue=.*$|type=command¶m=switchlight&idx=[0-9]*&switchcmd=Toggle$|type=devices&rid=[0-9]* ) { set $api "1"; } diff --git a/doc/DESCRIPTION_fr.md b/doc/DESCRIPTION_fr.md index b350735..f87a128 100644 --- a/doc/DESCRIPTION_fr.md +++ b/doc/DESCRIPTION_fr.md @@ -80,9 +80,9 @@ Une fois installé, suivez simplement les indications du [wiki](https://www.domo Par défaut, l'accès aux [API JSON](https://www.domoticz.com/wiki/Domoticz_API/JSON_URL's) est autorisé sur cette URL `/votredomaine.tld/api_/chemindedomoticz`. Donc, si vous accédez à domoticz par https://votredomaine.tld/domoticz, utilisez le chemin suivant pour l'api: `/votredomaine.tld/api_/domoticz/json.htm?votrecommandeapi` -Par défaut, seule la mise à jour de senseur et les interrupteurs sont autorisés. Pour autoriser une nouvelle commande, vous devez (pour l'instant) manuellement éditer le fichier de configuration nginx : +Par défaut, seule la mise à jour de senseur et les interrupteurs sont autorisés. Pour autoriser une nouvelle commande, vous devez manuellement éditer le fichier de configuration nginx : ```` -sudo nano /etc/nginx/conf.d/yourdomain.tld.d/domoticz.conf +sudo nano /etc/nginx/conf.d/yourdomain.tld.d/api_domoticz.conf ```` Puis éditer le bloc suivant en y ajoutant le regex de la commmande à autoriser : ```` @@ -95,9 +95,6 @@ Puis éditer le bloc suivant en y ajoutant le regex de la commmande à autoriser ```` Par exemple, pour ajouter la commmande json pour retrouver le statut d'un équipement (/json.htm?type=devices&rid=IDX),il faut modifier la ligne comme ceci: ```` - #set the list of authorized json command here in regex format - #you may retrieve the command from https://www.domoticz.com/wiki/Domoticz_API/JSON_URL's - #By default, sensors updates and toggle switch are authorized if ( $args ~* type=command¶m=udevice&idx=[0-9]*&nvalue=[0-9]*&svalue=.*$|type=command¶m=switchlight&idx=[0-9]*&switchcmd=Toggle$|type=devices&rid=[0-9]* ) { set $api "1"; } diff --git a/doc/DISCLAIMER_fr.md b/doc/DISCLAIMER_fr.md index 368dd82..baca40c 100644 --- a/doc/DISCLAIMER_fr.md +++ b/doc/DISCLAIMER_fr.md @@ -2,14 +2,14 @@ ## Limitations * Pas de gestion d'utilisateurs ni d'intégration LDAP. L'application ne [prévoit pas de gérer les utilisateurs par LDAP](https://github.com/domoticz/domoticz/issues/838), donc le package non plus. -* Un backup ne peut pas être restauré sur un type de machine différente de celle d'origine (x86, arm...) car les sources compilées doivent être différentes +* Un backup ne peut pas être restauré sur un type de machine différente de celle d'origine (x86, arm...) car les sources compilées sont différentes ## A propos de la sécurité -Bien que vous pouviez activer une page de connexion dans l'application (soit depuis le menu *Configuration/Paramètres/Système/Sécurité* ou depuis *Configuration/Plus d'options/Gérer les utilisateurs*), les fonctionnalités ne semblent pas très avancées et safe pour l'instant (version 2022.2 au moment d'écrire). Un travail a été entrepris pour renforcer la sécurité ([voir ici](https://www.domoticz.com/wiki/Security)) dans les versions futures mais n'a pas encore été released. +Bien que vous pouviez activer une page de connexion dans l'application (soit depuis le menu *Configuration/Paramètres/Système/Sécurité* ou depuis *Configuration/Plus d'options/Gérer les utilisateurs*), les fonctionnalités ne semblent pas très avancées ni safe pour l'instant (version 2022.2 au moment d'écrire). Un travail a été entrepris pour renforcer la sécurité ([voir ici](https://www.domoticz.com/wiki/Security)) dans les versions futures mais n'a pas encore été released. ### recommandations -Il semble conseillé de ne pas rendre l'application publique en dehors du sso yunohost (public = oui à l'installaiton 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: +Il semble 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 (plutot 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