在 AWS Wickr 中配置数据保留机器人的环境变量 - AWS Wickr

本指南提供了 AWS Wickr 的文档。有关 Wickr Enterprise（即 Wickr 的本地版本），请参阅《企业管理指南》。

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

在 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：以 kibibyte (KiB) 为单位的已接收消息文件的最大文件大小。当大小达到最大时，将启动一个新文件。默认值为 1000000000，如 1024 GiB。

  • WICKRIO_COMP_TIMEROTATE：数据留存机器人将收到的消息放入收到的消息文件的时间长度，以分钟为单位。当达到时间限制时，将启动一个新文件。您只能使用文件大小或时间来限制收到的消息文件的大小。默认值为 0，因为没有限制。

使用以下环境变量来定义 AWS 区域 要使用的默认变量。

  • AWS_DEFAULT_REGION— Secrets Manager 等 AWS 服务的默认值 AWS 区域 （不用于亚马逊 S3 或 AWS KMS）。如果未定义此环境变量，则默认使用 us-east-1 区域。

使用以下环境变量指定在选择使用 Secrets Manager 存储数据保留机器人凭据和 AWS 服务信息时要使用的 Secrets Manager 密钥。有关可以在 Secrets Manager 中存储的值的更多信息，请参阅 AWSWickr 的 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 环境变量即可。有关更多信息，请参阅 AWSWickr 的 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 资源名称 (ARN)，用于在消息文件和数据保留机器人上的文件保存到 Amazon S3 存储桶之前对其进行重新加密。

  • WICKRIO_KMS_REGION— AWS KMS 主密钥所在的 AWS 区域。

当您选择向亚马逊SNS主题发送数据保留事件时，使用以下环境变量来指定亚马逊SNS详情。发送的事件包括启动、关闭以及错误情况。

  • WICKRIO_SNS_TOPIC_ARN— 您希望将数据保留事件发送到的 Amazon SNS 主题。ARN

使用以下环境变量向发送数据保留指标 CloudWatch。如果指定，则将每 60 秒生成一次指标。

  • WICKRIO_METRICS_TYPE— 将此环境变量的值设置为，cloudwatch以向其发送指标 CloudWatch。