In this article, we'll show you which Helm values in the Virtru Email Gateway chart set each environment variable. Use it together with Customer Hosted: Environment Variables, which describes what each variable does.
Jump to:
- Variables in values.yaml
- Secrets in appSecrets
- Recommended TLS settings
- inboundRelayAddresses values for Gmail and Office 365
- Additional Resources
Reference
Variables in values.yaml
Each row maps a values.yaml key to the environment variable the chart sets. Keys appear with their parent section, exactly as they appear in values.yaml. Some keys refer to Transport Layer Security (TLS), Simple Authentication and Security Layer (SASL), DomainKeys Identified Mail (DKIM), CKS (the Virtru Private Keystore for Virtru Solutions), and the Java Virtual Machine (JVM).
Please note:
The chart sets GATEWAY_MODE and GATEWAY_TOPOLOGY for you. Each enabled entry under gatewayModes gets its own mode and topology, so you don't set them directly.
values.yaml key |
Environment variable |
|---|---|
standardConfig.gatewayHostname |
GATEWAY_HOSTNAME |
standardConfig.primaryMailingDomain |
GATEWAY_ORGANIZATION_DOMAIN |
standardConfig.gatewayTransportMaps |
GATEWAY_TRANSPORT_MAPS |
standardConfig.inboundRelayAddresses |
GATEWAY_RELAY_ADDRESSES |
standardConfig.headers.xHeaderAuthEnabled |
GATEWAY_XHEADER_AUTH_ENABLED |
additionalConfig.saslAuth.smtpDownstream.enabled |
GATEWAY_SMTP_SASL_ENABLED_DOWNSTREAM |
additionalConfig.saslAuth.smtpDownstream.securityOptions |
GATEWAY_SMTP_SASL_SECURITY_OPTIONS |
additionalConfig.saslAuth.smtpdUpstream.enabled |
GATEWAY_SMTPD_SASL_ENABLED |
additionalConfig.saslAuth.smtpdUpstream.mechanisms |
GATEWAY_SMTPD_SASL_MECHANISMS |
additionalConfig.maxQueueLifetime |
MAX_QUEUE_LIFETIME |
additionalConfig.maxBackoffTime |
MAX_BACKOFF_TIME |
additionalConfig.minBackoffTime |
MIN_BACKOFF_TIME |
additionalConfig.queueRunDelay |
QUEUE_RUN_DELAY |
additionalConfig.smtpdUseTls |
GATEWAY_SMTPD_USE_TLS |
additionalConfig.smtpdSecurityLevel |
GATEWAY_SMTPD_SECURITY_LEVEL |
additionalConfig.smtpdTlsComplianceUpstream.enabled |
Turns on GATEWAY_SMTPD_TLS_COMPLIANCE_UPSTREAM
|
additionalConfig.smtpdTlsComplianceUpstream.compliance |
GATEWAY_SMTPD_TLS_COMPLIANCE_UPSTREAM |
additionalConfig.smtpUseTls |
GATEWAY_SMTP_USE_TLS |
additionalConfig.smtpSecurityLevel |
GATEWAY_SMTP_SECURITY_LEVEL |
additionalConfig.smtpTlsComplianceDownstream.enabled |
Turns on GATEWAY_SMTP_TLS_COMPLIANCE_DOWNSTREAM
|
additionalConfig.smtpTlsComplianceDownstream.compliance |
GATEWAY_SMTP_TLS_COMPLIANCE_DOWNSTREAM |
additionalConfig.cks.keyProvider |
GATEWAY_ENCRYPTION_KEY_PROVIDER |
additionalConfig.cks.sessionKeyExpiry |
GATEWAY_CKS_SESSION_KEY_EXPIRY_IN_MINS |
additionalConfig.dlpRuleCache |
GATEWAY_DLP_CACHE_DURATION |
additionalConfig.tlsPolicyMaps.enabled |
Turns on GATEWAY_SMTP_TLS_POLICY_MAPS
|
additionalConfig.tlsPolicyMaps.policyMaps |
GATEWAY_SMTP_TLS_POLICY_MAPS |
additionalConfig.replaceFromEnabled |
GATEWAY_REPLACEMENT_FROM_ENABLED |
additionalConfig.decryptPfpFiles |
GATEWAY_DECRYPT_PERSISTENT_PROTECTED_ATTACHMENTS |
additionalConfig.decryptThenEncrypt |
GATEWAY_DECRYPT_THEN_ENCRYPT |
additionalConfig.proxyProtocol |
GATEWAY_PROXY_PROTOCOL |
additionalConfig.verboseLogging |
GATEWAY_VERBOSE_LOGGING |
additionalConfig.cacheSmtpConnections.enabled |
GATEWAY_SMTP_CACHE_CONNECTIONS |
additionalConfig.cacheSmtpConnections.connectionCacheTimeLimit |
GATEWAY_SMTP_CONNECTION_CACHE_TIME_LIMIT |
additionalConfig.dkimSigning.enabled and additionalConfig.dkimSigning.selector
|
GATEWAY_DKIM_DOMAINS, built as <selector>._domainkey.<primaryMailingDomain>
|
proxyConfig.httpProxyHost and proxyConfig.httpProxyPort
|
GATEWAY_HTTP_PROXY_HOST and GATEWAY_HTTP_PROXY_PORT. The chart sets each one only when you give it a value. |
proxyConfig.httpsProxyHost and proxyConfig.httpsProxyPort
|
GATEWAY_HTTPS_PROXY_HOST and GATEWAY_HTTPS_PROXY_PORT. The chart sets each one only when you give it a value. |
jvmConfig.initialHeapSize |
Adds -Xms to GATEWAY_JAVA_OPTIONS
|
jvmConfig.maxHeapSize |
Adds -Xmx to GATEWAY_JAVA_OPTIONS
|
jvmConfig.heapDumpOnOOM |
Adds -XX:+HeapDumpOnOutOfMemoryError (true) or -XX:-HeapDumpOnOutOfMemoryError (false) to GATEWAY_JAVA_OPTIONS. null leaves the setting unchanged. |
jvmConfig.heapDumpPath |
Adds -XX:HeapDumpPath to GATEWAY_JAVA_OPTIONS
|
gatewayAccountsUrl |
GATEWAY_ACCOUNTS_URL |
gatewayAcmUrl |
GATEWAY_ACM_URL |
gatewayRemoteContentBaseUrl |
GATEWAY_REMOTE_CONTENT_BASE_URL |
Secrets in appSecrets
Sensitive values go under appSecrets in values.yaml. The chart stores them in a Kubernetes Secret named <release>-secrets, using the secret keys shown below. We recommend an external secrets manager instead of keeping these values in a plain values.yaml file.
appSecrets key |
Secret key | Environment variable |
|---|---|---|
appSecrets.amplitudeToken |
gateway-amplitude-api-key |
GATEWAY_AMPLITUDE_API_KEY. Required. Virtru sends you this value during onboarding. |
appSecrets.gatewayApiTokenName |
gateway-api-token-name |
GATEWAY_API_TOKEN_NAME. Required. This is the name of your hash-based message authentication code (HMAC) token, which Virtru provides. |
appSecrets.gatewayApiSecret |
gateway-api-token-secret |
GATEWAY_API_TOKEN_SECRET. Required. This is the secret for your HMAC token, which Virtru provides. |
appSecrets.headers.xHeaderAuthSecret |
gateway-xheader-auth-secret |
GATEWAY_XHEADER_AUTH_SECRET. Required when standardConfig.headers.xHeaderAuthEnabled is true. |
appSecrets.saslAuth.smtpdUpstream.accounts |
gateway-sasl-auth-upstream |
GATEWAY_SMTPD_SASL_ACCOUNTS. Used when smtpdUpstream.enabled is true. Format: user=>password. |
appSecrets.saslAuth.smtpDownstream.accounts |
gateway-sasl-auth-downstream |
GATEWAY_SMTP_SASL_ACCOUNTS. Used when smtpDownstream.enabled is true. Format: host=>user=>password. |
appSecrets.dkimSigning.publicKey and appSecrets.dkimSigning.privateKey
|
DKIM key files | Used when additionalConfig.dkimSigning.enabled is true. The public key must match the DKIM record in your Domain Name System (DNS). |
Recommended TLS settings
We recommend requiring TLS with the HIGH compliance level on every connection into and out of the Gateway. In values.yaml, set these values:
Forced TLS configuration
# values.yaml (excerpt)
additionalConfig:
smtpdUseTls: true
smtpdSecurityLevel: mandatory
smtpdTlsComplianceUpstream:
enabled: true
compliance: HIGH
smtpUseTls: true
smtpSecurityLevel: mandatory
smtpTlsComplianceDownstream:
enabled: true
compliance: HIGH
Upstream settings (smtpd) apply to connections into the Gateway. Downstream settings (smtp) apply to connections the Gateway makes. For details on each variable, see Customer Hosted: Environment Variables.
inboundRelayAddresses values for Gmail and Office 365
inboundRelayAddresses sets GATEWAY_RELAY_ADDRESSES. To limit which servers can send mail to your Gateway, set it to your mail provider's sending ranges in Classless Inter-Domain Routing (CIDR) notation, and enforce the rest in your firewall.
| Mail provider | CIDR blocks |
|---|---|
| Gmail | 35.190.247.0/24,64.233.160.0/19,66.102.0.0/20,66.249.80.0/20,72.14.192.0/18,74.125.0.0/16,108.177.8.0/21,173.194.0.0/16,209.85.128.0/17,216.58.192.0/19,216.239.32.0/19,172.217.0.0/19,172.217.32.0/20,172.217.128.0/19,172.217.160.0/20,172.217.192.0/19,108.177.96.0/19,35.191.0.0/16,130.211.0.0/22,172.253.56.0/21,172.253.112.0/20 |
| Office 365 | 23.103.132.0/22,23.103.136.0/21,23.103.144.0/20,23.103.198.0/23,23.103.200.0/22,23.103.212.0/22,40.92.0.0/14,40.107.0.0/16,40.107.0.0/17,40.107.128.0/18,52.100.0.0/14,65.55.88.0/24,65.55.169.0/24,94.245.120.64/26,104.47.0.0/17,104.212.58.0/23,134.170.132.0/24,134.170.140.0/24,157.55.234.0/24,157.56.110.0/23,157.56.112.0/24,207.46.51.64/26,207.46.100.0/24,207.46.163.0/24,213.199.154.0/24,213.199.180.128/26,216.32.180.0/23 |