From 991effb47eeedc1263c33a274070bc2eec4788e4 Mon Sep 17 00:00:00 2001 From: "Langhammer, Jens" Date: Sun, 7 Feb 2021 17:30:02 +0100 Subject: [PATCH] add notice to readme --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d9dccc4..f7567d7 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,9 @@ This custom component allows you to delegate authentication to a reverse proxy. +This integrations checks the value of a configured header and authenticates based on its value. The value of the header is +checked against usernames AND full names. Users have to be created in Home Assistant by hand. + **Use with caution. If misconfigured, this can lead to a Home Assistant instance that anyone can access** ## Installation @@ -17,7 +20,7 @@ http: trusted_proxies: - 1.2.3.4/32 # This needs to be set to the IP of your reverse proxy auth_header: - # Optionally set this if you're not using passbook proxy or oauth2_proxy + # Optionally set this if you're not using authentik proxy or oauth2_proxy # username_header: X-Forwarded-Preferred-Username # Optionally enable debug mode to see the headers Home-Assistant gets # debug: false