Skip to main content

Configuration

EventCatalog is a flexible, technology agnostic, unopinionated documentation tool.

EventCatalog focuses on documenting your architecture primitives, and letting you add the technical or implementation details as needed.

If you have complex CI/CD requirements, or various different workflows patterns in your organization and teams, EventCatalog is flexible to your needs.

You can configure EventCatalog using the eventcatalog.config.js file.

eventcatalog.config.js​

The eventcatalog.config.js file is the heart of your application. It allows you to define overrides for EventCatalog.

See the API documentation to override defaults for EventCatalog.

Configuring environment variables​

Added in eventcatalog@2.35.4

Some features in EventCatalog require environment variables to be set.

If you need to set environment variables, you can do so in your .env file.

When EventCatalog is running or builds it will load the environment variables from your .env file.

.env (example)
EVENTCATALOG_SCALE_LICENSE_KEY=your-api-key

Configuring EventCatalog Linter​

EventCatalog has a linter that can be used to validate your EventCatalog documentation.

You can read more about the EventCatalog Linter in the EventCatalog Linter documentation.