Repolode
bnlqn

bnlqn/overlook

A single self-hosted page that shows whether your homelab is fine, reading the tools you already run without changing anything.

Stars
215
Forks
11
Open issues
15
Last commit
3 days ago

What is it?

Overlook is a read-only status page for a homelab. It pulls state from the monitoring and infrastructure tools you already run, such as Gatus, Uptime Kuma, Prometheus, Proxmox VE, UniFi, AdGuard Home and Jellyfin, and lays out what is wrong, how each area (Servers, Network, Storage, Apps) is doing, and what happened today and this week on one page.

It runs no checks and sends no alerts of its own. Problems on the page are the failures your existing check engine already alerts on, so the page and your alerts agree. It keeps no database; it queries each source when the page is requested, at most every 30 seconds. Its API keys stay on the server and are never sent to the browser.

Overlook ships as one container image for amd64 and arm64, or as a Linux binary, and is configured with a single YAML file where secrets are read from environment variables.

Key features

  • 01Shows what is wrong, drawn from the failures your existing check engine alerts on.
  • 02Reads Gatus, Uptime Kuma, Grafana, Prometheus, Proxmox VE, Beszel, Docker, UniFi and many other tools.
  • 03Sends only read requests to each source and never changes anything in your homelab.
  • 04Keeps no database and reads sources on demand, at most every 30 seconds.
  • 05Keeps API keys on the server and reads secrets from environment variables.

Use cases

  • Getting a single glance at whether a self-hosted homelab is healthy before digging into individual tools.
  • Giving household members a simple status page for home services like media servers and photo libraries.
  • Combining alerts from several monitoring tools into one view that matches what your alerts report.

Quick start

  1. 1

    Write overlook.yaml and compose.yaml, with the sources you run

  2. 2

    Start Overlook with Docker Compose, then open port 8080 of that host

    docker compose up -d

Things to know

  • It only shows what your existing tools report, so you need to already run the supported apps.
  • Some keys it needs are admin keys, such as those for Radarr, Sonarr and AdGuard Home, which have no read-only option.

In collections

Topics

FAQ

What is overlook?
A single self-hosted page that shows whether your homelab is fine, reading the tools you already run without changing anything. Overlook is a read-only status page for a homelab. It pulls state from the monitoring and infrastructure tools you already run, such as Gatus, Uptime Kuma, Prometheus, Proxmox VE, UniFi, AdGuard Home and Jellyfin, and lays out what is wrong, how each area (Servers, Network, Storage, Apps) is doing, and what happened today and this week on one page.
Is overlook free to use? What license does it have?
overlook is open source under the MIT license. Check the license terms before using it in commercial products.
Is overlook still maintained?
Actively maintained. The last commit to overlook was on Nov 5, 2026.
What can I use overlook for?
Getting a single glance at whether a self-hosted homelab is healthy before digging into individual tools. Giving household members a simple status page for home services like media servers and photo libraries. Combining alerts from several monitoring tools into one view that matches what your alerts report.
How do I install overlook?
Write overlook.yaml and compose.yaml, with the sources you run Start Overlook with Docker Compose, then open port 8080 of that host: docker compose up -d
Where can I get overlook?
The source code and installation instructions are on GitHub: https://github.com/bnlqn/overlook

Summary generated by AI from the project's README. GitHub stats refresh daily.

Related projects