s4l3h1/meshcheck repository overview

⁠MeshCheck Agent

s4l3h1/meshcheck:agent is the MeshCheck peer-node agent — the container you run to turn a Linux host into a MeshCheck node. A node connects to a MeshCheck platform over an outbound WebSocket and runs reachability checks (traceroute, DNS, TLS, HTTP, …) on demand, contributing its vantage point to the network.

This is the only MeshCheck image published to a registry; the platform API ships separately.

⁠Supported tags & architectures

Each tag is a multi-arch manifest list — docker pull selects your architecture automatically:

• linux/amd64
• linux/arm64

⁠Quick start

On your MeshCheck dashboard, open Install a node to mint an API key, then:

docker run -d --name meshcheck-agent --restart unless-stopped \
  -e MESHCHECK_AGENT_API_KEY=mck_... \
  -e MESHCHECK_AGENT_GATEWAY_URL=wss://<your-host>/agent \
  -e MESHCHECK_AGENT_CONNECTION_CLASS=vps \
  -e MESHCHECK_AGENT_KEY_FILE=/data/agent.key \
  -v meshcheck-agent:/data \
  s4l3h1/meshcheck:agent

The install page generates this command with your key and gateway URL already filled in.

⁠Configuration

Configure the agent with environment variables (or a JSON config at /etc/meshcheck/agent.json):

The -v meshcheck-agent:/data volume persists the node's signing key — its stable identity across restarts.

⁠Notes

• The agent opens raw sockets for traceroute/ping checks.
• Containers update by image pull; the in-place self-updater is for the systemd/binary install, not Docker.
• No registry access? The platform also serves docker load tars and binary tarballs from its /downloads page.