Skip to main content

Configuration

EventCatalog allows you to define overrides for your organization. These exist in the eventcatalog.config.js file.

Catalog configuration​

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.

Setting up VSCode​

EventCatalog uses MDX file format for documentation.

If you are using VSCode you can install the MDX plugin, for the .mdx files.

Recommended Plugins:

Customize favicon​

You can customize the favicon for your EventCatalog by adding a favicon in in the public directory: /public/favicon.ico.

Setting up .env file​

Added in eventcatalog@2.35.0

If you are using EventCatalog Integrations or features that require a license key, you will need to set up a .env file in the root of your project.

The .env file should contain the following:

.env examples
# EventCatalog Scale Plan License Key
EVENTCATALOG_SCALE_LICENSE_KEY=your-key-for-scale-plan

# OpenAPI Integration License Key
EVENTCATALOG_LICENSE_KEY_OPENAPI=your-key-for-openapi-plan

All our integrations and plans have a 14 day free trial, if you are using features that require a license key, you can get a license keys from EventCatalog Cloud.