chat-server Environment Variables

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

secrets.yaml file environment variables values are encrypted using helm secrets plugin, see 5.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)

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)

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) (string)

• CHAT_SMTP_USE_TLS: If SSL 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: Support email address to receive notifications and alerts from the application (e.g., [email protected]) (string)

SecureDrive (required)

• CHAT_ATTACHMENTS_BUCKET_NAME: S3 (or equivalent blob storage service) bucket name for chat attachments (string)

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

• 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: AWS region where your S3 bucket is located. Default region is us-east-1. This value is not required when other blob storage service (MinIO) is used (string)

Task server (required)

Only one instance per cluster must be enabled. This is controlled by following environment variables:

• CHAT_RUN_HOURLY_TASKS: default true (boolean). Set to false to disable scheduled tasks in chat-server instances.

• CHAT_RUN_RELAY_SERVER: default true (boolean). WARNING!: setting this to false will disable chat-server relay function. i.e.: it won't connect with HighSide clients.

MinIO install (optional)

• MINIO_GATEWAY: Whether MinIO blob storage gateway is enabled, this depends if you have an S3 or S3 compatible bucket for storage. Default false (boolean)

• MINIO_GATEWAY_HOST_URL: URL of MinIO blob storage gateway with protocol type (http/https). (string)

Use CHAT_S3_ACCESS_ID (as username) and CHAT_S3_SECRET_KEY (as password) variables from SecureDrive section above to authenticate with blob storage.

SNS variables (optional)

Used to send SMS notifications 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 Access ID (string)

• CHAT_SNS_SECRET_KEY: Amazon AWS account Secret Key (string)

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

Miscellaneous configuration variables (required unless especified otherwise)

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

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

• CHAT_EXPECT_PROXY_PROTOCOL_HEADER: If you are operating behind a load balancer that inserts a proxy protocol header into the beginning of the TCP stream, set this to 1. If not, set to 0. (default 0 ) (int)

• CHAT_ENVIRONMENT_TYPE: Use onprem as value (string)

• CHAT_GOOGLE_MAPS_API_KEY: Google Maps service API Key (string)

• CHAT_HIGHSIDE_API_ACCESS_KEY: HighSide service API Access Key (string)

• CHAT_HIGHSIDE_API_SECRET_KEY: HighSide service API Secret Key (string)

• CHAT_HOSTNAME: chat-server DNS hostname (e.g., chat-server.domain.com) (string)

• CHAT_LOCAL_STORAGE_SEED: VERY IMPORTANT KEY. Do not lose this key or reset its value at any point in the future. You will no longer be able to decrypt / access messages on desktop clients if you do that. Backup safely after generating it.

  Value can be generated using this Python script (string)

  import os
  import binascii
  print(binascii.hexlify(os.urandom(64)))

  Example output (Python version <= 2.7.18): (obsolete)

  4a4f5f77baa2b866bdf8938bc63cf8f7d39614444633e0722b2a274abd2a74aa
  3fb795c5a87314fb3b0d3a8363bc9f34890122377b04ec163a20f07f7a76ec19

  Example output (Python version >= 3.0.1):

  b'abf4d13941f0f2bb5bfd52faa74b9e01ad72b71d421a07f4369b02603dcc78a
  94db3a08c193cb50ab97cb5c60b8989c9dda6e194d035b4e1f174eb2edf45a969'

  Important: Use the single quoted string (i.e.: discard b character and copy the rest of the string in single quotes).

• CHAT_MAX_MIND_ACCOUNT_ID: MaxMind geolocation service Account ID. See https://dev.maxmind.com/geoip/geolite2-free-geolocation-data for instructions(string) (optional)

• CHAT_MAX_MIND_LICENSE_KEY: MaxMind geolocation service License Key. See https://dev.maxmind.com/geoip/geolite2-free-geolocation-data for instructions (string) (optional)

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

• CHAT_WEB_HOST: Full URL of chat-web with protocol type (http/https), (e.g., https://chat-web.domain.com) (string)