Additional Fine-Tuning via Environment Variables

As an additional layer of flexibility on top of what’s already available as a standard product configuration via CLI and / or WebAdmin, Axigen allows you to further fine tune your deployment through a number of dedicated environment variables.

This article details these environment variables and their effects.

• Axigen Specific Environment Variables
  • AXI_LOG_CURL_RESPONSE_BODY_FOR_PROCESSING_MODULE
  • AXI_WM_2FA_TOKEN_DOWNTIME_AMOUNT
  • AXI_WM_SEND_MAIL_DELAY
  • AXI_ICONV_ENABLE
  • AXI_DISABLE_DNS_ADDITIONAL
  • AXI_SIDX_LOGGING
  • AXI_CAPTCHA_LENGTH
  • AXI_AUTOGEN_FROM_ACCOUNT
  • AXI_DAV_IMPORTER
  • AXI_PROMETHEUS_USER and AXI_PROMETHEUS_PASS
  • AXI_LOG_TIMESTAMP_PRECISION
  • AXI_ACTIVESYNC_V14_DISABLE
  • AXI_TNEF_SRVLVL_DISABLE
• GNU Libc Specific Environment Variables
  • MALLOC_ARENA_MAX
• cURL Specific Environment Variables
  • ALL_PROXY
• OpenSSL Specific Environment Variables
  • OPENSSL_CONF

Axigen Specific Environment Variables

Axigen’s environment variables have to be specified in the service configuration file (e.g. /etc/sysconfig/axigen  for RPM based systems or /etc/default/axigen  for DEB ones).

For faster sys admin recognition, we recommend you to add them at the end of the file. Please note that a service restart is required after any change into the service configuration file, which is why we recommend you to perform these changes during a scheduled maintenance window.

AXI_LOG_CURL_RESPONSE_BODY_FOR_PROCESSING_MODULE

Setting AXI_LOG_CURL_RESPONSE_BODY_FOR_PROCESSING_MODULE to any value (for example to 1), will allow Axigen to write the response body from HTTP requests in the logs, when the request was made from the PROCESSING module and the correct log level is used. When this variable is not set, the response body is not written in the logs (affects BIMI requests).

AXI_WM_2FA_TOKEN_DOWNTIME_AMOUNT

Setting AXI_WM_2FA_TOKEN_DOWNTIME_AMOUNT to an integer value between 0 and 3600 (the value means seconds) will override the implicit value of the downtime amount (currently 10 seconds) when requesting a 2FA token via MailboxAPI

AXI_WM_SEND_MAIL_DELAY

Setting AXI_WM_SEND_MAIL_DELAY to an integer value between 0 and 30 (the value means seconds) will override the implicit value of the delay (currently 15 seconds) when sending a message via MailboxAPI. The delay facilitates the feature of UndoSend and overriding the value will impact it.

AXI_ICONV_ENABLE

On *nix systems, setting AXI_ICONV_ENABLE to any value (for example to 1), will make Axigen fallback to libiconv when converting text between character sets, in case libicu conversion fails

AXI_DISABLE_DNS_ADDITIONAL

When AXI_DISABLE_DNS_ADDITIONAL is set to a particular integer value (e.g. AXI_DISABLE_DNS_ADDITIONAL=1), the DNR module will ignore any data received into ADDITIONAL SECTION (if any).

AXI_SIDX_LOGGING

When AXI_SIDX_LOGGING is set to any value (for example to 1), additional logging under the JOBLOG will be collected.

AXI_CAPTCHA_LENGTH

When AXI_CAPTCHA_LENGTH is set to a particular integer value (e.g. AXI_CAPTCHA_LENGTH=4), the captcha string length will be set to that number of characters (the default length is 8).

AXI_AUTOGEN_FROM_ACCOUNT

When AXI_AUTOGEN_FROM_ACCOUNT is set to any value (for example to 1), the auto generated messages (like the Out-of-Office auto-responder, Identity Confirmation, or the ones specific to Credentials Recovery) will use the account specific address (instead of using the postmaster account) as the MAIL FROM envelope address.

AXI_DAV_IMPORTER

When AXI_DAV_IMPORTER is set to any value (for example to 1), the scheduling sequence will be disabled for newly added events via the CalDAV protocol (like the situation when someone is importing events from one account to another one).

AXI_PROMETHEUS_USER and AXI_PROMETHEUS_PASS

When these variables are set, the basic HTTP authentication required for accessing the Prometheus metrics is bypassed internally.

AXI_LOG_TIMESTAMP_PRECISION

When this variable is set to any value, the non-syslog log timestamps will have millisecond precision.

When this variable is set to any value, the non-syslog log timestamps will have microsecond precision.

AXI_ACTIVESYNC_V14_DISABLE

Setting AXI_ACTIVESYNC_V14_DISABLE to any value (for example to 1) will downgrade the ActiveSync protocol used by Axigen to version 12.1.

AXI_TNEF_SRVLVL_DISABLE

Setting AXI_TNEF_SRVLVL_DISABLE to 1 will remove the TNEF Decoder filter from the list of server active filters. This will allow the filter to be disabled at server level, but enabled granularly (if needed) at domain level.

GNU Libc Specific Environment Variables

MALLOC_ARENA_MAX

Specifies the maximum number of arenas that can be created. An arena represents a pool of memory that can be used by malloc (and similar) calls to service allocation requests. Arenas are thread safe and therefore may have multiple concurrent memory requests. There is a trade-off between the number of threads and the number of arenas – the more arenas defined, the lower the per-thread contention, but the higher the memory usage.

Typical usage example:

cURL Specific Environment Variables

ALL_PROXY

In cases where external HTTP access is allowed only via a dedicated HTTP proxy, the built-in Let's Encrypt client and the WebAdmin updates checker and contact support components will work only if the ALL_PROXY environment variable is set accordingly.

Usage example:

OpenSSL Specific Environment Variables

If an application wishes to alter the default configuration, using the SSL_CONF interface should be considered instead of manually parsing options.

OPENSSL_CONF

For example, you can use the configuration system to start Axigen with an OpenSSL config file that controls the elliptic curves.