chat-web environment variables

values.yaml file environment variables values are not encrypted and mounted as regular env vars in chat-web pod(s).

secrets.yaml file contents are encrypted using helm secrets plugin, see 6.3. and previous section.

Tip: check file examples provided by HighSide Support for more clarity on this matter.

MySQL configuration (required)

  • CHAT_DB_HOST: MySQL server DNS hostname (string)

  • CHAT_DB_NAME: MySQL Database name (string)

  • CHAT_DB_PASS: MySQL server user password (string)

  • CHAT_DB_USER: MySQL server user name (string)

  • CHAT_DB_USE_TLS: Use TLS connection for MySQL service (default false) (boolean)

  • CHAT_DB_CA_CERTS: CA certificate(s) path for MySQL service TLS connection (default /etc/ssl/certs/ca-certificates.crt) (boolean)

Redis configuration (required)

  • CHAT_REDIS_HOST: Redis service DNS hostname (string)

  • CHAT_REDIS_PORT: Redis service port (e.g., 6379) (string)

  • CHAT_REDIS_PASSWORD: Redis service password (string)

  • CHAT_REDIS_USE_TLS: Use TLS connection for Redis service (default false) (boolean)

  • CHAT_REDIS_CA_CERTS: CA certificate(s) path for Redis service TLS connection (default /etc/ssl/certs/ca-certificates.crt) (boolean)

  • CHAT_REDIS_DB: 0 unless especified by HighSide support (default 0) (string)

SMTP configuration (required)

  • CHAT_SMTP_USER: SMTP user name (e.g., [email protected]) (string)

  • CHAT_SMTP_PASS: SMTP user password (string)

  • CHAT_SMTP_PORT: SMTP server port (e.g., 25, 587) (string)

  • CHAT_SMTP_USE_TLS: If TLS is required for SMTP server. Default true if not set (boolean)

  • CHAT_FROM_EMAIL_ADDRESS: email address that the application will use to send email invitations and other communications (e.g., [email protected]) (string)

  • CHAT_SYSADMIN_EMAIL_ADDRESS: Admin email address to receive notifications and alerts from the application (e.g., [email protected]) (string)

SecureDrive (required)

  • CHAT_S3_ACCESS_ID: S3 (or equivalent blob storage service) access ID or account ID (string)

  • CHAT_S3_SECRET_KEY: S3 (or equivalent blob storage service) secret key or password (string)

  • CHAT_S3_REGION_CODE: The AWS region where your bucket is located. Default region is us-east-1, which is the US East (N. Virginia) Region. (string)

  • CHAT_SECUREDRIVE_BUCKET_NAME: S3 (or equivalent) bucket name for SecureDrive (string)

Session cookie configuration (required)

  • CHAT_SESSION_COOKIE_SECURE: Default false if not set (boolean)

  • CHAT_SESSION_COOKIE_DOMAIN_PROTOCOL_TYPE: Default http if not set (string)

  • CHAT_SESSION_COOKIE_DOMAIN: Set to chat-web hostname, example chatweb.domain.com (string)

  • CHAT_SESSION_COOKIE_DOMAIN_BASE_URL: Example http://chatweb.domain.com (string)

SNS variables (optional)

Used to send invites and 2FA codes to mobile users through AWS Simple Notification Service. Requires a valid AWS account with SNS service access. Incurrs in billing charges to that account.

  • CHAT_SNS_ACCESS_ID: Amazon AWS account with SNS permissions Access ID (string)

  • CHAT_SNS_SECRET_KEY: Amazon AWS account with SNS permissions Secret Key (string)

  • CHAT_SNS_REGION_CODE: Amazon AWS SNS service region. Default us-east-1 (string)

Miscellaneous configuration variables (required unless specified otherwise)

  • CHAT_CALL_JIB_HOST: Voice & Video join-in-browser call server DNS hostname (e.g., call.domain.com) (string)

  • CHAT_ENVIRONMENT_TYPE: Use onprem as value (string)

  • CHAT_FCM_API_KEY: Firebase Cloud Messaging API key, used for mobile push notifications. Request a key from HighSide Support. (string)

  • CHAT_FLAVOR: For HighSide Support internal use only. Default highside, do not change unless instructed by HighSide Support (string)

  • CHAT_GIPHY_API_KEY: Giphy service API Key for including gifs in channels and chats. Request a key from HighSide Support. (string) (optional)

  • CHAT_HIGHSIDE_API_ACCESS_KEY: HighSide service API Access Key. Request key value from HighSide Support. (string)

  • CHAT_HIGHSIDE_API_SECRET_KEY: HighSide service API Secret Key. Request key value from HighSide Support. (string)

  • CHAT_SESSION_SECRET_KEY: For HighSide Support internal use only (string)

  • CHAT_STRIPE_SECRET_KEY: For HighSide Support internal use only. Used for billing purposes. (string)

  • CHAT_SYMMETRIC_ENCRYPTION_KEY: For HighSide Support internal use only (string)

Last updated