Server features

Goauld server component: services, deployment, access control, and more

The server is the publicly reachable component of Goauld. It exposes the listening services agents connect through, brokers access between operators and agents, and persists agent state across restarts.

This section covers:

  • Listening services: the transports the server exposes and how agents tunnel SSH over them.
  • Deployment: example configuration for running the server, including with Docker.
  • Access control: IP allowlisting and access/admin tokens for the server’s endpoints.
  • Healthcheck: scripts and tools to verify tunnels are functioning.
  • Agent downloading: serving precompiled agent binaries for download.
  • Database: how the server persists agent identities and state.
  • Metrics: Prometheus and admin API metrics for agent connections and traffic.

Listening services

Goauld listening services

Deployment

Goauld server deployment

Access control

Goauld server access control

Healthcheck

Goauld server healthcheck

Agent downloading

Downloading agent binaries from the server

Database

Goauld server database

Metrics

Goauld server metrics