Skip to main content

Proxy Mode

Environment variables that configure the application to operate in proxy mode.

General config​

NameDescriptionRequiredType
IS_PROXY
Flag to determine if the application runs as a proxy
false
boolean
GETAPP_URL
Defines the URL of the main API server (not the proxy)
Notes:
  • Needs to be set only in 'delivery' microservice.
Required if:
IS_PROXY = "true"
string
ANALYTICS_SERVER_URL
Defines the URL of the analytics server
Required if:
IS_PROXY = "true"
string

API Auth​

NameDescriptionRequiredType
GETAPP_USERNAME
Username used to authenticate with the main API server
Required if:
IS_PROXY = "true"and
DEVICE_SECRET = ""and
DIST_HTTP_PROTOCOL = "false"
string
GETAPP_PASSWORD
Password used to authenticate with the main API server
Required if:
IS_PROXY = "true"and
DEVICE_SECRET = ""and
DIST_HTTP_PROTOCOL = "false"
string
DEVICE_SECRET
A secret key that will be added to each request in the Device-Auth header
Notes:
  • It can be a string of key separated by commas, e.g., 'key1,key2,key3'.
Example: key1,key2,key3
Required if:
IS_PROXY = "true"and
GETAPP_USERNAME = ""and
GETAPP_PASSWORD = ""
string

TLS Verification​

NameDescriptionRequiredType
PROXY_SECURE_TLS
Determines whether the proxy validates the main server's TLS certificate
Notes:
  • Set to false to skip certificate validation (use with caution).
false
boolean
Default:true

TLS 'with out' client certificates​

NameDescriptionRequiredType
GETAPP_URL
The URL of the main API server
Notes:
  • Needs to be set only in 'api' microservice.
Required if:
DIST_HTTP_PROTOCOL = "false"
string
NODE_EXTRA_CA_CERTS
Path to load additional CA certificates to the service
Required if:
DIST_HTTP_PROTOCOL = "false"and
GETAPP_URL = start with https
string

TLS with client certificates​

NameDescriptionRequiredType
DIST_HTTP_PROTOCOL
Defines if the destination service runs in secure mode with http protocol (true for secure), used for communication the main API server with client certificates
false
boolean
Default:false
CA_CERT_PATH
Filesystem path to the CA certificate used to validate server
Example: /etc/ssl/certs/ca.crt
Required if:
DIST_HTTP_PROTOCOL = "true"
string
CLIENT_CERT_PATH
Filesystem path to the client TLS certificate
Example: /etc/ssl/certs/client.crt
Required if:
DIST_HTTP_PROTOCOL = "true"
string
CLIENT_KEY_PATH
Filesystem path to the client TLS key file used in mTLS
Example: /etc/ssl/private/client.key
Required if:
DIST_HTTP_PROTOCOL = "true"
string
GETAPP_SSL_URL
Target hostname the main API server to establish a secure connection with client certificates
Notes:
  • The URL of the destination server should be a hostname only, without protocol. Example: 'google.com', not 'https://google.com'.
  • Needs to be set only in 'api' microservice.
Example: google.com
Required if:
DIST_HTTP_PROTOCOL = "true"
string
GETAPP_SSL_PORT
Port of the main API server to establish a secure connection with client certificates
Notes:
  • Needs to be set only in 'api' microservice.
Required if:
DIST_HTTP_PROTOCOL = "true"
number