Tags:
Categories:

Aura Groot environment variables

Updated list of aura-groot environment variables

  • Properties marked in bold are mandatory.
  • Properties marked in italics are optional.
Property Type Description Modifiable by OB?
AURA_ACTIVATE_MINI_BOT boolean Flag to activate minibot mode. By default: false. NO. Only valid during development to run Aura minibot.
AURA_ALLOWED_CALLERS string List of allowed callers separated by commas. By default: [*] YES
AURA_AUTHORIZATION_APIKEY_PATH string Path to validate channel APIKey authorization NO
AURA_AUTHORIZATION_ENDPOINT string aura-authentication-api base endpoint. NO. In any case, it must be the internal k8s URL pointing to the aura-authentication-api.
AURA_AUTHORIZATION_HEADER string Complete authorization header to be sent to aura-authentication-api, with the following format: APIKEY xxxxxx. YES, but only if the previous APIKey was deprecated.
AURA_CHANNELDATA_CURRENT_VERSION string channelData version used internally by aura-groot. By default, 3. NO
AURA_CHANNELDATA_DEFAULT_VERSION string channelData version returned by default in all messages. By default, 1.0.0. NO
AURA_CHANNELDATA_RESPONSE_VALIDATION boolean Flag to indicate that response validation should be done. By default, true. NO
AURA_CHANNELDATA_VALIDATION boolean Flag to indicate that request validation should be done. By default, true. NO
AURA_CHANNELDATA_VALIDATION_VERSIONS string channelData versions that will be validated. By default, 3. NO
AURA_CHANNELDATA_VALIDATION_MIN_VERSION string Minimal version to validate. By default, 3. NO
AURA_CHANNELS_CONFIGURATION_API_ENDPOINT string Endpoint for aura-configuration-api. NO
AURA_DEFAULT_LOCALE string Culture code to be used by default in the current deployment: de-de, en-gb, es-es, pt-br. NO
AURA_DEFAULT_TIME_ZONE string Default time zone. For example: Europe/Madrid NO
AURA_ENCRYPTION_ALGORITHM string Encryption algorithm used to validate the APIKey NO. It would break database encrypted data and APIKey validation.
AURA_ENCRYPTION_IV_LENGTH number Size for the initialization vector used by the encryption algorithm that validates the APIKey NO. It would break database encrypted data and APIKey validation.
AURA_ENCRYPTION_IV_POSITION number Position where to insert the initialization vector in the final string with the encrypted payload. Future use. NO. It would break database encrypted data and APIKey validation.
AURA_ENCRYPTION_KEY string Encryption key or comma-separated list of encryption keys to be used in the environment. It is mainly used to decrypt the APIKeys. NO. It would break database encrypted data and APIKey validation.
AURA_ENVIRONMENT_NAME string Name of the environment where the aura-authentication-api is deployed. For example: ap-next, es-dev or de-pre. NO
AURA_EXTERNAL_HOST_SERVICE_URL string URL of the external host service. NO. In any case, it must be the internal k8s URL pointing to the host-service.
AURA_HOST_SERVICE_URL string URL of the host service. NO. In any case, it must be the internal k8s URL pointing to the host-service.
AURA_HTTP_PATHS_DISABLED_FOR_LOGS stringArray Paths which will be filtered in logs. Used in HTTPMonkeyPatcher module. NO
AURA_HTTP_KEEP_ALIVE boolean Use of keep-alive in HTTP connections. Used in HTTPMonkeyPatcher module. NO
AURA_HTTP_KEEP_ALIVE_MSECS number Number of milliseconds to keep alive HTTP connections. Used in HTTPMonkeyPatcher module. NO
AURA_HTTP_MONKEY_PATCHER_ENABLED boolean Enable or disable the monkey patching of the HTTP and HTTPs modules. By default, false. YES
AURA_HTTP_REQUEST_MAX_SOCKETS number Maximum number of HTTP sockets open in the server. By default, 100 NO. Only if indicated by Aura Global Team.
AURA_IGNORE_LOGGING_PATH string Comma-separated string with all the incoming paths which requests should not be logged. By default, /healthz YES
AURA_INTERNAL_DELAY_MS number The time in milliseconds between retries. By default, 10000 NO, except if requested
AURA_INTERNAL_RETRIES number Number of retries for internal calls. By default, 1 NO, except if requested
AURA_KPI_ENABLED Boolean Boolean value, indicating whether aura-groot writes entity files or not. By default: true NO, excepting if requested by Product or Operations teams
AURA_KPI_FILE_PREFIX string String with the prefix used in the KPIs entities files of this service. By default, groot/GROOT NO
AURA_KPI_REMOVE_SPECIAL_CHARACTERS string Regular expression for removing special characters Default:\n\r NO
AURA_KPI_STORE_MODE string It indicates which is the destination of the KPIs entities files. Default: blob. If file, they will be stored locally to the instance, in the folder shown in KPI_TO_DSV_LOCAL_FILES_DIRECTORY. For development purposes. If blob, they will be stored remotely in the Azure blob container shown in KPIS_STORE_CONTAINER. Mandatory in environments running on k8s. NO, only configurable when running aura-groot locally.
AURA_KPI_TO_DSV_CACHE_TTL number Number with the amount of milliseconds to cache existing requests to calculate their duration. Default: 1800. NO
AURA_KPI_TO_DSV_DELIMITER string Field delimiter to be used in KPIs entities files. Default: | NO. It will break all the analysis and processes running on top of these files.
AURA_KPI_TO_DSV_EXTENSION string Extension to be used in KPIs entities files.Default: txt NO. If changed without changing aura-kpi-uploader, the files will not be uploaded to Kernel.
AURA_KPIS_BLOB_STORE_INTERVAL number Time interval in milliseconds to upload asyncrhonously logs to the KPIS_STORE_CONTAINER. Default: 60000. Only needed if KPI_STORE_MODE==blob. NO. In pre/production, it must be blob so the files will be uploaded to Kernel instance afterwards. Setting file for development is recommended.
AURA_KPIS_LOG_API_REQUEST_BODY boolean Flag to log or not the request body of the API calls. Default: true YES. Once disabled, to enable run performance tests to validate if it is possible to write them.
AURA_KPIS_LOG_API_RESPONSE_BODY boolean Flag to log or not the response body of the API calls. Default: true YES. Once disabled, to enable run performance tests to validate if it is possible to write them.
AURA_KPIS_STORE_CONTAINER string The name of the Azure Blob container to store KPIs entities files. By default, aura-kpis. It MUST be the same than the one configured in KPIS_UPLOADER module. Only needed if KPI_STORE_MODE==blob. NO. If changed without changing aura-kpi-uploader, the files will not be uploaded to Kernel.
AURA_LOCALE_FOLDER string Full path to the local folder where locale files are stored. By default, ./locale. NO
AURA_LOCALE_FORCE_IMPORT boolean true if locale remote loading must be carried out although there were validation errors. By default, false. YES
AURA_LOCALE_REMOTE_CONTAINER string Name of the Azure Storage Blob Container where the locale files will be stored. By default, static-resources. NO
AURA_LOCALE_REMOTE_CONTAINER_PREFIX string Path within AURA_LOCALE_REMOTE_CONTAINER where the locale files are stored. By default, locale. NO
AURA_LOGGING_FORMAT string Format to be used in monitoring logs: json or dev(more visual format). By default, json. NO. Only for development, set it to dev.
AURA_LOGGING_LEVEL string Level to be used in monitoring logs, from more to less verbose: 'TRACE', 'DEBUG', 'INFO', 'WARN', 'ERROR', 'FATAL', 'OFF'. By default, INFO. YES, for development set it to DEBUG. In pre/production should be INFO or ERROR. For analysis of an issue in pre/production it may be changed to DEBUG.
AURA_MAKEUP_MODE string Allow dev mode of the make-up with the value local. By default, full. NO, only for development, set it to local.
AURA_MAX_HISTORY_CHAT_ITERATIONS number Number of history chat iterations saved in conversation history. By default, 6 NO
AURA_MESSAGES_REQUEST_PATH string Path exposed to receive incoming messages. By default, /api/messages NO
AURA_MICROSOFT_APP_ID string ID of the Microsoft bot application to be used in the deployment. NO. Only if Operations Team changes it.
AURA_MICROSOFT_APP_PASSWORD string Password of the Microsoft bot application to be used in the deployment. NO. It must be changed by Operations Team.
AURA_MICROSOFT_APP_TYPE string Type of the Microsoft bot application to be used in the deployment. By default: MultiTenant NO. Only if Operations Team changes it.
AURA_MICROSOFT_APP_TENANT_ID string Tenant ID of the Microsoft bot application to be used in the deployment. NO. Only if operations team changes it.
AURA_MICROSOFT_AZURE_STORAGE_COMMON_ACCESS_KEY string Microsoft Storage password of the common storage. Currently used for KPI storing. NO. Only if Operations Team changes it.
AURA_MICROSOFT_AZURE_STORAGE_COMMON_ACCOUNT string Microsoft Storage account of the common storage. Currently used for KPI storing. NO. Only if Operations Team changes it.
AURA_MICROSOFT_AZURE_STORAGE_ACCESS_KEY string Microsoft Storage password of the deployment. NO. It must be changed by Operations Team.
AURA_MICROSOFT_AZURE_STORAGE_ACCOUNT string Microsoft Storage account of the environment. NO. It must be changed by Operations Team.
AURA_MICROSOFT_AZURE_STORAGE_CONFIGURATION_CONTAINER string Name of the container where basic bot configuration files are stored: Mongo indexes descriptor, aura-behavior-manager configuration, etc. By default, aura-configuration. NO
AURA_MIDDLEWARE_SPEAK_PROCESSOR string Used to enable speak property text substitution on the outgoing messages, to produce speakable text. Regular expression of substitution format example: [["\\*"," asterisk "],["\\#"," hash "]] YES. It includes all the needed changes to be done automatically between the written and the spoken text.
AURA_MONGODB_BOT_COLLECTION_CONTEXT_INDEX_TTL number Number of seconds to keep the context data available in aura-groot context cache. By default, 3600. NO
AURA_MONGODB_BOT_COLLECTION_CONTEXT string MongoDB collection name where aura-groot will store the context of the users. By default, aura-context. NO
AURA_MONGODB_BOT_DATABASE string MongoDB database name where aura-groot will store all the data needed to handle requests. By default, aura-groot. NO
AURA_MONGODB_CACHE_TTL number Lifetime of cache used by aura-behavior-manager. It MUST be disabled in PRE and PRO environments. By default, 3600 seconds (1h). YES, only for development environments.
AURA_MONGODB_CACHE_DATABASE string Database used in cache of aura-behavior-manager. By default, aura-groot-caches. YES, only for development environments.
AURA_MONGODB_CACHE_COLLECTION_DL string Collection used in cache of aura-behavior-manager. By default, dev-cache. YES, only for development environments.
AURA_MONGODB_CACHE_INDEX_DL string Index used in TwoLevelsCache of aura-behavior-manager. By default, id. YES, only for development environments.
AURA_MONGODB_CACHE_METRIC_TTL number Lifetime of metric cache. By default, 60 seconds (1 minute). YES.
AURA_MONGODB_CACHE_METRIC_COLLECTION string Collection used in metric-cache. By default, metric-cache. YES
AURA_MONGODB_CACHE_METRIC_INDEX string Index used in TwoLevelsCache of metric-cache. By default, correlator. YES
AURA_MONGODB_PASSWORD string MongoDB password to access AURA_MONGODB_BOT_DATABASE in AURA_MONGODB_URI. NO
AURA_MONGODB_POOL_SIZE number Number of connections available in MongoDB pool. By default, 60. NO
AURA_MONGODB_SSL boolean true if access to AURA_MONGODB_URI is SSL. By default, false. NO
AURA_MONGODB_URI string MongoDB URI of the server handling. AURA_MONGODB_BOT_DATABASE. NO
AURA_MONGODB_USERNAME string MongoDB username to access AURA_MONGODB_BOT_DATABASE in AURA_MONGODB_URI. NO
AURA_MONGODB_MAX_POOL_SIZE number Maximum number of connections in the MongoDB pool. By default, 60. NO
AURA_MONGODB_MIN_POOL_SIZE number Minimum number of connections in the MongoDB pool. By default, 2. NO
AURA_MONGODB_MAX_IDLE_TIME_MS number Maximum idle time in milliseconds for connections in the MongoDB pool. By default, 30000 (30 seconds). NO
AURA_MONGODB_RETRY_WRITES boolean true if retry writes are enabled in the MongoDB connection. By default, true. NO
AURA_MONGODB_RETRY_READS boolean true if retry reads are enabled in the MongoDB connection. By default, true. NO
AURA_MONGODB_HEARTBEAT_FREQUENCY_MS number Frequency in milliseconds of the heartbeat in the MongoDB connection. By default, 2000 (2 seconds). NO
AURA_MONGODB_SERVER_SELECTION_TIMEOUT_MS number Timeout in milliseconds for server selection in the MongoDB connection. By default, 5000 (5 seconds). NO
AURA_MONGODB_SOCKET_TIMEOUT_MS number Timeout in milliseconds for socket operations in the MongoDB connection. By default, 45000 (45 seconds). NO
AURA_CONNECTION_TIMEOUT_MS number Timeout in milliseconds for establishing a connection to the MongoDB server. By default, 10000 (10 seconds). NO
AURA_MONGODB_READ_PREFERENCE string Read preference for the MongoDB connection. By default, primaryPreferred. Possible values: primary, primaryPreferred, secondary, secondaryPreferred, nearest. NO
AURA_REQUEST_ENABLE_NAGLE boolean Boolean to enable Nagle. By default: false. NO
AURA_REQUEST_TIMEOUT number Number of milliseconds to wait a request. By default: 30000, 30 seconds. YES, in case of network issues.
AURA_SERVER_BODY_LIMIT string Maximum size in bytes of the request body. It is a string because the allowed values must indicate the units: 10 mb, 200 kb, etc. By default, 20 mb. YES, in order to decrease it, if it is considered too high. To increase it, both local and global Operational Teams must review it, because it could lead to DDoS attacks easily.
AURA_SERVER_PORT number Port where aura-groot will be listening to requests. By default, 8080. NO
AURA_SERVICE_ENVIRONMENT string Type of environment: 'DEV', 'PRE', 'PRO'. By default, DEV. It is used during locale translation, to get the correct text reference and, in development environments, to allow aura-behavior-manager execution. NO
AURA_SERVICE_URL_DIRECTLINE string Default URL for Direct Line services. By default, https://directline.botframework.com/. NO
AURA_SHUTDOWN_GRACEFUL_TTL number Number of milliseconds to wait until all aura-groot tasks are done before shutting each pod down. By default 25000 (25 seconds) NO
AURA_SKILLS_BLOCKED_TIMEOUT number Number of seconds to block a skill after a timeout. By default, 600 (10 minutes). NO
AURA_SKILLS_RESPONSE_PATH string Path where the skills will return the answers. By default, /api/skills. NO
AURA_SUPERAGENT_DEADLINE_TIMEOUT number Number of milliseconds to wait until the superagent deadline timeout, as specified here. It is optional and, by default, is not configured. No, only changed if the Global Team or the LCDO Dev Team requires it.
AURA_SUPERAGENT_RESPONSE_TIMEOUT number Number of milliseconds to wait until the superagent response timeout, as specified here. It is optional and, by default, it is not configured. No, only changed if the Global Team or the LCDO Dev Team requires it.
AURA_SUPERAGENT_RETRY_ATTEMPTS number Number of retry attempts (not counting the first attempt) to be applied on superagent requests, as specified here. It is optional and, by default, it is not configured. No, only changed if the Global Team or the LCDO Dev Team requires it.
AURA_RETRIES_CODES string[] Array of strings with error codes. By default, [‘ECONNRESET’] NO, except if requested
AURA_VERSION string Number of the Aura release being executed. NO
AURA_HTTP_PATHS_LOG_DISABLED string HTTP paths separated by commas which requests would not be logged. By default: aura-kpis,static-resources. Used in http-monkey-patcher. YES, if there is a path that is not wanted to be logged. The default values are always added to the provided list.
DEV_AURA_BEHAVIOR_MANAGER_ACTIVE boolean Flag to indicate whether or not aura-behavior-manager module should be activated in the current deployment. It is only valid for development environments. YES, in development environments.
DEV_AURA_GROOT_BEHAVIOR_CRON_PATTERN string Cron pattern to set the refresh time of aura-behavior-manager configuration. By default, */5 * * * * (every 5 minutes). It is only valid for development environments. YES, in development environments.
DEV_AURA_GROOT_BEHAVIOR_MICROSOFT_AZURE_STORAGE_SETTINGS_FILE string Name of the configuration file route used by aura-behavior-manager. By default, aura-groot/aura-groot-behavior-manager.json. It is only valid for development environments. YES, in development environments
Last modified November 11, 2025: feat: Clean up of Living Apps related stuff #AURA-30761 [RTM] (c97ca748)