Skip to content

Environment Variables

Format

Since our applications mostly run in container environments, they are configured via environment variables. In the old setup, no specific format policy was defined, so some environment variables started with the ASPNETCORE_ prefix while others started with lowercase letters. In the new setup, a specific format is enforced to ensure consistency:

APPCIRCLE[MODIFIER]{COMPONENT_NAME}_{ENVIRONMENT_VARIABLE_NAME}

APPCIRCLE_: All environment variables must start with this prefix. COMPONENT_NAME: The component that refers to a specific service. E.g. DISTRIBUTION, STORE_API ENVIRONMENT_VARIABLE_NAME: A mandatory variable name. MODIFIER: Can optionally be used to provide additional information. For example EXTERNAL, INTERNAL

Certain specific keywords may be used in environment variable names. These keywords must be used with the appropriate meaning.

  • ADDRESS: Indicates where a resource is located. Does not include a specific protocol. Can be an IP address or a host.
  • URL: Defines the full address of a specific resource on the web. Covers all components such as protocol, host, domain, and path.
  • ENDPOINT: A specific access point used to reach a particular service or API. For example, the user token endpoint or the user endpoint.
  • PATH: Refers to the part of a web resource after the host and defines a specific resource. The query string can also be part of the path.
  • URI: A structure that generally covers both URL and URN.
Environment Variable Name Environment Variable Value
APPCIRCLE_API_GATEWAY_HOST api.appcircle.io
APPCIRCLE_EXTERNAL_API_GATEWAY_URL https://api.appcircle.io
APPCIRCLE_EXTERNAL_KECYLOAK_TOKEN_ENDPOINT https://auth.appcircle.io/openid-connect/token
APPCIRCLE_TESTING_WEB_LOGOUT_PATH /api/logout

Common Environment

Environment Variable Name Description
APPCIRCLE_INTERNAL_STORE_API_PORT Specifies the port the application runs on
APPCIRCLE_STORE_API_ENVIRONMENT Specifies the environment the application runs in. Dev, Prep, Prod