* Mention z2m version 2.x url rewriting in config reference

chrivers · Jan 15, 2025 · 0cc39e1 · 0cc39e1
1 parent 7e7a6c3
commit 0cc39e1
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/doc/config-reference.md b/doc/config-reference.md
@@ -54,6 +54,13 @@ bridge:
 # if you have more than one server.
 z2m:
   some-server:
+    # The websocket url for z2m, starting with "ws://".
+    #
+    # For z2m version 2.x, the url must end in `/api?token=<token>`.
+    # For z2m version 1.x, this is optional, but supported.
+    #
+    # Therefore, Bifrost will adjust the urls if needed.
+    # A message will be logged with the rewritten url if this happens.
     url: ws://10.00.0.100:8080
   other-server:
     url: ws://10.10.0.102:8080