Checkmate Connect
Optional cloud service for remote access, encrypted backups and an outside watchdog.
Overview
Checkmate Connect is an optional cloud service for self-hosted Checkmate. Enrolling a server in Connect adds three things:
- Remote access: reach your installation from an HTTPS address without opening inbound ports. See Remote access.
- Cloud backups: encrypted backups of your database, made on demand or on a schedule, with restore from Settings. See Cloud backups.
- Watchdog: your server reports to Connect every minute. If the reports stop, Connect emails you, then emails again when the server comes back.
Checkmate is complete without Connect. Monitoring, alerts and status pages all run on your server whether or not you enroll. Connect is free during its beta. Current limits are listed on checkmateconnect.io.
Checkmate Connect is available from Checkmate v4.0.0.
Requirements
- Checkmate v4.0.0 or later
ENCRYPTION_KEYset on the server (and on every worker). Checkmate uses it to encrypt the Connect credential it stores. Generate one withopenssl rand -base64 32. See the environment variables in the README.- A Superadmin account in Checkmate. Admins can open the tab, but only a Superadmin can enroll, change remote access, run or restore backups, or remove the enrollment.
Enrolling a server
- Create a Checkmate Connect account
- In the Connect dashboard, add your server by name. Connect shows a credential block once, so copy it before leaving the page.
- In Checkmate, open Settings and select the Checkmate Connect tab
- Paste the credential block into Enroll installation and click Enroll
The Status section then shows Enrolled and the server's agent ID. The credential is stored encrypted in your database and only leaves it to authenticate with Connect.
What Connect receives
- Watchdog reports: your installation ID, Checkmate version and tunnel state. No monitors or check results.
- Remote access: the requests you make through your Connect address. Traffic is encrypted in transit, but the relay decrypts requests to route them, so remote access is not end-to-end encrypted.
- Cloud backups: encrypted files only. Backups are encrypted on your server before upload, and the key never leaves it.
Your Checkmate users and password hashes stay in your own database. Connect accounts are covered by the Checkmate Connect privacy policy.
Removing the enrollment
Under Remove enrollment, click Remove enrollment. Checkmate disconnects from Connect and deletes the local credential. Local monitoring keeps running.