v0.4.0

Overlook v0.4.0 reads Checkmate and Emby, and ships the logos of eight more programs. Nothing that worked in v0.3.0 changes.

Checkmate. A fifth check engine, after Gatus, Uptime Kuma, Grafana and Prometheus: each monitor Checkmate checks is a check, in the area its group is named after, or the one areas gives, and joins the others' on every page.

• A problem once Checkmate calls the monitor down, which is when it alerts. Until then it shows failing, with how many failures in a row make a problem.
• Breached: a hardware or Docker monitor over a threshold you gave it is a problem too, with what crossed it, such as MEMORY: 10.9% (threshold: 1%).
• This week: the problems its incidents remember, each counted as alerted when an incident overlaps it.
• Left out: a paused monitor. One in a maintenance window is never a problem, as Checkmate alerts on neither.

Each check links to the monitor's page in Checkmate, and a link's check: can name one, such as Checkmate/Films. Checkmate has no API keys, so it takes a login: a user of its own with the role User, which reads every monitor and can change none. Overlook logs in once with a POST and reads with GET only (ADR 0009); the README says how to make the user. It was recorded from a scratch Checkmate 3.13.1 with invented monitors.

Emby. On the Apps page, as a media server beside Jellyfin and Plex:

• What plays: what each person plays now and how, as it is, transcoded or paused.
• The library: how many films, shows, albums and books there are.
• What failed: the failed logins of the last day, and each task whose last run failed, such as a library's scan, in red with why.
• Today: the plays since midnight, hour by hour, added up with every other media server's.

It takes one API key and reads with GET only; the README says where to make the key. Emby doesn't report its free disk space, so unlike Jellyfin it shows none. It was recorded from a scratch Emby 4.10 filled with invented films and people, and checked against a real one.

Thank you, @linkinxp, who wrote it: Overlook's first adapter from outside, and its first change from anyone but the maintainer.

Eight more logos. A link's icon: can now name Checkmate's, Emby's, AdGuard Home's, Docker's, GitHub's, UniFi's, Network UPS Tools' and Baïkal's, with no file of your own: checkmate.svg, emby.svg, adguard-home.svg, docker.svg, github.svg, unifi.png, network-ups-tools.svg and baikal.svg. UniFi's is Ubiquiti's own file and Checkmate's is under CC BY-SA 3.0, both outside the Apache licence, as the README says.

A state on its line. On an area page, the state under the title, such as Up, now sits on the line of the words after it, not 2.5px above them.

Upgrade. Change the image from ghcr.io/bnlqn/overlook:0.3 to ghcr.io/bnlqn/overlook:0.4, or take the Linux binary below, for amd64 or arm64. Your config needs no change; add a checkmate: or an emby: source to read them.

Check what you run. Every binary and the image carry a build attestation, and each archive its SBOM:

gh attestation verify oci://ghcr.io/bnlqn/overlook:0.4.0 --repo bnlqn/overlook

For contributors, a new adapter now brings its program's logo, as item 8 of Adding an adapter says. The adapters wanted are open as issues. If you run one of those tools, its issue says what an adapter for it takes.

Since v0.3.0, the last release:

• Ship the logos of the sources that came without one, and ask every adapter for its logo by @bnlqn in #94
• Add an Emby adapter by @linkinxp in #93
• Set an area's state on the line of the words after it by @bnlqn in #96
• Read Checkmate's monitors as a fifth check engine by @bnlqn in #95
• Bring the README and its kin to v0.4.0 by @bnlqn in #97

New contributors:

• @linkinxp made their first contribution in #93

Full Changelog: v0.3.0...v0.4.0

v0.3.0

Overlook v0.3.0 reads UniFi Network, and says plainly which rows are an area's checks. Nothing that worked in v0.2.0 changes.

UniFi Network. Each UniFi OS console, such as a Cloud Gateway, a Dream Machine or UniFi OS Server, and every site on it, in Network:

• The internet: each WAN, how long it has been up, how much of the last day it answered and how fast, or since when it's down, and the last speed test. A spare WAN with nothing plugged in shows grey, not red.
• The devices: each gateway, switch and access point, how long it has been up and how busy its processor and how full its memory are, or its state: offline in red, interrupted in orange.
• Today: the clients connected, wired, wireless and on the VPN, every console's added up.
• The chores: each device whose firmware waits, a gateway's being UniFi OS itself, each device waiting to be adopted, and the Network application's update.

It takes one API key and reads with GET only; the README says how to make the key and trust the console's own certificate. It was recorded from a real console, and it never reads a client's name or address, only how many there are.

The checks, named. The overview's Areas table says that its rows are each area's checks, and each area page heads its first card Checks, so neither reads as everything in the area.

Upgrade. Change the image from ghcr.io/bnlqn/overlook:0.2 to ghcr.io/bnlqn/overlook:0.3, or take the Linux binary below, for amd64 or arm64. Your config needs no change; add a unifi: source to read a console.

Check what you run. Every binary and the image carry a build attestation, and each archive its SBOM:

gh attestation verify oci://ghcr.io/bnlqn/overlook:0.3.0 --repo bnlqn/overlook

The adapters wanted are open as issues. If you run one of those tools, its issue says what an adapter for it takes.

Since v0.2.0, the last release:

• Say that an area's rows and its page's first card are its checks by @bnlqn in #90
• Read UniFi Network on a UniFi OS console by @bnlqn in #91
• Bring the README and its kin to v0.3.0 by @bnlqn in #92

Full Changelog: v0.2.0...v0.3.0

v0.2.0

Overlook is one page that tells you whether your homelab is fine: what's wrong, how each area of it is, and what it did today and this week. It reads the tools you already run and changes nothing. This is its first release.

See it first. The demo draws the page from a homelab that doesn't exist, with a small and a large one beside it.

What it reads. Gatus, Uptime Kuma, Grafana, and Prometheus with Alertmanager; Proxmox VE, Beszel, Docker and NUT; AdGuard Home and Pi-hole; Proxmox Backup Server; Immich, Jellyfin, Plex through Tautulli, Radarr, Sonarr, Prowlarr, qBittorrent, Seerr, Home Assistant, Paperless-ngx and Nextcloud; and chores from GitHub and iCalendar to-do lists.

What it never does. It sends your sources only GET requests, and a login where a source offers no other way in. It keeps no database and no volume. It never sends a key to the browser, and it calls nowhere you didn't name.

Install. ghcr.io/bnlqn/overlook:0.2, for amd64 and arm64, or the Linux binary below. The quick start takes one config file, with your keys in .env.

Check what you run. Every binary and the image carry a build attestation, and each archive its SBOM:

gh attestation verify oci://ghcr.io/bnlqn/overlook:0.2.0 --repo bnlqn/overlook

The adapters wanted are open as issues. If you run one of those tools, its issue says what an adapter for it takes.

Since v0.2.0-rc.3, the last release candidate:

• Keep to GitHub's Community Guidelines, with reports going to GitHub by @bnlqn in #72
• Hold the copyright as the Overlook authors by @bnlqn in #73

Full Changelog: v0.2.0-rc.3...v0.2.0

v0.2.0-rc.3

What's Changed

• Set out step 9, and say how Overlook is written by @bnlqn in #67
• Attest every release, and give each archive an SBOM by @bnlqn in #68
• Propose ADRs 0014 and 0015: a setup page, and MCP by @bnlqn in #70
• Have the demo say it's a demo, and lead to the repository by @bnlqn in #71
• Write the README for someone who has never seen Overlook by @bnlqn in #69

Full Changelog: v0.2.0-rc.2...v0.2.0-rc.3

v0.2.0-rc.2

What's Changed

• Tick v0.1's step 7, and fold its last two steps into v0.2 by @bnlqn in #50
• Share what the adapters and the page each wrote out again by @bnlqn in #51
• Record Home Assistant again from the author's own, and tick v0.2's step 7 by @bnlqn in #52
• Pass every adapter the moment the snapshot is read by @bnlqn in #53
• Build every check engine's checks with one module by @bnlqn in #54
• Give resolvers and media servers a module each, as hosts have by @bnlqn in #55
• Draw the page from one model the tests can reach by @bnlqn in #56
• Give each source its kind, and have the page ask by it by @bnlqn in #57
• Read each source through one fetch.Source, under its own address by @bnlqn in #58
• Say why each adapter's key is written twice in config by @bnlqn in #59
• Leave room above an area's name on a phone, as under its strip by @bnlqn in #60
• Name Overlook and its version at the foot of every page by @bnlqn in #61
• Make Replay the one fake source an adapter's test needs by @bnlqn in #62
• Replay every adapter's source, and check what each test sent by @bnlqn in #63
• Have Validate check a part is in its adapter's home area by @bnlqn in #64
• List Home Assistant among the example's apps, not its tools by @bnlqn in #65
• Link every app the demo reads by @bnlqn in #66

Full Changelog: v0.2.0-rc.1...v0.2.0-rc.2

v0.2.0-rc.1

What's Changed

• Serve a small and a large homelab beside the demo's own by @bnlqn in #26
• Tell parts apart with eight colours, and fold the rest by @bnlqn in #27
• Say which check engine a check is in, and when it has no results by @bnlqn in #28
• Put a Proxmox's hosts in one section, a row each by @bnlqn in #29
• Lay the page out for a large homelab by @bnlqn in #30
• Chart each Proxmox host's processor and memory over the week by @bnlqn in #31
• Follow a source's redirect only to its own scheme, host and port by @bnlqn in #33
• Let internal/fetch log in to a source that offers no other way in by @bnlqn in #32
• Read Beszel's systems as hosts, on the same charts as Proxmox's by @bnlqn in #34
• Read a Docker engine's containers through a socket proxy by @bnlqn in #35
• Read Prowlarr's indexers: disabled, failing, and what each did this week by @bnlqn in #36
• Read qBittorrent: its torrents, those in error, its disk and its peers by @bnlqn in #37
• Read Jellyfin: what plays, the libraries, their disks and what failed by @bnlqn in #38
• Read Home Assistant: broken automations, devices gone, updates and batteries by @bnlqn in #39
• Read Uptime Kuma, a second check engine: the monitors on a status page by @bnlqn in #40
• Read Pi-hole, whose lookups add up with AdGuard Home's by @bnlqn in #41
• Read Paperless-ngx: documents, the inbox, its parts' health and failures by @bnlqn in #42
• Read Nextcloud from serverinfo: files, shares, updates and maintenance by @bnlqn in #43
• Read Grafana's alert rules as a third check engine by @bnlqn in #44
• Read Plex through Tautulli, whose reads are a fixed list of commands by @bnlqn in #45
• Read Seerr: requests waiting for approval as chores, and open problems by @bnlqn in #46
• Read Prometheus with Alertmanager, the fourth check engine, and tick step 5 by @bnlqn in #47
• Ship the logos of the sources step 5 brought, and name them in the demos by @bnlqn in #49
• Step 6 of the road to v0.2: what Overlook can't read, and the adapters wanted by @bnlqn in #48

Full Changelog: v0.1.0-rc.3...v0.2.0-rc.1

v0.1.0-rc.3

What's Changed

• Wire each adapter in one line, and cut what nothing used by @bnlqn in #23
• Plan the road to v0.2, and tell two sources of one kind apart by @bnlqn in #24
• Read the chores from a to-do list by @bnlqn in #25

Full Changelog: v0.1.0-rc.2...v0.1.0-rc.3

v0.1.0-rc.2

What's Changed

• Tick step 4: v0.1.0-rc.1 is out, its image public by @bnlqn in #16
• Name the demo's go-live chores in step 7 by @bnlqn in #18
• Take a source's login as user and password, so any password works by @bnlqn in #17
• Tick step 5: the author's homelab runs v0.1.0-rc.1 in place of its own page by @bnlqn in #19
• Show the night in Today's backups, not a backup by hand after it by @bnlqn in #20
• Draw the charts the old page drew: DNS by the hour, the week added up, Today's shares by @bnlqn in #21
• Draw the hours in the accent, and films and shows in one Library tile by @bnlqn in #22

Full Changelog: v0.1.0-rc.1...v0.1.0-rc.2

v0.1.0-rc.1

What's Changed

• The skeleton: the server, the page and the Gatus adapter, laid out to take contributions by @bnlqn in #1
• Add the GitHub adapter: the updates waiting by @bnlqn in #2
• Add the Immich adapter: the photos by @bnlqn in #3
• Add the Radarr and Sonarr adapters by @bnlqn in #4
• Add the NUT adapter, which reads a UPS straight from upsd by @bnlqn in #5
• Keep an area's sections in the snapshot's order on a phone by @bnlqn in #8
• Add the AdGuard Home adapter: DNS today, and each resolver by @bnlqn in #6
• Add the Proxmox VE adapter: the hosts, guests, storage and backup runs by @bnlqn in #7
• Add the Proxmox Backup Server adapter: each guest's newest backup by @bnlqn in #9
• Tick step 2: every adapter is in by @bnlqn in #10
• Run make check in CI on every pull request and on main by @bnlqn in #11
• Release from a v* tag: Linux binaries and a multi-arch image on GHCR by @bnlqn in #12
• Add the demo: the real page, drawn from an invented snapshot by @bnlqn in #13
• Write the README for v0.1, and tick step 3 by @bnlqn in #14
• Show the chores the owner writes down in the config by @bnlqn in #15

New Contributors

• @bnlqn made their first contribution in #1

Full Changelog: https://github.com/bnlqn/overlook/commits/v0.1.0-rc.1