Environment variables are composed of key-value pairs set externally from your source code. They can influence the behavior of the web application, providing a way to adjust its configuration without changing the codebase. Each value can be modified based on the specific Atlas environment.
Modifications to environment variables do not retroactively affect past builds. They are effective only for subsequent builds.
Managing environment variables
To add new variables visit the Atlas Environment Details page and click the
Go to variables link of the
Enter the keys and values for your Environment Variables and click
Save to confirm. To add more environment variables, simply click on
Add environment variable and repeat the previous steps.
To confirm all changes, hit the
Save all variables button.
To edit an existing variable, click the three-dot menu on the right and select
You can remove a variable by selecting
Delete from the three-dot menu.
Reserved variables and namespaces
Atlas reserves some environment variables and prefixes. You cannot use these for your own variables:
If you try to use these reserved keys, Atlas will display a warning and won’t save the variable.
Allowed format of keys
Environment variables’ keys on Atlas must match the following regex:
System environment variables
Atlas automatically generates a collection of environment variables to provide users with metadata about their environments. This includes variables such as the Build ID or a flag that signifies whether the environment in question is a preview or production environment. You can find the complete list of system environment variables in the table below:
|Source control provider
|Git repository name and owner
|Name of the Atlas application
|Name of the Atlas environment
|Commit identifier for the current build
|Git branch used for the current build
|Flag that indicates if the environment is a ‘preview’ type
|Unique identifier for the Atlas environment
|Identifier for the latest build
|Indicates if the build is a ‘clean’ build