From f0127d21116c298b5c418218063268eeb475f29a Mon Sep 17 00:00:00 2001
From: Kai Kriegel <kai@kjkriegel.de>
Date: Tue, 27 Dec 2022 15:26:23 +0000
Subject: [PATCH] improved docs for mqtt config

---
 source/configuration/bffh_config.md | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

diff --git a/source/configuration/bffh_config.md b/source/configuration/bffh_config.md
index 4d89111..8731c8d 100644
--- a/source/configuration/bffh_config.md
+++ b/source/configuration/bffh_config.md
@@ -18,7 +18,15 @@ listens =
 ```
 
 ### `mqtt_url`
-Contains the Address for the MQTT Server BFFH connects to
+Contains the Address for the MQTT Server BFFH connects to.
+
+The Address has the format `<protocol>://[user]:[password]@<server>:[port]`
+
+* `protocol` is required and can be one of: `mqtt`,`tcp`,`mqtts`,`ssl`
+* `user` and `password` are optional
+* `server` is required and can be an ip address or a hostname
+* `port` is optional
+
 **Example:**
 ```
 mqtt_url = "tcp://localhost:1883"