Repository navigation
What's Changed
Checkmate Connect, heartbeat monitors and a new dashboard lead this release. Connect adds remote access through an outbound tunnel and encrypted cloud backups. The dashboard is now the default page.
Features
- Checkmate Connect: a superadmin can enroll the installation from the new Checkmate Connect settings tab. Enrolling requires ENCRYPTION_KEY
- Remote access through Connect's outbound tunnel, no open inbound ports needed. Off by default
- Encrypted cloud backups through Connect, with a recovery key. Backups run on demand or on a schedule of every 1, 3 or 7 days, full or configuration only
- Restore from a Connect cloud backup, and import a recovery key on a new installation. The job queue is rebuilt from the restored monitors
- Heartbeat monitors: a job pings Checkmate, and an alert fires when the pings stop. Pings can report a failure or an exit code, and an optional duration
- Heartbeat monitors can be created automatically on the first ping with
?create=true, using a team ping key and a per-monitor slug - Dashboard is the new default page, with summary, Checkmate server and queue cards. Cards can be rearranged and hidden, and admin cards are hidden from non-admin users
- Check interval presets from 1 hour to 1 day
- Update indicator in Settings when a newer release exists
- Monitor list filters are kept in the URL, so filtered lists survive a refresh and can be shared
- "What's new" walkthrough shown once per user on the dashboard
- Checkmate Connect translated into all locales, and missing translations filled in across all locales
Fixes
- Permission checks enforced on proxy settings, tags, status pages and monitor actions, in both the API and the UI
- PageSpeed pause action calls the correct endpoint
- Status pages always have a timezone, with UTC as the default. The default latest view shows check times in the page's timezone instead of UTC
- Docker monitor setup explains which Capture URL to use, and the hardware metrics endpoint is rejected
- Monitor type can no longer be changed on edit, and non-heartbeat monitors reject an empty URL
- Server no longer crashes when a log line follows the request finished log
- Graceful shutdown exits after 30 seconds if it hangs, and a second SIGINT or SIGTERM exits immediately
- One-shot jobs re-armed during a run stay scheduled
- Sidebar footer stays reachable on short viewports
- Sidebar density, collapse toggle and surface consistency cleanup
Upgrade notes
- Migration 0013 sets UTC on status pages with no timezone and rewrites stored Etc/UTC to UTC
- Tag, status page and proxy actions now require an admin. Non-admin users lose access they had before
- The Docker image now ships mongodump and mongorestore for Connect backups. Source installs need the MongoDB Database Tools installed to use Connect backups, or can point CONNECT_MONGODUMP_BIN and CONNECT_MONGORESTORE_BIN at them
- New optional environment variables: CONNECT_ALLOWED_HOSTS, CONNECT_API_URL, CONNECT_MONGODUMP_BIN and CONNECT_MONGORESTORE_BIN. No new required environment variables
Maintenance
- express, proxy-addr, handlebars and dompurify bumped to clear critical advisories
- Dashboard data served from a single API call
- README fixes, a one-click install provider grid with xCloud added, and Raspberry Pi 5 listed as the supported home device
- Docs linked to checkmate.so and the contributor guide moved
New Contributors
- @elanant made their first contribution in #4071
- @ankurmehta102 made their first contribution in #4062
- @cloudmanic made their first contribution in #4067
- @Goldloli made their first contribution in #4095
Full Changelog: v3.13.1...v4.0.0