From e6f2ff970b3fc3cdb62b20e8a75bf2e4e577444f Mon Sep 17 00:00:00 2001
From: shamoon <4887959+shamoon@users.noreply.github.com>
Date: Thu, 6 Jun 2024 12:38:27 -0700
Subject: [PATCH] Documentation: clarify deployment recs
---
README.md | 4 ++++
docs/installation/index.md | 4 ++++
2 files changed, 8 insertions(+)
diff --git a/README.md b/README.md
index 4c41e227..f14bdfad 100644
--- a/README.md
+++ b/README.md
@@ -66,6 +66,10 @@ Homepage is highly customizable, with support for custom themes, custom CSS & JS
For configuration options, examples and more, [please check out the homepage documentation](http://gethomepage.dev).
+## Security Notice 🔒
+
+Please note that when using features such as widgets, Homepage can access personal information (for example from your home automation system) and Homepage currently does not (and is not planned to) include any authentication layer itself. Thus, we recommend homepage be deployed behind a reverse proxy including authentication, SSL etc, and / or behind a VPN.
+
## With Docker
Using docker compose:
diff --git a/docs/installation/index.md b/docs/installation/index.md
index f1d317c4..beb370c1 100644
--- a/docs/installation/index.md
+++ b/docs/installation/index.md
@@ -7,6 +7,10 @@ description: Docs intro
You have a few options for deploying homepage, depending on your needs. We offer docker images for a majority of platforms. You can also install and run homepage from source if Docker is not your thing. It can even be installed on Kubernetes with Helm.
+!!! danger
+
+ Please note that when using features such as widgets, Homepage can access personal information (for example from your home automation system) and Homepage currently does not (and is not planned to) include any authentication layer itself. Thus, we recommend homepage be deployed behind a reverse proxy including authentication, SSL etc, and / or behind a VPN.
+