Tags:
Categories:

Aura Configuration API environment variables

List of environment variables handled by Aura Configuration API

  • Properties marked in bold are mandatory.
  • Properties marked in italics are optional.
Property Type Description Modifiable by OB?
AURA_BRANDS string[] List of available Telefónica brands configured in Kernel. Check them in the document Telefónica brands management. YES
AURA_CONFIGURATION_APPLICATIONS_COLLECTION string Collection name to store Applications information. By default: applications. NO
AURA_CONFIGURATION_APPLICATIONS_ENCRYPTED_FIELDS string[] List of fields that will be saved encrypted in a application document. By default: ['callback']. YES, but only for adding fields
AURA_CONFIGURATION_CHANNELS_COLLECTION string Collection name to store channel information. By default: channels. NO
AURA_CONFIGURATION_CHANNELS_ENCRYPTED_FIELDS string[] List of fields that will be saved encrypted in a channel document. By default: ['security', 'whatsapp']. YES, but only for adding fields
AURA_CONFIGURATION_COMPONENTS_COLLECTION string Component name to store component information. By default: components. NO
AURA_CONFIGURATION_DATABASE_NAME string Aura channels configuration database name. By default: aura-configuration. NO
AURA_CONFIGURATION_EVENTS_ENABLED boolean Enable or disable the service synchronization by events. true
AURA_CONFIGURATION_MAX_LENGTH_TO_LOG_BODY_FIELD number Maximum characters length to display body field in logs. By default 1024 characters. NO
AURA_CONFIGURATION_SERVER_PORT number Aura channels configuration server port. By default: 8999. NO
AURA_CONFIGURATION_SKILLS_COLLECTION string Collection name to store Skills information. By default: skills. NO
AURA_CONFIGURATION_SKILLS_ENCRYPTED_FIELDS string[] List of fields that will be saved encrypted in a skill document. By default: []. YES, but only for adding fields
AURA_CONTACT_CHANNELS string[] List of contact channels that will be used. YES
AURA_ENCRYPTION_ALGORITHM string Encryption algorithm that will be used to validate the APIKey. By default: aes-256-cbc. NO
AURA_ENCRYPTION_IV_LENGTH number Size for the initialization vector used by the encryption algorithm that validates the APIKey. By default: 16. NO
AURA_ENCRYPTION_IV_POSITION number Position where to insert the initialization vector in the final string with the encrypted payload. By default: 35. NO
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 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
AURA_HTTP_PATHS_LOG_DISABLED string[] Paths to be ignored in the logHttpRequestResponse middleware: By default: ['/metrics']. YES
AURA_HTTP_MAX_REQUEST_SIZE string Maximum size of incoming requests bodies in bytes allowed by the server. By default: 20mb. 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.
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 makeup with the value local. By default: full. NO
AURA_MICROSOFT_AZURE_STORAGE_ACCESS_KEY string Microsoft Storage password of the deployment. NO
AURA_MICROSOFT_AZURE_STORAGE_ACCOUNT string Microsoft Storage account of the environment. NO
AURA_MICROSOFT_AZURE_STORAGE_AVRO_SCHEMAS_FOLDER string Contains the Microsoft Azure Storage Avro schemas folder. Default: ‘avro/schemas’. NO
AURA_MICROSOFT_AZURE_STORAGE_CONFIGURATION_CONTAINER string Aura configuration container name. Default: ‘aura-configuration’. NO
AURA_MONGODB_PASSWORD string MongoDB password to access AURA_MONGODB_BOT_DATABASE in AURA_MONGODB_URI. 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_POOL_SIZE number Number of connections available in MongoDB pool. By default: 60. 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_REDIS_CONFIGURATION_PREFIX String Prefix for the key in Redis used to store configuration values. By default: aura-config:. No
AURA_REDIS_CONNECTION_POOL_MIN Number Minimum number of connections in the pool. Default: 2. No
AURA_REDIS_CONNECTION_POOL_MAX Number Maximum number of connections in the pool. Default: 100.
AURA_REDIS_DATABASE Number Database number for Single or Sentinel mode. By default: 0.
AURA_REDIS_HOSTS String String with a list of nodes (host:port) separated by comma. For example: “localhost:port,localhost2:port2”. Default: ‘127.0.0.0:6379’ No
AURA_REDIS_MAX_RECONNECT_INTERVAL Number Time in milliseconds to wait before reconnecting to Redis. By default: 5000. No
AURA_REDIS_MAX_RECONNECT_RETRIES Number Number of retries to connect to Redis. By default: 25. No
AURA_REDIS_MODE String Mode of Redis distribution. Values: Cluster, Sentinel or Single. By default: Single. No
AURA_REDIS_PASSWORD String A string with the password of Redis. No
AURA_REDIS_SENTINEL_INSTANCE_NAME String Name of the Redis instance. Used in Sentinel mode. No
AURA_REDIS_USE_CONNECTION_POOL Boolean Flag to indicate the use of a connection pool for Redis connections. Default: true. No
AURA_SERVER_REMOTE_CONTAINER_PREFIX string Remote container prefix. Default: aura-configuration-api. NO
AURA_SWAGGER_FROM_REMOTE boolean It indicates that swagger configuration will be loaded from remote. Default: true. NO
AURA_SWAGGER_LOCAL_PATH string Swagger local path. Default: swagger.yaml. NO
AURA_SWAGGER_PLUGIN_PATH string Swagger plugin path. Default: swagger.yaml. NO
AURA_SWAGGER_LOCAL_CORE_PATH string Swagger local core path. Default: swagger-core.yaml. NO
AURA_SWAGGER_REMOTE_CONTAINER_PREFIX string Remote container prefix to store the swagger information. Default: swagger. NO
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
AURA_VERSION string Aura release NO
Last modified November 11, 2025: feat: Clean up of Living Apps related stuff #AURA-30761 [RTM] (c97ca748)