Run the database connector

Create the connectionCopy Anchor Link

Create a self-hosted project in the dashboard. Copy its connector token and control-plane URL. Use a database account with only the privileges you intend Aviato to expose.

Install the connector binary for your platform from the project's setup instructions or the connector releases. Pin the release you deploy. The examples below assume aviato-connector is on your PATH.

Configure itCopy Anchor Link

Run the setup wizard:

aviato-connector init

Or create an aviato.env file and restrict who can read it:

AVIATO_CONTROL_PLANE_URL=https://api.getaviato.com
AVIATO_CONNECTOR_TOKEN=replace-with-the-token-from-your-project
AVIATO_DATABASE_URL=postgres://aviato:[email protected]:5432/app
AVIATO_PUBLIC_URL=https://connector.example.com
AVIATO_DATA_DIR=/var/lib/aviato
PORT=8080

Use your own URLs and credentials. Keep this file out of source control. See the configuration reference for additional databases and plugin settings.

Run itCopy Anchor Link

chmod 600 aviato.env
set -a
. ./aviato.env
set +a
aviato-connector

Place an HTTPS reverse proxy in front of port 8080. The public URL must be reachable from your users' browsers and MCP clients; a URL that only the control plane can reach is not sufficient.

Persist the connector's stateCopy Anchor Link

Mount AVIATO_DATA_DIR on durable storage. It holds the audit outbox, approval recovery state, and caches. Give each replica its own data directory; do not share a SQLite-backed directory between running replicas.

Verify the connectionCopy Anchor Link

Request GET /v1/health on the connector, then open the project in the dashboard. Confirm its status, environment, and discovered collections. Try a read before enabling writes.

The connector needs outbound access to the control plane, audit ingestion, its configured databases, and any SDK plugin. Read troubleshooting if it does not connect.