Skip to content

Configuration Settings

These environment variables can be used to override the default configuration:

  • SDK2_API_URL - Sets both BaseUrl and UriPrefix (extracted from full URL)
  • SDK2_URI_PREFIX - Sets UriPrefix (used if not found in API_URL)
  • SDK2_APP_NAME - Sets AppName
  • SDK2_HEARTBEAT_PERIOD - Sets HeartbeatPeriodSeconds
  • SDK2_RETRY_PERIOD - Sets RetryPeriodSeconds
  • SDK2_MAX_RETRIES - Sets MaxRetries
  • SDK2_CALLBACK_URL - Sets WebhookUrl
  • SDK2_USE_WEBHOOKS - Sets WebhookEnabled (true if value contains "true", "1", or "yes")
  • LOG_LEVEL -> Diagnostics level.Valid values : critical,error,warning,info,debug or trace

Example Settings for Local Tests

The settings below are typically the minimum needed to run the application in a local development environment and communicate to a remote REST server exposed in the HCC2.

  SDK2_API_URL: "http://173.0.0.41:7071/api/v1"
  SDK2_CALLBACK_URL: "http://173.0.4.2:8100/webhook/v1"
  SDK2_USE_WEBHOOKS: "true"
  LOG_LEVEL: "debug"

Where:

  • 173.0.0.41:7071 : The IP address of the remote HCC2, accessible on the local LAN. Note: The HCC2 firewall port TCP/7071 needs to be open.
  • 173.0.4.2:8100 : The development machine's IP address, accessible from the HCC2. Note: The development machine's incoming TCP/8100 port needs to be open.