Note about websocket

agama-project · Apr 26, 2024 · 9e85be8 · 9e85be8
1 parent e9e61bf
commit 9e85be8
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/doc/agama-security.md b/doc/agama-security.md
@@ -18,6 +18,8 @@ The token carries just one claim - the expiration date. Token's lifetime is curr
 
 If both components run locally, communication can be done over HTTP even HTTPS. However, in case when both run on different machines the HTTPS is mandatory. In such case all HTTP requests are automatically redirected to HTTPS. A HTTP response with code 308 (permanent redirect) is returned in such case.
 
+For notifications on changes from backend Agama uses WebSocket technology. Typically backend notificates about installation progress or network configuration changes this way.
+
 ### Https certificates
 
 SSL communication is secured either by self-signed certificate which is automatically generated by Agama if no certificate was provided by user. If Agama should use particular custom certificate Agama's web server provides options --cert and --key for path to certificate respectively to private key (in PEM format).