Checkmate
DocumentationCheckmate Connect

Remote access

Reach your Checkmate installation through Checkmate Connect without opening inbound ports.

Overview

Remote access keeps an outbound tunnel open from your server to Checkmate Connect. You reach the installation from its Connect address in any browser. No inbound ports, dynamic DNS or certificates are needed on your side.

Remote access is off by default. It needs an enrolled server.

Turning on remote access

  1. Open Settings and select the Checkmate Connect tab
  2. Turn on Remote access
  3. Wait for Status to show Tunnel connected

Connect gives your server a random HTTPS address, shown in your Connect account. It goes live once the tunnel connects. To stop remote access, turn the switch off. The status then shows Remote access off.

What is reachable

The tunnel forwards every request to the port Checkmate's server listens on (PORT, 52345 by default).

  • Docker image: the server also serves the web interface, so the full app loads at your Connect address.
  • Client served separately (for example from its own nginx): only the API is reachable through Connect.
  • Development (npm run dev): Vite serves the client, so the Connect address answers 404. The README explains how to serve a client build from the server while testing.
Note

Traffic is encrypted in transit, but the Connect relay decrypts requests to route them. Remote access is not end-to-end encrypted. Request and response bodies are not stored.

On this page