overlook - 把整个 homelab 汇总到一页的只读仪表盘
overlook 是一个单容器部署的 homelab 总览页,读取你已经在跑的监控、服务器、网络、存储与媒体工具,把「哪里出问题、各区域状态、今天与本周发生了什么」固定排布在同一页上。它只发 GET 请求、不跑检查、不发告警、不存数据,也可通过 MCP 让 AI agent 只读查询。
overlook 是一个面向自建 homelab 的单页总览工具。它不要求你改动现有环境,而是去读取你已经部署的各类工具——检查引擎、虚拟化与容器、网络设备、备份与存储、媒体与下载应用——然后把结果汇总到一个布局固定的页面上:哪里出了问题、服务器/网络/存储/应用四个区域各自处于什么状态、今天的关键数字,以及本周发生的事件。它适合已经有一堆监控与自托管服务、但不想在多个面板之间来回切换的 homelab 用户,也适合希望给 AI agent 一个只读信息入口的人。
维护者与状态
项目由 bnlqn 维护,仓库创建于 2026-10-28,最后一次提交在 2026-11-16。最新正式版本为 v0.8.0,发布于 2026-11-16。截至 2026-11-21,仓库星标数为 273。项目另有独立官网。
主要能力
以下能力描述来自项目自述(README),属于维护者视角的说明,并非第三方评测结论。
- 读取已有工具,不改变任何东西。 据项目说明,overlook 只向数据源发送 GET 请求;只有在数据源没有其他入口方式时才登录,而登录只创建一个会话。它使用的客户端会拒绝其他所有请求。对于 Tautulli 这类在 GET 上也会产生变更的工具,以及 Gitea、Forgejo 的少数路径,适配器只发送经过测试清单校验的只读命令与路径。
- 覆盖范围广。 README 列出的可读取对象包括:检查引擎(Gatus、Uptime Kuma、Grafana、Prometheus 与 Alertmanager、Checkmate);服务器(Proxmox VE、Beszel、Docker、Portainer、NUT);网络(UniFi Network、AdGuard Home、Pi-hole、Nginx Proxy Manager、Traefik);存储(Proxmox Backup Server、Syncthing,以及 Proxmox VE 的存储池、存储与备份任务);应用(Immich、Jellyfin、Emby、Plex 经 Tautulli、Audiobookshelf、Radarr、Sonarr、Prowlarr、qBittorrent、Tdarr、Seerr、Home Assistant、Paperless-ngx、Nextcloud、Gitea、Forgejo);以及待办类来源(GitHub、iCalendar 待办清单)。
- 固定的信息结构。 页面展示「哪里出问题」(即你的检查引擎正在告警的检查项)、四个区域各自的 up / degraded / down 状态与最近 30 次检查结果、每个来源贡献的「今天」数字、「本周」各区域的问题与事件列表,以及每个应用与工具的链接和可用状态圆点。
- 待办聚合。 到期或本周内的待办、等待你合并或安装的更新、需要更换的电池、等待纳管的设备、等待审批的请求、需要续期的证书都会集中列出;但处理动作要在原处完成,页面上不做变更,待办也不会被算作「问题」。
- 不运行检查、不发送告警。 检查与告警仍由你原有的检查引擎负责,因此页面与告警始终一致。
- 不存储数据。 项目自述称没有数据库也没有卷,页面请求时才读取各来源,最多每 30 秒一次;「本周发生了什么」取决于各来源自己记住了多少。
- 密钥不下发到浏览器。 服务端读取所有来源,只把读取结果的快照交给页面,不传密钥,也不传来源的原始响应;开启 MCP 后,agent 得到的也不会更多。
- 无遥测、无外部请求。 据 README,它不会调用你未指定的地址,字体、图标与 manifest 都由 overlook 自身提供。
- 可访问性与外观。 页面随系统明暗自动切换,也可在页脚手动选择;支持浏览器语言;可通过「添加到主屏幕」作为独立应用使用;在强制色彩模式下,失败结果比通过结果更醒目;屏幕阅读器会朗读每个状态与检查结果,键盘也能逐行查看。
使用入口
仓库地址:bnlqn/overlook;官网与在线演示:overlook 官网。
据项目说明,overlook 以单个容器运行。准备一个专属配置目录,与 compose.yaml 并列,镜像为 ghcr.io/bnlqn/overlook:0.8,映射 8080 端口,把配置目录以只读方式挂载到 /etc/overlook,并设置 TZ 决定「今天」从何时开始;镜像本身可以 read_only 运行并丢弃全部 Linux capability。执行 docker compose up -d 后访问该主机的 8080 端口。
首次没有配置时会出现设置页,它要求先输入 overlook 启动时写入日志的代码(可用 docker compose logs overlook 查看),然后选择你运行的工具、填写地址与密钥并逐个测试。设置页会根据有响应的来源生成 overlook.yaml 与保存密钥的 .env,两者放入配置目录后重启容器,设置页即变为正式页面。浏览器保存时会去掉文件名开头的点,.env 可能被存成 env,需要手动改名。配置中的 ${VAR} 从 .env 或容器环境变量读取,因此配置文件本身不含密钥,可以共享或纳入 git。
不使用 Docker 时,每个 release 提供 Linux amd64 与 arm64 的二进制,可用 overlook -config /etc/overlook/overlook.yaml -listen :8080 启动。README 还说明了 Unraid 应用商店与 Home Assistant OS 应用(旧称 add-on)的安装方式。
许可与限制
项目采用 MIT 许可证。
据项目说明,使用前需要注意以下边界:
- 它不执行检查、不发送告警,因此不能替代 Gatus、Uptime Kuma 等检查引擎。
- 它不保存历史数据,本周视图完全取决于各来源自身保留的记录。
- 页面布局固定,配置只决定由哪些来源填充页面,不能自行摆放组件。
- 部分来源的密钥权限较宽(README 举例:AdGuard Home 没有只读用户,Radarr 与 Sonarr 的密钥是管理员密钥),项目依靠客户端只发只读请求来保证安全。
- 配置文件以只读方式挂载,镜像以 uid 65532 运行,配置目录与文件需对其他用户可读;若要让
.env仅对该用户可见,需相应调整属主与权限。 - 设置页只在没有
overlook.yaml时出现;配置存在但内容有误(包括空文件)会阻止启动并给出原因。 - 对于 overlook 不信任的证书等连接问题,设置页会给出处理提示。