From 608686e4bd3a88c7b492225e432a27d77adf2c69 Mon Sep 17 00:00:00 2001
From: void-spark <81029971+void-spark@users.noreply.github.com>
Date: Mon, 11 May 2026 21:51:32 +0200
Subject: [PATCH] Add list with settings to readme

---
 front/plugins/kea_api/README.md | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/front/plugins/kea_api/README.md b/front/plugins/kea_api/README.md
index 8a35edf2..6bbd2aa9 100755
--- a/front/plugins/kea_api/README.md
+++ b/front/plugins/kea_api/README.md
@@ -68,3 +68,20 @@ And you need to install kea-ctrl-agent, with a config that looks something like
 ```
 
 You will need to configure the plugin with the URL to the API, and the username and password configured above (from kea-api-password file in the example)
+
+
+#### Required Settings
+
+These settings are required, besides the common device scanner settings:
+
+- **Kea Control Agent URL** (`KEALSS_URL`): The full URL, including port number, to the Kea API.
+  - Default: `http://127.0.0.1:8000`
+  - This mirrors what you set up in the kea-ctrl-agent configuration.
+
+- **Basic Auth Username** (`KEALSS_USER`): The user to use for authenticating with the Kea API. 
+  - Default: `kea-api`
+  - This mirrors what you set up in the kea-ctrl-agent configuration.
+
+- **Basic Auth Password** (`KEALSS_PASS`): The password to use for authenticating with the Kea API. 
+  - This mirrors what you set up in the kea-ctrl-agent configuration.
+  - When using a password file, it should be the content of the password file.