Environment variables

This reference documentation details the environment variables used to configure sensitive credentials and the runtime behaviour of the engine and of the modules that run alongside it. These variables can be defined in a .env file at the root of the collection repository.

Engine

OTA_ENGINE_SMTP_PASSWORD string
SMTP password for email error notifications.
OTA_ENGINE_GITHUB_TOKEN string
GitHub token for dataset publishing. If both GitHub and GitLab tokens are configured, GitHub takes precedence.
OTA_ENGINE_GITLAB_RELEASES_TOKEN string
GitLab token for dataset publishing. Used only if GitHub token is not configured.
OTA_ENGINE_DATAGOUV_API_KEY string
API key for data.gouv.fr dataset publishing.
OTA_ENGINE_FETCHER_NO_SANDBOX string
Set to any value to launch the headless browser without its sandbox, for containerised environments such as Docker where the sandbox cannot run.
OTA_ENGINE_FETCHER_NO_HEADLESS string
Set to any value to run the browser with a visible window instead of headless, which is useful for debugging fetching issues.
HTTPS_PROXY string
Proxy URL for the engine’s outgoing HTTPS traffic, such as document fetching and dataset publishing to GitLab. The lowercase https_proxy variable is also supported and takes precedence.
HTTP_PROXY string
Proxy URL for the engine’s outgoing HTTP traffic. Also used as a fallback when HTTPS_PROXY is not set. The lowercase http_proxy variable is also supported and takes precedence.

Issue reporter

OTA_ISSUE_REPORTER_GITHUB_TOKEN string
GitHub token of the account managing the issues of the declarations repository, required when the reporter type is github.
OTA_ISSUE_REPORTER_GITLAB_TOKEN string
GitLab token of the account managing the issues of the declarations repository, required when the reporter type is gitlab.
HTTPS_PROXY string
Proxy URL for the issue reporter’s requests to GitLab. Not used with GitHub.
OTA_ISSUE_REPORTER_SMTP_PASSWORD string
SMTP password for email error notifications of the reporter.

Federation API

OTA_FEDERATION_API_SMTP_PASSWORD string
SMTP password for email error notifications.