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

Update Docs

This commit is contained in:
Krakinou 2024-01-22 23:13:37 +01:00
parent dfb4319859
commit 41f964cc35
5 changed files with 34 additions and 17 deletions

View file

@ -1,6 +1,4 @@
## Configuration ## Broker Mosquitto
### Broker Mosquitto
During installation, a [MQTT](https://en.wikipedia.org/wiki/MQTT) broker, [Mosquitto](https://mosquitto.org/), is installed at the same time as Domoticz. During installation, a [MQTT](https://en.wikipedia.org/wiki/MQTT) broker, [Mosquitto](https://mosquitto.org/), is installed at the same time as Domoticz.
This broker requires a dedicated domain or subdomain to work (ex : mqtt.your.domain.tld): creating this domain prior installation is a prerequisite This broker requires a dedicated domain or subdomain to work (ex : mqtt.your.domain.tld): creating this domain prior installation is a prerequisite
@ -90,6 +88,11 @@ allow ::/1;
This will authorized only IPv4 within local network to access your Domoticz API. This will authorized only IPv4 within local network to access your Domoticz API.
You may add individual IPv6 address in the same way. You may add individual IPv6 address in the same way.
## Upgrades
Upgrades from inside the application have been disabled. Well, in fact I just hide the link, so you can still upgrade using the command line if you know how to do it. This is to avoid some unexpected upgrade that may break the YunoHost integration, such as the mandatory user management from 2023.1.
## Limitations ## Limitations
* Backup cannot be restored on a different machine type (arm, x86...) as compiled sources are different * Backup cannot be restored on a different machine type (arm, x86...) as compiled sources are different
* LDAP is not supported by the upstream app

View file

@ -1,6 +1,4 @@
## Configuration ## Broker MQTT Mosquitto
### Broker MQTT Mosquitto
À l'installation, un broker [MQTT](https://fr.wikipedia.org/wiki/MQTT), [Mosquitto](https://mosquitto.org/), est installé en même temps que Domoticz. À l'installation, un broker [MQTT](https://fr.wikipedia.org/wiki/MQTT), [Mosquitto](https://mosquitto.org/), est installé en même temps que Domoticz.
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. 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.
@ -91,6 +89,12 @@ allow ::/1;
Ceci autorisera seulement les adresses IPv4 local a accéder aux API de Domoticz. Ceci autorisera seulement les adresses IPv4 local a accéder aux API de Domoticz.
Vous pouvez ajouter des adresses IPv6 de la même façon. Vous pouvez ajouter des adresses IPv6 de la même façon.
## Mise à jours
Les mises à jours depuis l'application ont été désactivées. Bon, en vrai, c'est juste le lien qui est caché, vous pouvez donc en fait toujours faire la mise à jour depuis la ligne de commande si vous savez comment faire. Ceci permet d'éviter certaines mises à jour qui peuvent casser l'intégration avec YunoHost, tel que l'obligation de créer des users depuis la 2023.1.
## Limitations ## Limitations
* 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 * 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
* Pas de gestion du LDAP dans l'application

View file

@ -1,10 +0,0 @@
###
BEWARE! If you did not activate the Mosquitto Broker within this package, please run following command prior to upgrade:
````yunohost app setting $app mqtt_domain -v your.$app.domain.tld````
Failure to do so may break the app.
If you did activate the Mosquitto broker, you can proceed safely.
###Changelog
- Move to packaging v2
- From now on, upgrade of the upstream app will not be handled into the app anymore: a new package version will be published for a new Domoticz version. Internal upgrade is disabled (although you may still use the command line)
- Upgrade to 2024.2

View file

@ -0,0 +1,10 @@
###
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````
Failure to do so may break the app.
If you did activate the Mosquitto broker, you can proceed safely.
###Version 2024.2
This update to 2024.2 brings a few changes in the package:
- Move to packaging V2: This will move the app folder from `/opt/yunohost/__APP__` to `/var/www/__APP__`. This should not cause any trouble to Domoticz, but some plugins may not like it.For example, Zigbee4Domoticz requires to edit config file in `/var/www/__APP__/plugins/Domoticz-Zigbee/Conf/PluginConf-08.json` to set the correct path in it.
- Since 2024.1, Domoticz provides precompiled binaries for each of the version on the project Github. while previously only the last version was available to download. So upgrades from inside the application have been disabled. This will allow a better integration in YunoHost but requires to prevent as much as possible upgrade from inside the app. From now on, a new package version will be published after each Domoticz update.

View file

@ -0,0 +1,10 @@
###
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````
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.
### Version 2024.2
La mise à jour vers la 2024.2 a amené beaucoup de changements dans le package:
- Passage en packaging V2 : Ceci entraine le déplacement de l'application de `/opt/yunohost/__APP__` vers `/var/www/__APP__`. Normalement cela ne pose pas de problèmes à Domoticz mais certain plugins peuvent ne pas apprécier. Par exemple Zigbee4Domoticz nécessite dans ce cas d'éditer le fichier de configuration de `/var/www/__APP__/plugins/Domoticz-Zigbee/Conf/PluginConf-08.json` pour y remettre les chemins corrects.
- Domoticz fourni depuis la 2024.1 les binaires compilés pour chacune des version sur sa page Github, contrairement aux version précédentes dont seule la dernière version était téléchargeable. Donc les mises à jours depuis l'application ont été désactivées. Ceci permet de mieux intégrer Domoticz dans Yunohost mais nécessite d'empecher autant que possible les mises à jours depuis l'application. Dorénavant, une nouvelle version du package sera donc publié après chaque mise à jour de Domoticz.