Skip to main content

Configuration

View as Markdown

Most new EventCatalog projects are ready to run as soon as they are created. You only need to change configuration when you want to adjust how the catalog behaves, where it builds, or which features are enabled.

Configuration lives in eventcatalog.config.js at the root of your project. You can read the full reference documentation to learn what can be changed.

Configuring environment variables​

Some features need values that should not live directly in eventcatalog.config.js, such as license keys or provider credentials.

Put those values in a .env file in the root of your catalog. EventCatalog loads .env when it runs locally and when it builds.

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

Do not commit real secrets to source control.

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.