Skip to content

Commit

Permalink
Documentation: clarify deployment recs
Browse files Browse the repository at this point in the history
  • Loading branch information
shamoon committed Jun 6, 2024
1 parent af16956 commit e6f2ff9
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:https://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:
Expand Down
4 changes: 4 additions & 0 deletions docs/installation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
</p>

!!! 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.

<br>

<div class="grid cards" style="margin: 0 auto;" markdown>
Expand Down

0 comments on commit e6f2ff9

Please sign in to comment.