| AURA_AUTHORIZATION_HEADER |
string |
Complete authorization header to be sent to aura-groot, with the following format: APIKEY xxxxxx. |
YES, but only if the previous APIKey was deprecated. |
YES |
| AURA_BRIDGE_DIRECTLINE_ACTIONS |
string[] |
Actions that must be forwarded to Directline. By default: ['REDIRECT.COMMAND'] |
YES |
YES |
| AURA_BRIDGE_REMOTE_CONTAINER_PREFIX |
number |
Remote container prefix. By default: aura-bridge. |
NO |
YES |
| AURA_BRIDGE_RETRIES |
number |
Number of retries made by aura-bridge in case of error in an HTTP request. By default: 3. |
NO, only if checked and validated with Aura Global Team. |
YES |
| AURA_BRIDGE_RETRY_DELAY |
number |
Delay between retries in case of error. By default: 100. |
NO, only if checked and validated with Aura Global Team. |
YES |
| AURA_BRIDGE_RETRY_FACTOR |
number |
Factor to multiply delay for every HTTP request retried. By default: 10. |
NO, only if checked and validated with Aura Global Team. |
YES |
| AURA_BRIDGE_SERVER_PORT |
number |
Port to where aura-bridge is listening. By default: 8045. |
NO |
YES |
| AURA_BRIDGE_STARTUP |
string[] |
Tasks executed during start-up. By default: ['readAwaitedMessages']. |
YES |
YES |
| AURA_BRIDGE_TIMEZONE |
string |
Timezone to be included in the channelData sent to aura-bot. By default: Europe/Madrid. |
YES |
YES |
| AURA_BRIDGE_WA_BLACKLISTED_NUMBERS |
Set |
Numbers that are blacklisted and will not be processed by aura-bridge. By default: ``. Example: ’number1,number2,number3' |
YES |
YES |
| AURA_CALLBACK_HEADER |
string |
Deprecated. Name of the HTTP header that contains the endpoint where aura-bridge sends the responses to the current user request. By default: answers-callback. Only for development. |
NO |
YES |
| AURA_CHANNELS_CONFIGURATION_API_ENDPOINT |
string |
Endpoint for aura-configuration-api. |
NO |
YES |
| AURA_DEFAULT_LOCALE |
string |
Culture code to be used by default in the current deployment: de-de, en-gb, es-es, pt-br. |
NO |
YES |
| AURA_ENCRYPTION_ALGORITHM |
string |
Encryption algorithm used to validate the APIKey. By default: aes-256-cbc. |
NO. It would break APIKey validation. |
YES |
| AURA_ENCRYPTION_IV_LENGTH |
number |
Size for the initialization vector used by the encryption algorithm that validates the APIKey. By default: 16. |
NO. It would break APIKey validation. |
YES |
| AURA_ENCRYPTION_IV_POSITION |
number |
Position where to insert the initialization vector in the final string with the encrypted payload. By default: 35. |
NO. It would break APIKey validation. |
YES |
| 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. |
YES |
| AURA_ENVIRONMENT_NAME |
string |
Name of the environment where aura-bridge is deployed. Used during aura-bridge make-up to handle the indexes of the database properly. For example: ap-next, es-dev, de-pre |
NO |
YES |
| AURA_HTTP_KEEP_ALIVE |
boolean |
Use of keep-alive in HTTP connections. Used in monkey-patcher. By default: true. |
NO |
YES |
| AURA_HTTP_KEEP_ALIVE_MSECS |
number |
Number of milliseconds to keep alive HTTP connections. Used in monkey-patcher. By default: 100000. |
NO |
YES |
| AURA_HTTP_KEEP_MAX_SOCKETS |
number |
Maximum number of sockets. Used in monkey-patcher. By default: 200. |
NO |
YES |
| AURA_HTTP_PATHS_LOG_DISABLED |
string |
HTTP paths separated by commas which request wouldn’t be logged. By default aura-kpis,static-resources Used in 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. |
YES |
| AURA_HTTP_MAX_REQUEST_SIZE |
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… By default, 20mb. |
YES 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. |
YES |
| AURA_HTTP_RECOVERABLE_CODES |
string |
List of HTTP codes, separated by commas, that can be retried. By default: 500, 502, 503, 504, 409, 408, 404 |
Only after a careful review involving local and global teams, any of these codes can be considered unrecoverable. |
YES |
| AURA_HTTP_INCOMING_PATHS_LOG_DISABLED |
string |
Comma-separated string with all the incoming paths whose requests should not be logged. By default, /healthz, /metrics, /favicon.ico |
YES |
YES |
| AURA_LOCALE_FOLDER |
string |
Full path to the local folder where locale files are stored. By default: ./locale. |
NO |
YES |
| AURA_LOCALE_FORCE_IMPORT |
boolean |
true if locale remote loading must be carried out although there were validation errors. By default: false. |
YES |
YES |
| AURA_LOCALE_REMOTE_BACKUP |
boolean |
true if after updating locale files with the remote version, a backup of the former local files should be stored in Azure Storage. By default: false. |
YES |
YES |
| AURA_LOCALE_REMOTE_CONTAINER |
string |
Name of the Azure Storage Blob container where the locale files are stored. By default: static-resources. |
NO |
YES |
| AURA_LOCALE_REMOTE_CONTAINER_PREFIX |
string |
Path within AURA_LOCALE_REMOTE_CONTAINER where the locale files are stored. By default: aura-bridge/locale. |
NO |
YES |
| 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. |
YES |
| 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, it should be ‘INFO’ or ‘ERROR’. For analysis of an issue in pre/production, it may be changed to ‘DEBUG’. |
YES |
| AURA_LOGGING_EXTRA_TIME_METRICS |
boolean |
true if the time metrics should be logged in the monitoring logs. By default: false. |
NO |
YES |
| AURA_MAKEUP_MODE |
string |
It allows dev mode for the make-up with the value local. By default: full. |
NO, only for development, set it to local. |
YES |
| AURA_MICROSOFT_AZURE_STORAGE_ACCESS_KEY |
string |
Microsoft Storage password of the deployment. |
NO |
YES |
| AURA_MICROSOFT_AZURE_STORAGE_ACCOUNT |
string |
Microsoft Storage account of the environment. |
NO |
YES |
| AURA_MICROSOFT_AZURE_STORAGE_CONFIGURATION_CONTAINER |
string |
Aura configuration container name. By default: aura-configuration. |
NO |
YES |
| AURA_MICROSOFT_AZURE_STORAGE_STATIC_CONTAINER_NAME |
string |
Name of the container where the static resources are stored. |
NO |
YES |
| AURA_PHONE_COUNTRY_CODE_NU |
string |
Country code of the phone number. By default: 34. |
YES |
YES |
| AURA_QUEUE_MANAGER_AWAITED_MESSAGES_BY_TURN |
number |
Number of messages to be imported by the Awaited Message Agent in each turn. By default: 100. |
NO |
NO |
| AURA_QUEUE_MANAGER_AWAITED_MESSAGES_INTERVAL |
number |
In milliseconds, time interval of a shift for the Awaited Message Agent. By default: 20 * 1000. (20 seg) |
NO |
NO |
| AURA_QUEUE_MANAGER_AWAITED_MESSAGE_TTL |
number |
In milliseconds, maximum lifetime of a message in aura-bridge. After this time, the system will delete the message. By default: 15 * 60 * 1000 (15 min). |
NO |
YES |
| AURA_QUEUE_MANAGER_AWAITED_RETRIES_FACTOR |
number |
Factor to manage the Backoff of the AWAITED Message Agent. The time to consider an AWAITED message will be: currentRetry MAX_PENDING_TIME AWAITED_RETRIES_FACTOR. By default: 0.1. |
NO |
YES |
| AURA_QUEUE_MANAGER_CHECK_QUEUE_INTERVAL_TTL |
number |
In milliseconds, time interval used by the queue manager to check if the queue system has pending messages. If not, it deactivates the service and it will be reactivated when a new message comes in. By default: 1000. |
NO |
YES |
| AURA_QUEUE_MANAGER_CONCURRENT |
number |
Number of messages processed by the memory queue simultaneously. By default: 50. |
NO |
NO |
| AURA_QUEUE_MANAGER_CONCURRENT_FACTOR |
number |
Variable to control the queue execution in blocks. By default: 2. |
NO |
NO |
| AURA_QUEUE_MANAGER_INTERVAL |
number |
In milliseconds, time interval for processing messages in the queue. By default: 200. |
NO |
YES |
| AURA_QUEUE_MANAGER_FORCE_MESSAGE_ORDER |
boolean |
Flag to indicate whether or not aura-bridge outgoing messages order must be assured. By default: false. |
NO |
YES |
| AURA_QUEUE_MANAGER_MAX_PENDING_TTL |
number |
In milliseconds, time when a message is in PENDING status before it is considered AWAITED. By default: 30 * 1000. |
NO |
YES |
| AURA_QUEUE_MANAGER_MAX_PENDING_TTL_MARGIN |
number |
In milliseconds, time margin used by the memory queue to manage the time that a PENDING message has before being discarded and returned to the AWAITEDs system. By default: 5 * 1000. |
NO |
YES |
| AURA_QUEUE_MANAGER_MAX_RETRIES |
number |
Number of validation attempts. Do not confuse with message sending retries. These retries are for the validations that a message makes to see if it can be sent or if it has to continue waiting. By default: 100. |
NO |
YES |
| AURA_QUEUE_MANAGER_MESSAGE_TTL |
number |
In milliseconds, lifetime of an incoming message. By default: 5 * 1000. |
NO |
YES |
| AURA_QUEUE_MANAGER_SENT_MESSAGE_TTL |
number |
In milliseconds, lifetime of a message with status to SENT. If the ACK does not arrive from the client, then the message is considered as sent and is deleted from the system, making way for the next messages that the user has pending. By default: 5 * 1000. |
NO |
YES |
| AURA_QUEUE_MANAGER_METRICS_PARTIAL_INTERVAL |
number |
In milliseconds, when the queue must write a partial summary of its execution cycle. By default: 30 * 1000. |
NO |
YES |
| AURA_REDIS_MODE |
string |
Mode of Redis distribution. Values: CLUSTER, SENTINEL, SINGLE. By default: SENTINEL. |
NO |
YES |
| AURA_REDIS_SENTINEL_INSTANCE_NAME |
string |
Name of the Redis instance. Use in SENTINEL mode. |
NO |
YES |
| AURA_REDIS_HOSTS |
string |
A string with list of nodes separated by ‘,’, including host and port separated by ‘:’. For example: “localhost:port,localhost2:port2”. |
NO |
YES |
| AURA_REDIS_DATABASE |
number |
Database number for SINGLE or SENTINEL mode. By default: 0. |
YES |
YES |
| AURA_REDIS_PASSWORD |
string |
String with Redis password. |
YES |
YES |
| AURA_ENVIRONMENT_PREFIX |
string |
Prefix that will be used by all Redis keys when using redis-connector. This allows mixing in a single Redis service messages coming from different environments in the same Azure subscription. By default: ``. (empty) |
YES |
YES |
| AURA_REDIS_USE_CONNECTION_POOL |
string |
Use pool connections for Redis. By default: true. |
YES |
YES |
| AURA_REDIS_CONNECTION_POOL_MIN |
number |
Minimum number of connections in the pool. By default: 2. |
YES |
YES |
| AURA_REDIS_CONNECTION_POOL_MAX |
number |
Maximum number of connections in the pool. By default: 100. |
YES |
YES |
| AURA_REDIS_MAX_RECONNECT_RETRIES |
number |
Number of retries to connect to Redis. By default: 25 |
YES |
YES |
| AURA_REDIS_MAX_RECONNECT_INTERVAL |
number |
Time in milliseconds to wait before reconnecting to Redis. By default: 5000. |
YES |
YES |
| AURA_REQUEST_TIMEOUT |
number |
Number of seconds to wait for a request. By default: 30 * 1000. |
YES, in case of network issues. |
YES |
| 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. |
NO |
YES |
| AURA_SHUTDOWN_GRACEFUL_TTL |
number |
Time in milliseconds to complete the SHUTDOWN signal and process all the messages in queue before SIGTERM. By default: 25 * 1000. |
YES |
YES |
| AURA_SWAGGER_LOCAL_PATH |
string |
Location of the swagger file generated from all loaded plugins. By default: swagger.yaml. Used during makeup to upload the file to remote. |
NO |
YES |
| AURA_SWAGGER_LOCAL_CORE_PATH |
string |
Location of aura-bridge swagger base file. By default: swagger-core.yaml. |
YES |
YES |
| AURA_SWAGGER_REMOTE_CONTAINER_PREFIX |
string |
Remote container prefix to store the swagger information. By default: aura-bridge/swagger |
YES |
YES |
| AURA_VERSION |
string |
Mandatory, release of Aura. |
NO |
YES |
| BRIDGE_CACHE_MESSAGES_ACK_ACTIVE |
boolean |
Flag to enable/disable the ack messages cache. By default: false |
YES |
YES |
| BRIDGE_CACHE_MESSAGES_ACK_DELETE_WHEN_USED |
boolean |
Removes the ack message from the cache when it is used. By default: true. |
YES |
YES |
| BRIDGE_CACHE_MESSAGES_ACK_TTL |
number |
Time to live of the objects stored in the bridge ack cache messages in seconds. By default: 24 * 60 * 60. |
YES |
YES |
| BRIDGE_EVENT_SERVICE_ACTIVE |
boolean |
Allows to enable/disable the bridge event service. By default: false. |
YES |
YES |
| DEV_AURA_BEHAVIOR_CACHE_TTL |
number |
Maximum lifetime of behavior cache in aura-bridge in seconds. After this time, the system will delete the message. By default: 60 * 60 (60 min). |
YES |
YES |
| DEV_AURA_BEHAVIOR_COMMAND_PATTERN |
string |
Pattern to recognize a behavior command. By default: ^\/bridge(:| +)(get|set|unset)(:| +)(\w+)(:| +)?.+ |
NO in production environments. This feature could only be activated in development environments. |
YES |
| DEV_AURA_BEHAVIOR_MANAGER_ACTIVE |
boolean |
Flag to indicate whether or not behavior-manager module should be activated in the current deployment. It is only valid for development environments. By default: false |
NO in production environments. This feature could only be activated in development environments. |
YES |
| DEV_AURA_BEHAVIOR_SETTINGS_FILE_CRON_PATTERN |
string |
CRON expression associated with the reload time of the configuration file. Configuration file is defined in: DEV_AURA_BEHAVIOR_SETTINGS_FILE_MICROSOFT_AZURE_STORAGE. By default: *\/5 * * * *. |
NO in production environments. This feature could only be activated in development environments. |
YES |
| DEV_AURA_BEHAVIOR_SETTINGS_FILE_MICROSOFT_AZURE_STORAGE |
string |
Profile configuration file location for the behavior-manager. By default: aura-bridge/aura-bridge-behavior-manager.json |
NO in production environments. This feature could only be activated in development environments. |
YES |