Configuration

You can configure the behavior of our agents using these configuration options. They can be set from environment variables like:

ATLAS_APIKEY=<your-api-key> ./<your-go-binary>

or inside the code as:

heimdall.Start(heimdall.AtlasOptions{
    Apikey: "your-api-key",
})

In the table below, you can see what each config option does and how to set them.

Config name in code
Config name as env variable
Purpose

Apikey

ATLAS_APIKEY

This is the api key used to authenticate with CtrlB services.

ApplicationName

ATLAS_APPLICATION_NAME

Set the name of your application to improve your experience. Defaults to git repo if available.

ApplicationStage

ATLAS_APPLICATION_STAGE

Set this if the same application is deployed in prod, beta or dev environment to distinguish between them. Can leave unspecified if not applicable.

ApplicationVersion

ATLAS_APPLICATION_VERSION

Set this if the same application name and stage have multiple versions running. Can leave unspecified if not applicable.

Last updated