release: prepare arkteos proxy addon 1.0.0

README.md

@@ -2,17 +2,22 @@
 
 Proxy TCP pour PAC Arkteos REG3 (Zuran 4, Baguio 4, etc.).
 
-Permet les connexions simultanées de Node-RED et de l'application mobile Arkteos, en relayant le flux binaire de la PAC vers tous les clients connectés.
+Permet les connexions simultanées de Node-RED et de l'application mobile Arkteos, en maintenant une connexion TCP unique vers la PAC et en distribuant son flux binaire aux clients connectés. Les écritures des clients vers la PAC sont désactivées par défaut.
 
 ## Installation
 
 1. Dans Home Assistant : **Paramètres → Modules complémentaires → trois points → Dépôts**
-2. Ajoute l'URL de ce repo : `https://github.com/raph666/arkteos-proxy-addon`
+2. Ajoute l'URL de ce repo : `https://gitea.i-host.fr/raph666/arkteos-proxy-addon`
 3. Installe l'addon **Arkteos Proxy**
 4. Configure l'IP de ta PAC dans les options
 5. Configure le port exposé dans la section **Network** (défaut : 9641) et clique **Save**
 6. Démarre l'addon
 
+## Dépôts
+
+Le dépôt principal est disponible sur Gitea : `https://gitea.i-host.fr/raph666/arkteos-proxy-addon`.
+GitHub est conservé comme miroir secondaire : `https://github.com/raph666/arkteos-proxy-addon`.
+
 ## Configuration
 
 | Option | Description | Défaut |
@@ -20,6 +25,25 @@ Permet les connexions simultanées de Node-RED et de l'application mobile Arkteo
 | `pac_host` | Adresse IP de la PAC | `192.168.X.X` |
 | `pac_port` | Port TCP de la PAC | `9641` |
 | `proxy_port` | Port d'écoute interne du proxy | `9641` |
+| `allow_client_writes` | Autorise le relais des données clients vers la PAC | `false` |
+
+## Fonctionnement du proxy
+
+Le proxy se connecte à la PAC avec `pac_host` et `pac_port`. Il écoute les clients TCP sur toutes les interfaces réseau, avec `proxy_port`.
+
+Les données reçues de la PAC sont distribuées à tous les clients connectés. Par défaut, les données reçues d’un client sont ignorées : le client reste connecté et peut continuer à recevoir le flux de la PAC.
+
+Active `allow_client_writes` uniquement si un client de confiance doit écrire vers la PAC. Dans ce mode bidirectionnel, les données client sont relayées telles quelles, sans filtrage ni validation ; les écritures vers la PAC sont sérialisées. L’intégration Home Assistant Arkteos n’a pas besoin de ces écritures.
+
+Un keepalive composé d’un octet nul est envoyé toutes les 300 secondes à la PAC afin de maintenir la connexion. Le code n’établit pas le rôle exact de cet octet pour la PAC.
+
+L’intégration Home Assistant Arkteos est conçue pour un usage en lecture seule. Le proxy applique également ce comportement tant que `allow_client_writes` reste désactivée.
+
+## Sécurité réseau
+
+Ne pas exposer le port du proxy sur Internet. Limite l’accès au réseau local ou à des clients de confiance : lorsque `allow_client_writes` est activée, un client qui accède au proxy peut potentiellement transmettre des données à la PAC.
+
+Le proxy ne met en œuvre ni authentification, ni filtrage protocolaire, ni contrôle d’accès. Il ne doit donc pas être considéré comme une barrière de contrôle d’accès, particulièrement en mode bidirectionnel.
 
 ## Intégration Node-RED