Configure

Marmot is configured using a YAML file or environment variables. All settings have sensible defaults so you only need to specify what you want to change.

Configuration Topics

Authentication

Set up SSO with Google, GitHub, GitLab, Okta, Slack or Auth0

Anonymous Access

Allow users to browse the Catalog without logging in

TLS

Set up custom TLS configuration

Customisable Banner

Display announcements and notices to users

Elasticsearch

Enhance search with deep fuzzy matching across all fields

Configuration File

By default, Marmot looks for config.yaml in the current directory. Use the --config flag to specify a different path.

database:
  host: localhost
  port: 5432
  user: postgres
  password: secret
  name: marmot
server:
  host: 0.0.0.0
  port: 8080
logging:
  level: info
  format: json

Environment Variables

All configuration options can be set via environment variables using the MARMOT_ prefix with underscores separating nested keys. For example, database.host becomes MARMOT_DATABASE_HOST.

Database

Marmot requires PostgreSQL 14 or later. Ensure the database user has privileges to create tables and indexes.

Key	Description	Default	Environment Variable
database.host	PostgreSQL host	localhost	MARMOT_DATABASE_HOST
database.port	PostgreSQL port	5432	MARMOT_DATABASE_PORT
database.user	Database username	postgres	MARMOT_DATABASE_USER
database.password	Database password	-	MARMOT_DATABASE_PASSWORD
database.name	Database name	marmot	MARMOT_DATABASE_NAME
database.sslmode	SSL mode (disable, require, verify-full)	disable	MARMOT_DATABASE_SSLMODE
database.maxConns	Maximum open connections	10	MARMOT_DATABASE_MAX_CONNS
database.idleConns	Minimum idle connections	5	MARMOT_DATABASE_IDLE_CONNS
database.connLifetime	Connection lifetime in minutes	30	MARMOT_DATABASE_CONN_LIFETIME

Server

Key	Description	Default	Environment Variable
server.host	Bind address	0.0.0.0	MARMOT_SERVER_HOST
server.port	Port number	8080	MARMOT_SERVER_PORT
server.root_url	Public URL of this Marmot instance	-	MARMOT_SERVER_ROOT_URL
server.tls.cert_path	Path to server TLS certificate	-	MARMOT_SERVER_TLS_CERT_PATH
server.tls.key_path	Path to server TLS private key	-	MARMOT_SERVER_TLS_KEY_PATH
server.tls.ca_cert_path	Path to CA cert for client verification (mTLS)	-	MARMOT_SERVER_TLS_CA_CERT_PATH

Root URL Required for Authentication

server.root_url must be set when using OAuth/OIDC authentication or CLI login (marmot login). It is the URL that users access Marmot from (e.g. https://marmot.example.com). This is used to generate OAuth callback URLs and redirect users after authentication.

server:
  root_url: https://marmot.example.com

Or via environment variable:

export MARMOT_SERVER_ROOT_URL=https://marmot.example.com

Logging

Marmot uses structured logging. Set the format to console for human-readable output during development.

Key	Description	Default	Environment Variable
logging.level	Log level (debug, info, warn, error)	info	MARMOT_LOGGING_LEVEL
logging.format	Output format (json, console)	json	MARMOT_LOGGING_FORMAT

Search

Key	Description	Default	Environment Variable
search.timeout	Search query timeout in seconds	10	MARMOT_SEARCH_TIMEOUT

See Elasticsearch for options related to the optional Elasticsearch search backend.

OpenLineage

Key	Description	Default	Environment Variable
openlineage.auth.enabled	Require authentication for the OpenLineage endpoint	true	MARMOT_OPENLINEAGE_AUTH_ENABLED