Repolode
bnlqn

bnlqn/overlook

一个自托管页面,汇总展示家庭实验室的整体状况,读取你已在运行的工具且不做任何修改。

Star
202
Fork
11
未关闭 Issue
15
最近提交
前天

这是什么?

Overlook 是一个面向家庭实验室的只读状态页面。它从你已经在用的监控和基础设施工具中读取状态,包括 Gatus、Uptime Kuma、Prometheus、Proxmox VE、UniFi、AdGuard Home、Jellyfin 等,在一个页面上展示当前有哪些问题、服务器、网络、存储、应用四个区域各自的运行情况,以及当天和本周发生的事件。

Overlook 本身不执行检查,也不发送告警。页面上的问题就是你现有监控系统已经告警的失败项,因此页面与告警保持一致。它不使用数据库,页面被访问时才向各数据源查询,最多每 30 秒一次。API 密钥只保存在服务端,不会发送到浏览器。

项目以单个容器镜像(支持 amd64 和 arm64)或 Linux 二进制文件的形式发布,通过一个 YAML 配置文件设置,密钥从环境变量读取。

核心功能

  • 01展示当前问题,问题来源于你现有监控系统的失败告警。
  • 02支持读取 Gatus、Uptime Kuma、Grafana、Prometheus、Proxmox VE、Beszel、Docker、UniFi 等多种工具。
  • 03对各数据源只发送读取请求,不会修改家庭实验室中的任何内容。
  • 04不使用数据库,按需读取数据源,最多每 30 秒一次。
  • 05API 密钥保存在服务端,配置中的密钥从环境变量读取。

适用场景

  • 在逐个检查各个工具之前,一眼看清自托管家庭实验室的整体健康状况。
  • 为家庭成员提供一个简单的状态页,覆盖影音服务器、照片库等家庭应用。
  • 把多个监控工具的告警汇总到一个视图中,与告警内容保持一致。

快速上手

  1. 1

    编写 overlook.yaml 和 compose.yaml,填入你运行的数据源

  2. 2

    用 Docker Compose 启动 Overlook,然后打开该主机的 8080 端口

    docker compose up -d

使用前须知

  • 它只显示你现有工具上报的内容,因此你需要already运行受支持的应用。
  • 它需要的部分密钥是管理员密钥,例如 Radarr、Sonarr 和 AdGuard Home 的密钥,这些服务没有只读选项。

收录于专题

标签

常见问题

overlook 是什么?
一个自托管页面,汇总展示家庭实验室的整体状况,读取你已在运行的工具且不做任何修改。 Overlook 是一个面向家庭实验室的只读状态页面。它从你已经在用的监控和基础设施工具中读取状态,包括 Gatus、Uptime Kuma、Prometheus、Proxmox VE、UniFi、AdGuard Home、Jellyfin 等,在一个页面上展示当前有哪些问题、服务器、网络、存储、应用四个区域各自的运行情况,以及当天和本周发生的事件。
overlook 可以免费使用吗?用的什么许可证?
overlook 以 MIT 许可证开源。用于商业产品前,请先确认许可证条款。
overlook 还在维护吗?
活跃维护中。overlook 最近一次提交是在 2026年11月5日。
overlook 适合用来做什么?
在逐个检查各个工具之前,一眼看清自托管家庭实验室的整体健康状况。 为家庭成员提供一个简单的状态页,覆盖影音服务器、照片库等家庭应用。 把多个监控工具的告警汇总到一个视图中,与告警内容保持一致。
overlook 怎么安装和运行?
编写 overlook.yaml 和 compose.yaml,填入你运行的数据源 用 Docker Compose 启动 Overlook,然后打开该主机的 8080 端口: docker compose up -d
在哪里获取 overlook?
源代码和安装说明在 GitHub 上:https://github.com/bnlqn/overlook

概要由 AI 根据项目 README 生成;GitHub 数据每日更新。

相关项目