OpenLegacy LowCode API - Supported Environment Variables

OpenLegacy low-code APIs are Java Spring Boot 3 applications.

If a user would like to override any Openlegacy supported YAML property, he could set it as an environment variable.

Spring Boot provides a way to override configuration properties defined in application.yml (or application.properties) using environment variables. The naming convention follows a specific pattern to ensure that environment variables are correctly mapped to the corresponding properties in the YAML file.

Here are the key rules:

Hierarchical Structure: Use underscores (_) to separate hierarchical properties.
Uppercase Letters: Use uppercase letters for the environment variable names.
Dots to Underscores: Replace dots (.) in property names with underscores (_).

Here is a list of commonly used OL properties:

OL_LICENSE_KEY=<OPENLEGACY LICENSE KEY>
OL_FLOW_SOURCEPROVIDER=<HUB/OL_PROJECT_ZIP>
OL_FLOW_PROFILES=<OL ACTIVE PROFILES COMMA SEPARATED>
OL_FLOW_HUB_URL=<OL HUB URL>
OL_FLOW_HUB_APIKEY=<OL HUB API KEY>
OL_FLOW_HUB_PROJECTNAME=<OL HUB PROJECT NAME>
OL_FLOW_HUB_PROJECTVERSION=<OL HUB PROJECT VERSION>
OL_FLOW_OLPROJECTZIP_PATH = file:<PATH IN CONTAINER>