Umgebungsvariablen zur Konfiguration des Datenaufbewahrungsbots in AWS Wickr - AWS Wickr

Dieses Handbuch enthält Dokumentation für AWS Wickr. Informationen zu Wickr Enterprise, der lokalen Version von Wickr, finden Sie im Enterprise Administration Guide.

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Umgebungsvariablen zur Konfiguration des Datenaufbewahrungsbots in AWS Wickr

Sie können die folgenden Umgebungsvariablen verwenden, um den Datenaufbewahrungs-Bot zu konfigurieren. Sie legen diese Umgebungsvariablen mithilfe der -e Option fest, wenn Sie das Docker-Image des Datenaufbewahrungs-Bot ausführen. Weitere Informationen finden Sie unter Starten Sie den Datenaufbewahrungs-Bot für Ihr Wickr-Netzwerk.

Anmerkung

Diese Umgebungsvariablen sind optional, sofern nicht anders angegeben.

Verwenden Sie die folgenden Umgebungsvariablen, um die Anmeldeinformationen für den Datenaufbewahrungs-Bot anzugeben:

  • WICKRIO_BOT_NAME— Der Name des Datenaufbewahrungsbots. Diese Variable ist erforderlich, wenn Sie das Docker-Image des Datenaufbewahrungs-Bot ausführen.

  • WICKRIO_BOT_PASSWORD— Das ursprüngliche Passwort für den Datenaufbewahrungs-Bot. Weitere Informationen finden Sie unter Voraussetzungen für die Konfiguration der Datenspeicherung für Wickr AWS. Diese Variable ist erforderlich, wenn Sie nicht vorhaben, den Datenaufbewahrungs-Bot mit einer Passwortabfrage zu starten, oder wenn Sie nicht beabsichtigen, Secrets Manager zum Speichern der Anmeldeinformationen für den Datenaufbewahrungs-Bot zu verwenden.

Verwenden Sie die folgenden Umgebungsvariablen, um die Standard-Streaming-Funktionen zur Datenspeicherung zu konfigurieren:

  • WICKRIO_COMP_MESGDEST— Der Pfadname zu dem Verzeichnis, in dem Nachrichten gestreamt werden. Der Standardwert ist /tmp/<botname>/compliance/messages.

  • WICKRIO_COMP_FILEDEST— Der Pfadname zu dem Verzeichnis, in dem Dateien gestreamt werden. Der Standardwert ist /tmp/<botname>/compliance/attachments.

  • WICKRIO_COMP_BASENAME— Der Basisname für die Dateien mit empfangenen Nachrichten. Der Standardwert ist receivedMessages.

  • WICKRIO_COMP_FILESIZE— Die maximale Dateigröße für eine Datei mit empfangenen Nachrichten in Kibibyte (KiB). Eine neue Datei wird gestartet, wenn die maximale Größe erreicht ist. Der Standardwert ist1000000000, wie bei 1024 GiB.

  • WICKRIO_COMP_TIMEROTATE— Die Zeitspanne in Minuten, für die der Datenaufbewahrungs-Bot empfangene Nachrichten in einer Datei mit empfangenen Nachrichten ablegt. Eine neue Datei wird gestartet, wenn das Zeitlimit erreicht ist. Sie können nur die Dateigröße oder die Zeit verwenden, um die Größe der Datei mit empfangenen Nachrichten zu begrenzen. Der Standardwert ist 0 quasi ohne Limit.

Verwenden Sie die folgende Umgebungsvariable, um den zu verwendenden Standardwert AWS-Region zu definieren.

  • AWS_DEFAULT_REGION— Die Standardeinstellung AWS-Region , die für AWS Dienste wie Secrets Manager verwendet wird (wird nicht für Amazon S3 verwendet oder AWS KMS). Die us-east-1 Region wird standardmäßig verwendet, wenn diese Umgebungsvariable nicht definiert ist.

Verwenden Sie die folgenden Umgebungsvariablen, um das Secrets Manager-Geheimnis anzugeben, das verwendet werden soll, wenn Sie sich dafür entscheiden, Secrets Manager zum Speichern der Anmeldeinformationen und AWS Dienstinformationen für den Datenaufbewahrungs-Bot zu verwenden. Weitere Informationen zu den Werten, die Sie in Secrets Manager speichern können, finden Sie unterSecrets Manager Manager-Werte für AWS Wickr.

  • AWS_SECRET_NAME— Der Name des Secrets Manager Manager-Geheimnisses, das die Anmeldeinformationen und AWS Serviceinformationen enthält, die der Datenaufbewahrungsbot benötigt.

  • AWS_SECRET_REGION— Der AWS-Region , in dem sich das AWS Geheimnis befindet. Wenn Sie AWS Geheimnisse verwenden und dieser Wert nicht definiert ist, wird der AWS_DEFAULT_REGION Wert verwendet.

Anmerkung

Sie können alle folgenden Umgebungsvariablen als Werte in Secrets Manager speichern. Wenn Sie sich für die Verwendung von Secrets Manager entscheiden und diese Werte dort speichern, müssen Sie sie nicht als Umgebungsvariablen angeben, wenn Sie das Docker-Image des Datenaufbewahrungsbots ausführen. Sie müssen nur die zuvor in diesem Handbuch beschriebene AWS_SECRET_NAME Umgebungsvariable angeben. Weitere Informationen finden Sie unter Secrets Manager Manager-Werte für AWS Wickr.

Verwenden Sie die folgenden Umgebungsvariablen, um den Amazon S3 S3-Bucket anzugeben, wenn Sie Nachrichten und Dateien in einem Bucket speichern möchten.

  • WICKRIO_S3_BUCKET_NAME— Der Name des Amazon S3 S3-Buckets, in dem Nachrichten und Dateien gespeichert werden.

  • WICKRIO_S3_REGION— Die AWS Region des Amazon S3 S3-Buckets, in der Nachrichten und Dateien gespeichert werden.

  • WICKRIO_S3_FOLDER_NAME— Der optionale Ordnername im Amazon S3 S3-Bucket, in dem Nachrichten und Dateien gespeichert werden. Diesem Ordnernamen wird der Schlüssel für Nachrichten und Dateien vorangestellt, die im Amazon S3 S3-Bucket gespeichert sind.

Verwenden Sie die folgenden Umgebungsvariablen, um die AWS KMS Details anzugeben, wenn Sie sich für die Verwendung der clientseitigen Verschlüsselung entscheiden, um Dateien erneut zu verschlüsseln, wenn Sie sie in einem Amazon S3 S3-Bucket speichern.

  • WICKRIO_KMS_MSTRKEY_ARN— Der Amazon-Ressourcenname (ARN) des AWS KMS Hauptschlüssels, der verwendet wird, um die Nachrichtendateien und Dateien auf dem Datenaufbewahrungs-Bot erneut zu verschlüsseln, bevor sie im Amazon S3-Bucket gespeichert werden.

  • WICKRIO_KMS_REGION— Die AWS Region, in der sich der AWS KMS Hauptschlüssel befindet.

Verwenden Sie die folgende Umgebungsvariable, um die SNS Amazon-Details anzugeben, wenn Sie Datenaufbewahrungsereignisse an ein SNS Amazon-Thema senden möchten. Zu den gesendeten Ereignissen gehören Start- und Herunterfahrenereignisse sowie Fehlerbedingungen.

  • WICKRIO_SNS_TOPIC_ARN— Das ARN SNS Amazon-Thema, an das Datenaufbewahrungsereignisse gesendet werden sollen.

Verwenden Sie die folgende Umgebungsvariable, um Messdaten zur Datenspeicherung zu senden CloudWatch. Falls angegeben, werden die Metriken alle 60 Sekunden generiert.

  • WICKRIO_METRICS_TYPE— Legen Sie den Wert dieser Umgebungsvariablen auf fest, cloudwatch an die Metriken gesendet CloudWatch werden sollen.