AWS Wickr でデータ保持ボットを設定する環境変数 - AWS Wickr

このガイドでは、AWSWickr のドキュメントを提供します。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 — 受信メッセージファイルの最大ファイルサイズ (KiB)。最大サイズに達すると、新しいファイルが開始されます。デフォルト値は 1000000000 (1024 GiB など) です。

  • WICKRIO_COMP_TIMEROTATE — データ保持ボットが受信したメッセージを受信メッセージファイルに保存する時間 (分単位)。制限時間に達すると、新しいファイルが開始されます。受信メッセージファイルのサイズを制限できるのは、ファイルサイズまたは時間だけです。デフォルト値は 0 (制限なし) です。

次の環境変数を使用して、 AWS リージョン 使用するデフォルトを定義します。

  • AWS_DEFAULT_REGION – Secrets Manager などの AWS サービス AWS リージョン に使用するデフォルト (Amazon S3 や では使用されません AWS KMS)。この環境変数が定義されていない場合、デフォルトでは us-east-1 リージョンが使用されます。

次の環境変数を使用して、Secrets Manager を使用してデータ保持ボットの認証情報と AWS サービス情報を保存するときに使用する Secrets Manager シークレットを指定します。Secrets Manager に保存できる値の詳細については、AWS Wickr の Secrets Manager 値 を参照してください。

  • AWS_SECRET_NAME – データ保持ボットに必要な認証情報と AWS サービス情報を含む Secrets Manager シークレットの名前。

  • 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 – Amazon S3 バケットに保存される前に、データ保持ボット上のメッセージファイルとファイルを再暗号化するために使用される AWS KMS マスターキーの Amazon リソースネーム (ARN)。 Amazon S3

  • WICKRIO_KMS_REGION – マスターキーがある AWS AWS KMS リージョン。

次の環境変数を使用して、Amazon SNSトピックにデータ保持イベントを送信するときに Amazon SNSの詳細を指定します。送信されるイベントには、スタートアップ、シャットダウン、エラー状態が含まれます。

  • WICKRIO_SNS_TOPIC_ARN – データ保持イベントを送信する Amazon SNSトピックARNの 。

次の環境変数を使用して、データ保持メトリクスを に送信します CloudWatch。指定した場合、メトリクスは 60 秒ごとに生成されます。

  • WICKRIO_METRICS_TYPE – この環境変数の値を に設定cloudwatchして、メトリクスを に送信します CloudWatch。