Example environment variable files
Content SDK apps created using version 0.2.0 or later include a set of example environment variable files with the .example suffix. These files are designed to assist when configuring your local application depending on whether it will be run using a local container or a connection to a remote SitecoreAI instance.
Environment variables control how your Content SDK application behaves in different environments (such as local development, production, CI/CD, and so on), and these example files demonstrate:
-
Which variables need to be defined for Content SDK.
-
How to define the variables for specific environments.
-
How to avoid committing sensitive information to source control.
The available example files are:
|
File name |
Purpose |
|---|---|
|
|
Local development while connected to a local SitecoreAI container instance. |
|
|
Local development while connected to a remote SitecoreAI instance. |
Because these are template files included in source control, you can modify them according to your common implementation requirements. That way, when you commit changes to a remote repository, other developers can work from the same modified templates. We also recommend that you maintain your .example templates by adding new environment variables whenever they are introduced in new versions of Content SDK.
Do not add sensitive data such as client secrets to any .example template.
Implement the example variables
To ensure that your local environment variables are appropriate for your app and chosen development scenario, copy the contents of the relevant .example file into your app's .env.local file and add the necessary values for each variable.