Skip to main content
Version: 1.0.x

Gateway Environment Variables

VariableK8S VariableDescriptionRequired?Default ValuePossible Values
LUNAR_API_KEYlunarAPIKeyAllow the Gateway to communicate with the Control PlaneNo--
TENANT_NAMEtenantNameConfigure the name for your organizationYes--The name of your organization, e.g. Acme, Google
BIND_PORTservice.portConfigure the bind port Lunar.dev API Consumption Gateway listens onNo8000Any accessible port
ENGINE_ADMIN_PORTservice.adminPortConfigure the admin port Lunar.dev API Consumption Gateway listens on. Also responsible for the Interceptor handshakeNo8081Any accessible port
LUNAR_HEALTHCHECK_PORTservice.healthCheckPortConfigure the port Lunar.dev API Consumption Gateway listens onNo8040Any accessible port
LOG_LEVELlogLevelConfigure the log levelNoERRORDEBUG, INFO, WARN, ERROR
ENVenvTo set the environments stageNoprodprod, dev
LUNAR_TELEMETRYtelemetryEnabledAllow the user to disable telemetry reportNotruetrue, false
LUNAR_ACCESS_LOGS_OUTPUT-Enable the output for access logs into the stdoutNostdoutstdout, NULL
LUNAR_ENGINE_FAILSAFE_ENABLEDengineFailsafeEnabledConfigured to handle critical error in Lunar Engine to keep passing directly to the ProviderNotruetrue, false
TLS_CERT_PATH-Point to the mounted certificate file, for TLS communicationNo/etc/lunar-proxy/certs/gateway_cert.pemPath to the Relevant Certificate Path
REDIS_URL-Path to the Redis Instance that’s connected to the Lunar Gateway Pro InstancesNo—Any URL
REDIS_PREFIX-Prefix for Redis keysNolunarPrefix for Redis keys
REDIS_USE_CLUSTER-Enable the use of Redis ClusterNofalsetrue, false
REDIS_USE_CA_CERT-Enable the use of CA certificate for Redis mTLS connectionNofalsetrue, false
REDIS_CA_CERT_PATH-Path to the CA certificate file for Redis mTLS connectionNo/etc/redis/ca.crtPath to the CA certificate file
REDIS_USE_CLIENT_CERT-Enable the use of client certificate for Redis mTLS connectionNofalsetrue, false
REDIS_CLIENT_CERT_PATH-Path to the client certificate file for Redis mTLS connectionNo/etc/redis/client.crtPath to the client certificate file
REDIS_CLIENT_KEY_PATH-Path to the client key file for Redis mTLS connectionNo/etc/redis/client.keyPath to the client key file
note
  • Make sure the port you choose is accessible by the Lunar Interceptor.
  • By default, the main port is set to 8000.
  • The handshake process uses port 8081 by default.
  • If you change ENGINE_ADMIN_PORT, remember to also update the Interceptor’s LUNAR_HANDSHAKE_PORT accordingly.
  • Similarly, if you change BIND_PORT, be sure to update the Interceptor’s LUNAR_PROXY_HOST to match.

Configuration Examples​

docker run -d --rm -e TENANT_NAME="Acme Corp." -e LOG_LEVEL=DEBUG -e BIND_PORT=8000 -e ENGINE_ADMIN_PORT=8081 -e LUNAR_HEALTHCHECK_PORT=8040 -p 8000:8000 -p 8081:8081 -p 8040:8040 --name lunar-proxy lunarapi/lunar-proxy:latest
CTRL + M