The container options below can be used to authenticate to use the software (HL_LICENSE), to send data to the platform (HL_LLM_PROXY_CLIENT_ID and HL_LLM_PROXY_CLIENT_SECRET), or to configure networking behavior.
| Environment Key | Required | Example Value | Description |
|---|---|---|---|
| HL_LICENSE | True | License for use obtained from HiddenLayer. | |
| HL_LLM_PROXY_ENABLE_UNSECURED_ROUTE_PASSTHROUGH | True | Flag to handle unmapped routes, the AIDR supports passing through all HTTP endpoints that are not explicitly mapped. | |
| HL_LLM_PROXY_CLIENT_ID | False | The HiddenLayer API key. Required for an AIDR hybrid deployment. | |
| HL_LLM_PROXY_CLIENT_SECRET | False | The HiddenLayer API secret. Required for an AIDR hybrid deployment. | |
| HL_LLM_PROXY_HTTP_HOST | False | 0.0.0.0 | |
| HL_LLM_PROXY_HTTP_PORT | False | 8000 | Default: 8000. While the port range is 1-65535, the recommended port range is 1025-65535 since opening ports 1-1024 requires root permissions. |
| HL_LLM_PROXY_LOG_LEVEL | False | DEBUG | |
| HL_LLM_PROXY_DOWNSTREAM_TIMEOUT_SECONDS | False | 600 | |
| HL_LLM_PROXY_MLDR_RETRY_COUNT | False | 3 | |
| HL_LLM_PROXY_MLDR_CONNECTION_TYPE | False | hybrid or disabled | Default: hybrid. Hybrid mode enables metadata to be sent to HiddenLayer to power the console experience. In hybrid mode, HL_LLM_PROXY_CLIENT_ID and HL_LLM_PROXY_CLIENT_SECRET must be set. Setting to disabled will remove any connections back to HiddenLayer. |
| HL_LLM_PROXY_MLDR_BASE_URL | False | https://api.us.hiddenlayer.ai | |
| HL_LLM_PROXY_MLDR_DEFAULT_REQUESTER | False | unknown | |
| HL_LLM_PROXY_MLDR_COLLECT_PROMPT | False | false | Default true. Collects prompts and response with the security analysis sent to the Console. This allows the review and evaluation of Interactions on the AISec Platform in the context of the user's prompt and response. Setting to false disables this. If this setting is not configured, the default behavior is set to true. |
| HL_LLM_PROXY_TOKEN_URL | False | https://auth.hiddenlayer.ai | |
| HL_LLM_PROXY_MLDR_ENABLE_REMOTE_CONFIGURATION | False | false | Enables ruleset support. Setting to false disables Ruleset support for AIDR. Default: true |