Add notice about Ingress

hassio-addons · Jan 13, 2024 · ad71357 · ad71357
1 parent 3d3845a
commit ad71357
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/whisparr/DOCS.md b/whisparr/DOCS.md
@@ -22,6 +22,14 @@ comparison to installing any other Home Assistant add-on.
 
 _This add-on does not require any configuration to run._
 
+## Known issues and limitations
+
+- This add-on does not support Home Assistant's Ingress feature (aka, the
+  toggle that puts an add-on in the Home Assistant sidebar).
+  There are too many variables to take into account to make this work properly,
+  and if we would, it would be very easy to break. You could consider using an
+  iframe panel instead.
+
 ## Changelog & Releases
 
 This repository keeps a change log using [GitHub's releases][releases]