在 AWS Wickr 中設定資料保留機器人的環境變數 - AWS Wickr

本指南提供 AWS Wickr 的文件。對於內部部署版本的 Wickr Enterprise，請參閱企業管理指南 。

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

在 AWS Wickr 中設定資料保留機器人的環境變數

您可以使用下列環境變數來設定資料保留機器人。當您執行資料保留機器人 Docker 映像時，您可以使用 -e選項設定這些環境變數。如需詳細資訊，請參閱啟動 Wickr 網路的資料保留機器人。

注意

除非另有說明，否則這些環境變數為選用。

使用下列環境變數來指定資料保留機器人憑證：

  • WICKRIO_BOT_NAME — 資料保留機器人的名稱。當您執行資料保留機器人 Docker 映像時，需要此變數。

  • WICKRIO_BOT_PASSWORD — 資料保留機器人的初始密碼。如需詳細資訊，請參閱設定 AWS Wickr 資料保留的先決條件。如果您不打算使用密碼提示啟動資料保留機器人，或者不打算使用 Secrets Manager 來儲存資料保留機器人憑證，則需要此變數。

使用下列環境變數來設定預設資料保留串流功能：

  • WICKRIO_COMP_MESGDEST – 將串流訊息的目錄路徑名稱。預設值為 /tmp/<botname>/compliance/messages。

  • WICKRIO_COMP_FILEDEST – 要串流檔案的目錄路徑名稱。預設值為 /tmp/<botname>/compliance/attachments。

  • WICKRIO_COMP_BASENAME – 接收的訊息檔案的基本名稱。預設值為 receivedMessages。

  • WICKRIO_COMP_FILESIZE – 以 KB （KiB ） 為單位的已接收訊息檔案檔案大小上限。達到大小上限時，就會啟動新的檔案。預設值為 1000000000，如 1024 GiB 所示。

  • WICKRIO_COMP_TIMEROTATE – 資料保留機器人將接收訊息放入接收訊息檔案中的時間，以分鐘為單位。當達到時間限制時，就會啟動新的檔案。您只能使用檔案大小或時間來限制接收訊息檔案的大小。預設值為 0，無限制。

使用下列環境變數來定義 AWS 區域 要使用的預設值。

  • AWS_DEFAULT_REGION – AWS 區域 用於 Secrets Manager 等 AWS 服務的預設值 （不適用於 Amazon S3 或 AWS KMS）。如果未定義此環境變數，則依預設會使用us-east-1區域。

當您選擇使用 Secrets Manager 來存放資料保留機器人憑證 AWS 和服務資訊時，請使用下列環境變數來指定要使用的 Secrets Manager 秘密。如需有關您可以儲存在 Secrets Manager 中的值的詳細資訊，請參閱 AWS Wickr 的 Secrets Manager 值。

  • AWS_SECRET_NAME – Secrets Manager 秘密的名稱，其中包含資料保留機器人所需的憑證 AWS 和服務資訊。

  • AWS_SECRET_REGION – AWS 區域 AWS 機密所在的 。如果您使用的是 AWS 秘密，但未定義此值，則會使用該AWS_DEFAULT_REGION值。

注意

您可以在 Secrets Manager 中將下列所有環境變數儲存為值。如果您選擇使用 Secrets Manager，並將這些值存放在該處，則您在執行資料保留機器人 Docker 映像時不需要將它們指定為環境變數。您只需指定本指南前面所述的AWS_SECRET_NAME環境變數。如需詳細資訊，請參閱AWS Wickr 的 Secrets Manager 值。

當您選擇將訊息和檔案儲存到儲存貯體時，請使用下列環境變數來指定 Amazon S3 儲存貯體。

  • WICKRIO_S3_BUCKET_NAME – 存放訊息和檔案的 Amazon S3 儲存貯體名稱。

  • WICKRIO_S3_REGION – 存放訊息和檔案的 Amazon S3 儲存貯體 AWS 區域。

  • WICKRIO_S3_FOLDER_NAME – Amazon S3 儲存貯體中儲存訊息和檔案的選用資料夾名稱。此資料夾名稱前面會加上儲存到 Amazon S3 儲存貯體的訊息和檔案的索引鍵。

當您選擇使用用戶端加密將檔案儲存至 Amazon S3 儲存貯體時，請使用下列環境變數來指定 AWS KMS 詳細資訊。

  • WICKRIO_KMS_MSTRKEY_ARN – AWS KMS 主金鑰的 Amazon Resource Name （ARN），用於在儲存至 Amazon S3 儲存貯體之前，重新加密資料保留機器人上的訊息檔案和檔案。

  • WICKRIO_KMS_REGION – 主金鑰所在的 AWS 區域 AWS KMS 。

當您選擇將資料保留事件傳送至 Amazon SNS主題時，請使用下列環境變數來指定 Amazon SNS詳細資訊。傳送的事件包括啟動、關閉以及錯誤條件。

  • WICKRIO_SNS_TOPIC_ARN – 您要傳送資料保留事件的 ARN Amazon SNS主題。

使用下列環境變數將資料保留指標傳送至 CloudWatch。如果指定，則會每 60 秒產生一次指標。

  • WICKRIO_METRICS_TYPE – 將此環境變數的值設定為 cloudwatch，以將指標傳送至 CloudWatch。