Skip to main content
This guide walks you through deploying Griffin Hub on your own infrastructure.

Prerequisites

  • Node.js 18+
  • PostgreSQL 14+
  • A server or container runtime (Docker, Kubernetes, etc.)

1. Set up PostgreSQL

Create a database for Griffin:
Or using Docker:

2. Configure the hub

Set the required environment variables:

3. Run database migrations

4. Start the hub

Runs the hub with a built-in executor — no separate agents needed:

Distributed mode

Runs the hub as a control plane only. You’ll need to start agents separately:

5. Generate an API key

If using API key authentication:
Use this key with the CLI:

6. Deploy monitors

Running with Docker

Example docker-compose.yml:

Distributed deployment

For multi-region execution, run the hub separately from executor agents:

Hub

Agent (on each executor machine)

Enabling secrets

Configure a secret provider for resolving secret() references at execution time:

Enabling notifications

To send Slack notifications, configure OAuth credentials:
Then connect the integration via the CLI: