YunoHost-Apps/domoticz_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/domoticz_ynh.git synced 2024-09-03 18:26:17 +02:00
Code Issues Activity Actions

Update doc

Browse source
This commit is contained in:
Krakinou 2024-01-22 23:22:25 +01:00
parent 41f964cc35
commit 7a1ac74e7b
6 changed files with 16 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
doc/ADMIN.md
View file

@ -9,8 +9,8 @@ You may also install the [Mosquitto package](https://github.com/YunoHost-Apps/mo
To use Mosquitto, you need to customize the communication between Domoticz and the broker by following the [domoticz documentation](https://www.domoticz.com/wiki/MQTT#Installing_Mosquitto), part *Add hardware "MQTT Client Gateway"*. To use Mosquitto, you need to customize the communication between Domoticz and the broker by following the [domoticz documentation](https://www.domoticz.com/wiki/MQTT#Installing_Mosquitto), part *Add hardware "MQTT Client Gateway"*.
User and password are automatically generated during installation, you may retrieve them with User and password are automatically generated during installation, you may retrieve them with
```` ````
sudo yunohost app setting domoticz mqtt_user sudo yunohost app setting __APP__ mqtt_user
sudo yunohost app setting domoticz mqtt_pwd sudo yunohost app setting __APP__ mqtt_pwd
```` ````
#### Publish/Subscribe #### Publish/Subscribe
@ -43,9 +43,9 @@ If you have package 2020.2~ynh3 or below or if you have chosen to not set a doma
If you need to activate mosquitto in retrospect, do following actions: If you need to activate mosquitto in retrospect, do following actions:
1. Create a domain or a subdomain (for example: 'mqtt.your.domain.tld') 1. Create a domain or a subdomain (for example: 'mqtt.your.domain.tld')
2. Connect to your server in command line 2. Connect to your server in command line
3. Type following command : `yunohost app setting domoticz mqtt_domain -v mqtt.your.domain.tld` 3. Type following command : `yunohost app setting __APP__ mqtt_domain -v mqtt.your.domain.tld`
4. Upgrade Domoticz to last package. 4. Upgrade Domoticz to last package.
If you're already on the last package version, use the following command: `yunohost app upgrade domoticz --force` If you're already on the last package version, use the following command: `yunohost app upgrade __APP__ --force`
## Configuration ## Configuration
@ -62,7 +62,7 @@ So if you access Domoticz via https://mydomainname.tld/domoticz, use the followi
By default, only sensor updates and switch toogle are authorized. To authorized a new command, you have 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/api_domoticz.conf sudo nano /etc/nginx/conf.d/yourdomain.tld.d/api___APP__.conf
```` ````
Then edit the following block by adding the regex of the command you want to allow: Then edit the following block by adding the regex of the command you want to allow:
```` ````

10
doc/ADMIN_fr.md
View file

@ -9,8 +9,8 @@ Vous pouvez également installer le [package pour Mosquitto](https://github.com/
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 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 sudo yunohost app setting __APP__ mqtt_user
sudo yunohost app setting domoticz mqtt_pwd sudo yunohost app setting __APP__ mqtt_pwd
```` ````
#### Publier/souscrire #### Publier/souscrire
@ -45,9 +45,9 @@ De même si vous avez choisi de ne pas indiquer de domaine pour Mosquitto lors d
Pour pouvoir l'installer après coup, faites les actions suivantes : Pour pouvoir l'installer après coup, faites les actions suivantes :
1. créez un domaine ou sous-domaine pour recevoir les informations (par exemple : 'mqtt.your.domain.tld') 1. créez un domaine ou sous-domaine pour recevoir les informations (par exemple : 'mqtt.your.domain.tld')
2. connecter vous en ligne de commande à votre serveur 2. connecter vous en ligne de commande à votre serveur
3. taper la commande suivante : `yunohost app setting domoticz mqtt_domain -v mqtt.your.domain.tld` 3. taper la commande suivante : `yunohost app setting __APP__ mqtt_domain -v mqtt.your.domain.tld`
4. Procédez à la mise à jour. 4. Procédez à la mise à jour.
Si vous êtes déjà sur la dernière version, utiliser la commmande suivante : `yunohost app upgrade domoticz --force` Si vous êtes déjà sur la dernière version, utiliser la commmande suivante : `yunohost app upgrade __APP__ --force`
### Senseurs, langue et ce genre de choses ### Senseurs, langue et ce genre de choses
@ -63,7 +63,7 @@ Donc, si vous accédez à Domoticz par https://votredomaine.tld/domoticz, utilis
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 : 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/api_domoticz.conf sudo nano /etc/nginx/conf.d/yourdomain.tld.d/api___APP__.conf
```` ````
Puis éditer le bloc suivant en y ajoutant le regex de la commmande à autoriser : Puis éditer le bloc suivant en y ajoutant le regex de la commmande à autoriser :
```` ````

4
doc/POST_INSTALL_fr.md
View file

@ -3,6 +3,6 @@
L'utilisateur *admin* et le mot de passe *domoticz* vous permettront d'accéder au système. Il est bien évidemment recommandé de les modifier immédiatement. L'utilisateur *admin* et le mot de passe *domoticz* vous permettront d'accéder au système. Il est bien évidemment recommandé de les modifier immédiatement.
Les users et mot de passe du broker Mosquitto sont automatiquement générés lors de l'installation. Vous pouvez les récupérer avec Les users et mot de passe du broker Mosquitto sont automatiquement générés lors de l'installation. Vous pouvez les récupérer avec
```` ````
sudo yunohost app setting domoticz mqtt_user sudo yunohost app setting __APP__ mqtt_user
sudo yunohost app setting domoticz mqtt_pwd sudo yunohost app setting __APP__ mqtt_pwd
```` ````

4
doc/POST_INTALL.md
View file

@ -3,6 +3,6 @@
User *admin* with password *domoticz* allow you to access the system. Of course, you should change them immediately. User *admin* with password *domoticz* allow you to access the system. Of course, you should change them immediately.
User and password for Mosquitto broker are automatically generated during installation, you may retrieve them with User and password for Mosquitto broker are automatically generated during installation, you may retrieve them with
```` ````
sudo yunohost app setting domoticz mqtt_user sudo yunohost app setting __APP__ mqtt_user
sudo yunohost app setting domoticz mqtt_pwd sudo yunohost app setting __APP__ mqtt_pwd
```` ````

2
doc/PRE_UPGRADE.d/2024.2~ynh1.md
View file

@ -1,6 +1,6 @@
### ###
BEWARE! If you did not activate the Mosquitto Broker within this package, please run following command prior to upgrade: BEWARE! If you did not activate the Mosquitto Broker within this package, please run following command prior to upgrade:
````sudo yunohost app setting $app mqtt_domain -v your.__APP__.domain.tld```` ````sudo yunohost app setting __APP__ mqtt_domain -v your.__APP__.domain.tld````
Failure to do so may break the app. Failure to do so may break the app.
If you did activate the Mosquitto broker, you can proceed safely. If you did activate the Mosquitto broker, you can proceed safely.

2
doc/PRE_UPGRADE.d/2024.2~ynh1_fr.md
View file

@ -1,6 +1,6 @@
### ###
ATTENTION! Si vous n'avez pas activer l'option du Broker Mosquitto de ce package, veuillez entrer la commande suivante avant de faire cette mise à jour: ATTENTION! Si vous n'avez pas activer l'option du Broker Mosquitto de ce package, veuillez entrer la commande suivante avant de faire cette mise à jour:
````sudo yunohost app setting $app mqtt_domain -v your.__APP__.domain.tld```` ````sudo yunohost app setting __APP__ mqtt_domain -v your.__APP__.domain.tld````
Dans le cas contraire, vous risquez de complètement casser l'application. Dans le cas contraire, vous risquez de complètement casser l'application.
Si par contre vous avez activer le broker, Mosquitto, vous pouvez procéder à la mise à jour sans soucis. Si par contre vous avez activer le broker, Mosquitto, vous pouvez procéder à la mise à jour sans soucis.