Aviato / docs
Reference

Agent configuration

Environment variables used by the database agent.

View Markdown

These settings configure the agent process. They are separate from the API server's environment variables.

VariableDefault / requirementPurpose
AVIATO_CONTROL_PLANE_URLRequiredAbsolute HTTP(S) control-plane URL.
AVIATO_AGENT_TOKENRequiredDeployment credential issued for the environment.
AVIATO_DATABASE_URLRequiredMain datasource connection string.
AVIATO_PUBLIC_URLhttp://localhost:8080 with the configured portURL browsers and MCP clients use to reach the agent. Set HTTPS in production.
PORT8080Agent listening port.
AVIATO_DATA_DIR./.aviatoPersistent local state directory; mount durable storage.
AVIATO_DB_SCHEMApublic for PostgreSQLSchema to expose.
AVIATO_MONGO_SAMPLE_SIZE1000Documents sampled per collection for field inference.
AVIATO_DATASOURCE_<NAME>_URLOptionalAdditional datasource; names are lowercased. main and plugin are reserved.
AVIATO_DATASOURCE_<NAME>_SCHEMApublic for PostgreSQLSchema for an additional datasource.
AVIATO_PLUGIN_URLOptionalSDK plugin base URL. Requires its matching secret.
AVIATO_PLUGIN_SECRETOptionalSignature secret shared with the plugin. Requires its URL.
AVIATO_DECISIONS_URLOptionalSelf-hosted decision service URL.
AVIATO_UPLOADS_BUCKETOptionalEnables uploads to your S3-compatible bucket.
AVIATO_UPLOADS_PREFIXaviato/Object-key prefix for uploads.
AVIATO_UPLOADS_PUBLIC_URLOptionalPublic base URL stored for uploaded files.
AVIATO_UPLOADS_MAX_SIZE_MB25Per-file size limit.

Database connection schemes

Supported connection forms include PostgreSQL (postgres:// or postgresql://), MySQL (mysql://), MongoDB (mongodb:// or mongodb+srv://), SQLite (file:), and libSQL (libsql://). MongoDB URLs must include a database name.

Use database privileges to restrict the agent independently of application roles. Protect connection strings and tokens as secrets.

The implementation of this reference is runtime/config.ts.

Edit on GitHub

On this page