mirror of
https://github.com/gethomepage/homepage.git
synced 2026-09-17 01:25:52 -07:00
shamoon
68 lines
3.7 KiB
Markdown
68 lines
3.7 KiB
Markdown
---
|
|
title: Installation
|
|
description: Docs intro
|
|
icon: simple/docker
|
|
---
|
|
|
|
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.
|
|
|
|
!!! info
|
|
|
|
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>
|
|
[:simple-docker: Install on Docker :octicons-arrow-right-24:](docker.md)
|
|
{ .card }
|
|
|
|
[:simple-kubernetes: Install on Kubernetes :octicons-arrow-right-24:](k8s.md)
|
|
{ .card }
|
|
|
|
[:simple-unraid: Install on UNRAID :octicons-arrow-right-24:](unraid.md)
|
|
{ .card }
|
|
|
|
[:simple-nextdotjs: Building from source :octicons-arrow-right-24:](source.md)
|
|
{ .card }
|
|
|
|
</div>
|
|
|
|
### `HOMEPAGE_ALLOWED_HOSTS`
|
|
|
|
As of v1.0 there is one required environment variable to access homepage via a URL other than `localhost`, <code>HOMEPAGE_ALLOWED_HOSTS</code>. The setting helps prevent certain kinds of attacks when retrieving data from the homepage API proxy.
|
|
|
|
The value is a comma-separated (no spaces) list of allowed hosts (sometimes with the port) that can host your homepage install. See the [docker](docker.md), [kubernetes](k8s.md) and [source](source.md) installation pages for more information about where / how to set the variable.
|
|
|
|
`localhost:3000` and `127.0.0.1:3000` are always included, but you can add a domain or IP address to this list to allow that host such as `HOMEPAGE_ALLOWED_HOSTS=gethomepage.dev,192.168.1.2:1234`, etc.
|
|
|
|
If you are seeing errors about host validation, check the homepage logs and ensure that the host exactly as output in the logs is in the `HOMEPAGE_ALLOWED_HOSTS` list.
|
|
|
|
This can be disabled by setting `HOMEPAGE_ALLOWED_HOSTS` to `*` but this is not recommended. Public deployments must rely on a reverse proxy (and/or VPN) that enforces authentication, TLS, and unexpected Host headers; the built-in host check is a best-effort guard for local setups and is not a substitute for edge protections.
|
|
|
|
### Security & Authentication
|
|
|
|
Public deployments of Homepage should be secured via a reverse proxy, VPN, or similar. As of version 2.0, Homepage supports a simple authorization gate with a password or OIDC. When enabled, Homepage will use password login by default unless OIDC variables are provided.
|
|
|
|
Required environment variables for authentication:
|
|
|
|
- `HOMEPAGE_AUTH_ENABLED=true`
|
|
- `HOMEPAGE_AUTH_SECRET` (random string for signing/encrypting cookies)
|
|
- `HOMEPAGE_EXTERNAL_URL` (the absolute URL used to access Homepage, including scheme and port when needed)
|
|
|
|
Use an `https://` URL for public or TLS-terminated deployments so authentication cookies are marked `Secure`. Trusted HTTP-only LAN deployments may use an `http://` URL.
|
|
|
|
For password-only login:
|
|
|
|
- `HOMEPAGE_AUTH_PASSWORD` (password-only login; required unless OIDC settings are provided)
|
|
|
|
For OIDC login (overrides password login):
|
|
|
|
- `HOMEPAGE_OIDC_ISSUER` (OIDC issuer URL, e.g., `https://auth.example.com/realms/homepage`)
|
|
- `HOMEPAGE_OIDC_CLIENT_ID`
|
|
- `HOMEPAGE_OIDC_CLIENT_SECRET`
|
|
- Optional: `HOMEPAGE_OIDC_NAME` (display name), `HOMEPAGE_OIDC_SCOPE` (defaults to `openid email profile`)
|
|
|
|
All app pages and `/api` routes except `/api/healthcheck` will require a signed-in session. Static assets remain public.
|
|
|
|
Configure your OIDC provider with the a callback URI like `https://homepage.example.com/api/auth/callback/homepage-oidc`.
|