Dieses Handbuch dokumentiert die neue AWS Wickr-Verwaltungskonsole, die am 13. März 2025 veröffentlicht wurde. Die Dokumentation zur klassischen Version der AWS Wickr-Verwaltungskonsole finden Sie im [Classic Administration Guide](https://docs.aws.amazon.com/wickr/latest/adminguide-classic/what-is-wickr.html).
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.
# Datenspeicherung für AWS Wickr
AWS Wickr Data Retention kann alle Konversationen im Netzwerk speichern. Dazu gehören Direktnachrichtengespräche und Konversationen in Gruppen oder Räumen zwischen (internen) Mitgliedern im Netzwerk und denen mit anderen Teams (extern), mit denen Ihr Netzwerk verbunden ist. Die Datenspeicherung steht nur Benutzern des AWS Wickr Premium-Plans und Unternehmenskunden zur Verfügung, die sich für die Datenspeicherung entscheiden. Weitere Informationen zum Premium-Plan finden Sie unter [Wickr-Preise](https://aws.amazon.com/wickr/pricing/)
Wenn ein Netzwerkadministrator die Datenspeicherung für sein Netzwerk konfiguriert und aktiviert, werden alle Nachrichten und Dateien, die in seinem Netzwerk geteilt werden, gemäß den Compliance-Richtlinien des Unternehmens aufbewahrt. Auf diese TXT-Dateiausgaben kann der Netzwerkadministrator an einem externen Ort zugreifen (z. B. lokaler Speicher, Amazon S3 S3-Bucket oder ein anderer Speicher nach Wahl des Benutzers), von wo aus sie analysiert, gelöscht oder übertragen werden können.
**Anmerkung**
Wickr greift niemals auf Ihre Nachrichten und Dateien zu. Daher liegt es in Ihrer Verantwortung, ein Datenaufbewahrungssystem zu konfigurieren.
**Topics**
+ [Details zur Datenspeicherung in AWS Wickr anzeigen](view-data-retention-details.md)
+ [Datenspeicherung für AWS Wickr konfigurieren](configure-data-retention.md)
+ [Holen Sie sich die Datenaufbewahrungsprotokolle für Ihr Wickr-Netzwerk](getting-data-retention-logs.md)
+ [Metriken und Ereignisse zur Datenspeicherung für Ihr Wickr-Netzwerk](metrics-events.md)
# Details zur Datenspeicherung in AWS Wickr anzeigen
Gehen Sie wie folgt vor, um die Details zur Datenspeicherung für Ihr Wickr-Netzwerk einzusehen. Sie können die Datenspeicherung auch für Ihr Wickr-Netzwerk aktivieren oder deaktivieren.
1. Öffnen Sie das AWS-Managementkonsole für Wickr unter. [https://console.aws.amazon.com/wickr/](https://console.aws.amazon.com/wickr/)
1. Wählen Sie auf der Seite **Netzwerke** den Netzwerknamen aus, um zu diesem Netzwerk zu navigieren.
1. Wählen Sie im Navigationsbereich die Option **Netzwerkrichtlinien aus.**
1. Auf der Seite **Netzwerkrichtlinien** werden Schritte zum Einrichten der Datenspeicherung sowie die Option zum Aktivieren oder Deaktivieren der Datenaufbewahrungsfunktion angezeigt. Weitere Informationen zur Konfiguration der Datenspeicherung finden Sie unter[Datenspeicherung für AWS Wickr konfigurieren](configure-data-retention.md).
**Anmerkung**
Wenn die Datenspeicherung aktiviert ist, wird allen Benutzern in Ihrem Netzwerk die Meldung „**Datenspeicherung aktiviert**“ angezeigt, die sie über das Netzwerk mit aktivierter Datenspeicherung informiert.
# Datenspeicherung für AWS Wickr konfigurieren
Um die Datenspeicherung für Ihr AWS Wickr-Netzwerk zu konfigurieren, müssen Sie das Docker-Image des Datenaufbewahrungsbots in einem Container auf einem Host bereitstellen, z. B. auf einem lokalen Computer oder einer Instance in Amazon Elastic Compute Cloud (Amazon EC2). Nachdem der Bot bereitgestellt wurde, können Sie ihn so konfigurieren, dass er Daten lokal oder in einem Amazon Simple Storage Service (Amazon S3) -Bucket speichert. Sie können den Datenaufbewahrungs-Bot auch so konfigurieren, dass er andere AWS Dienste wie AWS Secrets Manager (Secrets Manager), Amazon CloudWatch (CloudWatch), Amazon Simple Notification Service (Amazon SNS) und AWS Key Management Service (AWS KMS) verwendet. In den folgenden Themen wird beschrieben, wie Sie den Datenaufbewahrungs-Bot für Ihr Wickr-Netzwerk konfigurieren und ausführen.
**Topics**
+ [Voraussetzungen für die Konfiguration der Datenspeicherung für AWS Wickr](#data-retention-prerequisites)
+ [Passwort für den Datenaufbewahrungsbot in AWS Wickr](data-retention-password.md)
+ [Speicheroptionen für das AWS Wickr-Netzwerk](data-retention-storage-options.md)
+ [Umgebungsvariablen zur Konfiguration des Datenaufbewahrungsbots in AWS Wickr](data-retention-bot-env-variables.md)
+ [Secrets Manager Manager-Werte für AWS Wickr](data-retention-aws-secret-values.md)
+ [IAM-Richtlinie zur Verwendung der Datenspeicherung mit Diensten AWS](data-retention-aws-services.md)
+ [Starten Sie den Datenaufbewahrungs-Bot für Ihr Wickr-Netzwerk](starting-data-retention-bot.md)
+ [Stoppen Sie den Datenaufbewahrungs-Bot für Ihr Wickr-Netzwerk](stopping-data-retention-bot.md)
## Voraussetzungen für die Konfiguration der Datenspeicherung für AWS Wickr
Bevor Sie beginnen, müssen Sie den Namen des Bots für die Datenspeicherung (als **Benutzername** bezeichnet) und das anfängliche Passwort von AWS-Managementkonsole for Wickr erhalten. Sie müssen diese beiden Werte angeben, wenn Sie den Datenaufbewahrungs-Bot zum ersten Mal starten. Sie müssen auch die Datenspeicherung in der Konsole aktivieren. Weitere Informationen finden Sie unter [Details zur Datenspeicherung in AWS Wickr anzeigen](view-data-retention-details.md).
# Passwort für den Datenaufbewahrungsbot in AWS Wickr
Wenn Sie den Datenaufbewahrungs-Bot zum ersten Mal starten, geben Sie das anfängliche Passwort mit einer der folgenden Optionen an:
+ Die `WICKRIO_BOT_PASSWORD`-Umgebungsvariable Die Umgebungsvariablen für den Datenaufbewahrungs-Bot werden im [Umgebungsvariablen zur Konfiguration des Datenaufbewahrungsbots in AWS Wickr](data-retention-bot-env-variables.md) Abschnitt weiter unten in diesem Handbuch beschrieben.
+ Der **Passwortwert** in Secrets Manager, der durch die `AWS_SECRET_NAME` Umgebungsvariable identifiziert wird. Die Secrets Manager Manager-Werte für den Datenaufbewahrungs-Bot werden im [Secrets Manager Manager-Werte für AWS Wickr](data-retention-aws-secret-values.md) Abschnitt weiter unten in diesem Handbuch beschrieben.
+ Geben Sie das Passwort ein, wenn Sie vom Datenaufbewahrungs-Bot dazu aufgefordert werden. Sie müssen den Datenaufbewahrungs-Bot mit interaktivem TTY-Zugriff mithilfe der `-ti` Option ausführen.
Ein neues Passwort wird generiert, wenn Sie den Datenaufbewahrungs-Bot zum ersten Mal konfigurieren. Wenn Sie den Datenaufbewahrungs-Bot erneut installieren müssen, verwenden Sie das generierte Passwort. Das ursprüngliche Passwort ist nach der Erstinstallation des Datenaufbewahrungsbots nicht gültig.
Das neu generierte Passwort wird wie im folgenden Beispiel angezeigt.
**Wichtig**
Bewahren Sie das Passwort an einem sicheren Ort auf. Wenn Sie das Passwort verlieren, können Sie den Datenaufbewahrungsbot nicht erneut installieren. Teilen Sie dieses Passwort nicht mit anderen. Es bietet die Möglichkeit, die Datenspeicherung für Ihr Wickr-Netzwerk zu starten.
```
********************************************************************
**** GENERATED PASSWORD
**** DO NOT LOSE THIS PASSWORD, YOU WILL NEED TO ENTER IT EVERY TIME
**** TO START THE BOT
"HuEXAMPLERAW4lGgEXAMPLEn"
********************************************************************
```
# Speicheroptionen für das AWS Wickr-Netzwerk
Nachdem die Datenspeicherung aktiviert und der Datenaufbewahrungs-Bot für Ihr Wickr-Netzwerk konfiguriert wurde, erfasst er alle Nachrichten und Dateien, die innerhalb Ihres Netzwerks gesendet werden. Nachrichten werden in Dateien gespeichert, die auf eine bestimmte Größe oder ein bestimmtes Zeitlimit begrenzt sind, das mithilfe einer Umgebungsvariablen konfiguriert werden kann. Weitere Informationen finden Sie unter [Umgebungsvariablen zur Konfiguration des Datenaufbewahrungsbots in AWS Wickr](data-retention-bot-env-variables.md).
Sie können eine der folgenden Optionen zum Speichern dieser Daten konfigurieren:
+ Speichern Sie alle erfassten Nachrichten und Dateien lokal. Dies ist die Standardoption. Es liegt in Ihrer Verantwortung, lokale Dateien zur Langzeitspeicherung auf ein anderes System zu verschieben und sicherzustellen, dass der Hostfestplatte nicht zu wenig Arbeitsspeicher oder Speicherplatz zur Verfügung steht.
+ Speichern Sie alle erfassten Nachrichten und Dateien in einem Amazon S3 S3-Bucket. Der Datenaufbewahrungs-Bot speichert alle entschlüsselten Nachrichten und Dateien in dem von Ihnen angegebenen Amazon S3 S3-Bucket. Die erfassten Nachrichten und Dateien werden vom Host-Computer entfernt, nachdem sie erfolgreich im Bucket gespeichert wurden.
+ Speichern Sie alle erfassten Nachrichten und Dateien verschlüsselt in einem Amazon S3 S3-Bucket. Der Datenaufbewahrungs-Bot verschlüsselt alle erfassten Nachrichten und Dateien mit einem von Ihnen angegebenen Schlüssel erneut und speichert sie in dem von Ihnen angegebenen Amazon S3 S3-Bucket. Die erfassten Nachrichten und Dateien werden vom Host-Computer entfernt, nachdem sie erfolgreich erneut verschlüsselt und im Bucket gespeichert wurden. Sie benötigen Software, um die Nachrichten und Dateien zu entschlüsseln.
Weitere Informationen zur Erstellung eines Amazon S3 S3-Buckets zur Verwendung mit Ihrem Datenaufbewahrungs-Bot finden Sie unter [Erstellen eines Buckets](https://docs.aws.amazon.com/AmazonS3/latest/userguide/create-bucket-overview.html) im *Amazon S3 S3-Benutzerhandbuch*
# 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](starting-data-retention-bot.md).
**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 AWS Wickr](configure-data-retention.md#data-retention-prerequisites). 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//compliance/messages`.
+ `WICKRIO_COMP_FILEDEST`— Der Pfadname zu dem Verzeichnis, in dem Dateien gestreamt werden. Der Standardwert ist `/tmp//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 ist`1000000000`, 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 unter[Secrets Manager Manager-Werte für AWS Wickr](data-retention-aws-secret-values.md).
+ `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](data-retention-aws-secret-values.md).
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 zum erneuten Verschlüsseln der Nachrichtendateien und Dateien auf dem Datenaufbewahrungs-Bot verwendet wird, 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 Amazon SNS SNS-Details anzugeben, wenn Sie Datenaufbewahrungsereignisse an ein Amazon SNS SNS-Thema senden möchten. Zu den gesendeten Ereignissen gehören Start- und Herunterfahrenereignisse sowie Fehlerbedingungen.
+ `WICKRIO_SNS_TOPIC_ARN`— Der ARN des Amazon SNS SNS-Themas, an das Datenaufbewahrungsereignisse gesendet werden sollen.
Verwenden Sie die folgende Umgebungsvariable, um Messdaten zur Datenspeicherung zu CloudWatch senden. 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.
# Secrets Manager Manager-Werte für AWS Wickr
Sie können Secrets Manager verwenden, um die Anmeldeinformationen und AWS Serviceinformationen für den Datenaufbewahrungs-Bot zu speichern. Weitere Informationen zum Erstellen eines Secrets Manager Manager-Geheimnisses finden Sie unter [Create an AWS Secrets Manager Secret im Secrets](https://docs.aws.amazon.com/secretsmanager/latest/userguide/create_secret.html) *Manager Manager-Benutzerhandbuch*.
Das Secrets Manager Manager-Geheimnis kann die folgenden Werte haben:
+ `password`— Das Passwort für den Datenaufbewahrungs-Bot.
+ `s3_bucket_name`— Der Name des Amazon S3 S3-Buckets, in dem Nachrichten und Dateien gespeichert werden. Wenn nicht festgelegt, wird das Standard-Datei-Streaming verwendet.
+ `s3_region`— Die AWS Region des Amazon S3 S3-Buckets, in der Nachrichten und Dateien gespeichert werden.
+ `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.
+ `kms_master_key_arn`— Der 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 S3-Bucket gespeichert werden.
+ `kms_region`— Die AWS Region, in der sich der AWS KMS Masterschlüssel befindet.
+ `sns_topic_arn`— Der ARN des Amazon SNS SNS-Themas, an das Datenaufbewahrungsereignisse gesendet werden sollen.
# IAM-Richtlinie zur Verwendung der Datenspeicherung mit Diensten AWS
Wenn Sie planen, andere AWS Dienste mit dem Wickr-Datenaufbewahrungs-Bot zu verwenden, müssen Sie sicherstellen, dass der Host über die entsprechende AWS Identity and Access Management (IAM-) Rolle und Richtlinie für den Zugriff auf diese Dienste verfügt. Sie können den Datenaufbewahrungs-Bot so konfigurieren, dass er Secrets Manager, Amazon S3 CloudWatch, Amazon SNS und AWS KMS verwendet. Die folgende IAM-Richtlinie ermöglicht den Zugriff auf bestimmte Aktionen für diese Dienste.
------
#### [ JSON ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Sid": "VisualEditor0",
"Effect": "Allow",
"Action": [
"s3:PutObject",
"secretsmanager:GetSecretValue",
"sns:Publish",
"cloudwatch:PutMetricData",
"kms:GenerateDataKey"
],
"Resource": "*"
}
]
}
```
------
Sie können eine strengere IAM-Richtlinie erstellen, indem Sie die spezifischen Objekte für jeden Dienst identifizieren, auf die Sie den Containern auf Ihrem Host Zugriff gewähren möchten. Entfernen Sie die Aktionen für die AWS Dienste, die Sie nicht verwenden möchten. Wenn Sie beispielsweise nur einen Amazon S3 S3-Bucket verwenden möchten, verwenden Sie die folgende Richtlinie, mit der die `cloudwatch:PutMetricData` Aktionen`secretsmanager:GetSecretValue`, `sns:Publish``kms:GenerateDataKey`, und entfernt werden.
------
#### [ JSON ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Sid": "VisualEditor0",
"Effect": "Allow",
"Action": "s3:PutObject",
"Resource": "*"
}
]
}
```
------
Wenn Sie eine Amazon Elastic Compute Cloud (Amazon EC2) -Instance verwenden, um Ihren Datenaufbewahrungs-Bot zu hosten, erstellen Sie eine IAM-Rolle unter Verwendung des Amazon EC2-Standardfalls und weisen Sie eine Richtlinie mithilfe der Richtliniendefinition von oben zu.
# Starten Sie den Datenaufbewahrungs-Bot für Ihr Wickr-Netzwerk
Bevor Sie den Datenaufbewahrungs-Bot ausführen, sollten Sie festlegen, wie Sie ihn konfigurieren möchten. Wenn Sie den Bot auf einem Host ausführen möchten, der:
+ Sie werden keinen Zugriff auf AWS Dienste haben, dann sind Ihre Optionen begrenzt. In diesem Fall verwenden Sie die Standardoptionen für das Nachrichtenstreaming. Sie sollten entscheiden, ob Sie die Größe der erfassten Nachrichtendateien auf eine bestimmte Größe oder ein bestimmtes Zeitintervall beschränken möchten. Weitere Informationen finden Sie unter [Umgebungsvariablen zur Konfiguration des Datenaufbewahrungsbots in AWS Wickr](data-retention-bot-env-variables.md).
+ Wenn Sie Zugriff auf AWS Dienste haben, sollten Sie ein Secrets Manager Manager-Geheimnis erstellen, um die Bot-Anmeldeinformationen und die AWS Dienstkonfigurationsdetails zu speichern. Nachdem die AWS Dienste konfiguriert wurden, können Sie mit dem Starten des Docker-Images für den Datenaufbewahrungs-Bot fortfahren. Weitere Informationen zu den Details, die Sie in einem Secrets Manager Manager-Secret speichern können, finden Sie unter [Secrets Manager Manager-Werte für AWS Wickr](data-retention-aws-secret-values.md)
Die folgenden Abschnitte enthalten Beispielbefehle zum Ausführen des Docker-Images des Datenaufbewahrungs-Bot. Ersetzen Sie in jedem der Beispielbefehle die folgenden Beispielwerte durch Ihre eigenen:
+ `compliance_1234567890_bot`mit dem Namen Ihres Datenaufbewahrungsbots.
+ `password`mit dem Passwort für Ihren Datenaufbewahrungsbot.
+ `wickr/data/retention/bot`mit dem Namen Ihres Secrets Manager Manager-Geheimnisses, das Sie mit Ihrem Datenaufbewahrungs-Bot verwenden möchten.
+ `bucket-name`mit dem Namen des Amazon S3 S3-Buckets, in dem Nachrichten und Dateien gespeichert werden.
+ `folder-name`mit dem Ordnernamen im Amazon S3 S3-Bucket, in dem Nachrichten und Dateien gespeichert werden.
+ `us-east-1`mit der AWS Region der Ressource, die Sie angeben. Zum Beispiel die Region des AWS KMS Hauptschlüssels oder die Region des Amazon S3 S3-Buckets.
+ `arn:aws:kms:us-east-1:111122223333:key/12345678-1234-abcde-a617-abababababab`mit dem Amazon-Ressourcennamen (ARN) Ihres AWS KMS Hauptschlüssels, der zum erneuten Verschlüsseln von Nachrichtendateien und Dateien verwendet werden soll.
# Starten Sie den Bot mit der Umgebungsvariablen Passwort (kein AWS Dienst)
Der folgende Docker-Befehl startet den Datenaufbewahrungs-Bot. Das Passwort wird mithilfe der `WICKRIO_BOT_PASSWORD` Umgebungsvariablen angegeben. Der Bot verwendet zunächst das Standard-Datei-Streaming und verwendet die im [Umgebungsvariablen zur Konfiguration des Datenaufbewahrungsbots in AWS Wickr](data-retention-bot-env-variables.md) Abschnitt dieses Handbuchs definierten Standardwerte.
```
docker run -v /opt/compliance_1234567890_bot:/tmp/compliance_1234567890_bot \
-d --restart on-failure:5 --name="compliance_1234567890_bot" -ti \
-e WICKRIO_BOT_NAME='compliance_1234567890_bot' \
-e WICKRIO_BOT_PASSWORD='password' \
wickr/bot-compliance-cloud:latest
```
# Starte den Bot mit Passwortabfrage (kein AWS Dienst)
Der folgende Docker-Befehl startet den Datenaufbewahrungs-Bot. Das Passwort wird eingegeben, wenn der Datenaufbewahrungs-Bot dazu auffordert. Es wird zunächst das Standard-Datei-Streaming mit den im [Umgebungsvariablen zur Konfiguration des Datenaufbewahrungsbots in AWS Wickr](data-retention-bot-env-variables.md) Abschnitt dieses Handbuchs definierten Standardwerten verwendet.
```
docker run -v /opt/compliance_1234567890_bot:/tmp/compliance_1234567890_bot \
-d --restart on-failure:5 --name="compliance_1234567890_bot" -ti \
-e WICKRIO_BOT_NAME='compliance_1234567890_bot' \
wickr/bot-compliance-cloud:latest
docker attach compliance_1234567890_bot
.
.
.
Enter the password:************
Re-enter the password:************
```
Führen Sie den Bot mit der `-ti` Option aus, um die Passwortabfrage zu erhalten. Sie sollten den `docker attach ` Befehl auch unmittelbar nach dem Start des Docker-Images ausführen, damit Sie die Passwortabfrage erhalten. Sie sollten diese beiden Befehle in einem Skript ausführen. Wenn Sie eine Verbindung zum Docker-Image herstellen und die Aufforderung nicht sehen, drücken Sie die **Eingabetaste**. Die Eingabeaufforderung wird angezeigt.
# Starten Sie den Bot mit einer 15-minütigen Rotation der Nachrichtendatei (kein AWS Dienst)
Der folgende Docker-Befehl startet den Datenaufbewahrungs-Bot mithilfe von Umgebungsvariablen. Es konfiguriert ihn auch so, dass die empfangenen Nachrichtendateien auf 15 Minuten rotiert werden.
```
docker run -v /opt/compliance_1234567890_bot:/tmp/compliance_1234567890_bot --network=host \
-d --restart on-failure:5 --name="compliance_1234567890_bot" -ti \
-e WICKRIO_BOT_NAME='compliance_1234567890_bot' \
-e WICKRIO_BOT_PASSWORD='password' \
-e WICKRIO_COMP_TIMEROTATE=15 \
wickr/bot-compliance-cloud:latest
```
# Starten Sie den Bot und geben Sie das Anfangspasswort mit Secrets Manager an
Sie können den Secrets Manager verwenden, um das Passwort des Datenaufbewahrungsbots zu identifizieren. Wenn Sie den Datenaufbewahrungs-Bot starten, müssen Sie eine Umgebungsvariable festlegen, die den Secrets Manager angibt, in dem diese Informationen gespeichert werden.
```
docker run -v /opt/compliance_1234567890_bot:/tmp/compliance_1234567890_bot --network=host \
-d --restart on-failure:5 --name="compliance_1234567890_bot" -ti \
-e WICKRIO_BOT_NAME='compliance_1234567890_bot' \
-e AWS_SECRET_NAME='wickrpro/alpha/new-3-bot' \
wickr/bot-compliance-cloud:latest
```
Das `wickrpro/compliance/compliance_1234567890_bot` Geheimnis enthält den folgenden geheimen Wert, der als Klartext angezeigt wird.
```
{
"password":"password"
}
```
# Starten Sie den Bot und konfigurieren Sie Amazon S3 mit Secrets Manager
Sie können den Secrets Manager verwenden, um die Anmeldeinformationen und die Amazon S3 S3-Bucket-Informationen zu hosten. Wenn Sie den Datenaufbewahrungs-Bot starten, müssen Sie eine Umgebungsvariable festlegen, die den Secrets Manager angibt, in dem diese Informationen gespeichert werden.
```
docker run -v /opt/compliance_1234567890_bot:/tmp/compliance_1234567890_bot --network=host \
-d --restart on-failure:5 --name="compliance_1234567890_bot" -ti \
-e WICKRIO_BOT_NAME='compliance_1234567890_bot' \
-e AWS_SECRET_NAME='wickrpro/alpha/compliance_1234567890_bot' \
wickr/bot-compliance-cloud:latest
```
Das `wickrpro/compliance/compliance_1234567890_bot` Geheimnis enthält den folgenden geheimen Wert, der als Klartext angezeigt wird.
```
{
"password":"password",
"s3_bucket_name":"bucket-name",
"s3_region":"us-east-1",
"s3_folder_name":"folder-name"
}
```
Nachrichten und Dateien, die vom Bot empfangen werden, werden im `bot-compliance` Bucket im angegebenen Ordner abgelegt. `network1234567890`
# Starten Sie den Bot und konfigurieren Sie Amazon S3 und AWS KMS mit Secrets Manager
Sie können den Secrets Manager verwenden, um die Anmeldeinformationen, den Amazon S3 S3-Bucket und die AWS KMS Master-Key-Informationen zu hosten. Wenn Sie den Datenaufbewahrungs-Bot starten, müssen Sie eine Umgebungsvariable festlegen, die den Secrets Manager angibt, in dem diese Informationen gespeichert werden.
```
docker run -v /opt/compliance_1234567890_bot:/tmp/compliance_1234567890_bot --network=host \
-d --restart on-failure:5 --name="compliance_1234567890_bot" -ti \
-e WICKRIO_BOT_NAME='compliance_1234567890_bot' \
-e AWS_SECRET_NAME='wickrpro/alpha/compliance_1234567890_bot' \
wickr/bot-compliance-cloud:latest
```
Das `wickrpro/compliance/compliance_1234567890_bot` Geheimnis enthält den folgenden geheimen Wert, der als Klartext angezeigt wird.
```
{
"password":"password",
"s3_bucket_name":"bucket-name",
"s3_region":"us-east-1",
"s3_folder_name":"folder-name",
"kms_master_key_arn":"arn:aws:kms:us-east-1:111122223333:key/12345678-1234-abcde-a617-abababababab",
"kms_region":"us-east-1"
}
```
Vom Bot empfangene Nachrichten und Dateien werden mit dem KMS-Schlüssel verschlüsselt, der durch den ARN-Wert identifiziert wird, und dann in den Bucket „bot-compliance“ im Ordner mit dem Namen „network1234567890“ verschoben. Stellen Sie sicher, dass Sie die entsprechende IAM-Richtlinie eingerichtet haben.
# Starten Sie den Bot und konfigurieren Sie Amazon S3 mithilfe von Umgebungsvariablen
Wenn Sie Secrets Manager nicht zum Hosten der Anmeldeinformationen für den Datenaufbewahrungs-Bot verwenden möchten, können Sie das Docker-Image für den Datenaufbewahrungs-Bot mit den folgenden Umgebungsvariablen starten. Sie müssen den Namen des Datenaufbewahrungsbots mithilfe der `WICKRIO_BOT_NAME` Umgebungsvariablen identifizieren.
```
docker run -v /opt/compliance_1234567890_bot:/tmp/compliance_1234567890_bot --network=host \
-d --restart on-failure:5 --name="compliance_1234567890_bot" -ti \
-e WICKRIO_BOT_NAME='compliance_1234567890_bot' \
-e WICKRIO_BOT_PASSWORD='password' \
-e WICKRIO_S3_BUCKET_NAME='bot-compliance' \
-e WICKRIO_S3_FOLDER_NAME='network1234567890' \
-e WICKRIO_S3_REGION='us-east-1' \
wickr/bot-compliance-cloud:latest
```
Sie können Umgebungswerte verwenden, um die Anmeldeinformationen des Datenaufbewahrungsbots, Informationen zu Amazon S3 S3-Buckets und Konfigurationsinformationen für das Standard-Datei-Streaming zu identifizieren.
# Stoppen Sie den Datenaufbewahrungs-Bot für Ihr Wickr-Netzwerk
Die Software, die auf dem Datenaufbewahrungs-Bot ausgeführt wird, erfasst `SIGTERM` Signale und wird ordnungsgemäß heruntergefahren. Verwenden Sie den `docker stop ` Befehl, wie im folgenden Beispiel gezeigt, um den `SIGTERM` Befehl an das Docker-Image des Datenaufbewahrungsbots auszugeben.
```
docker stop compliance_1234567890_bot
```
# Holen Sie sich die Datenaufbewahrungsprotokolle für Ihr Wickr-Netzwerk
Die Software, die auf dem Docker-Image des Datenaufbewahrungsbots ausgeführt wird, wird in Protokolldateien im `/tmp//logs` Verzeichnis ausgegeben. Sie werden auf maximal 5 Dateien rotiert. Sie können die Protokolle abrufen, indem Sie den folgenden Befehl ausführen.
```
docker logs
```
Beispiel:
```
docker logs compliance_1234567890_bot
```
# Metriken und Ereignisse zur Datenspeicherung für Ihr Wickr-Netzwerk
Im Folgenden finden Sie die Amazon CloudWatch (CloudWatch) -Metriken und Amazon Simple Notification Service (Amazon SNS) -Ereignisse, die derzeit von der Version 5.116 des AWS Wickr-Datenaufbewahrungsbots unterstützt werden.
**Topics**
+ [CloudWatch Metriken für Ihr Wickr-Netzwerk](cloudwatch-metrics.md)
+ [Amazon SNS SNS-Ereignisse für Ihr Wickr-Netzwerk](sns-events.md)
# CloudWatch Metriken für Ihr Wickr-Netzwerk
Metriken werden vom Bot in Intervallen von 1 Minute generiert und an den CloudWatch Dienst übertragen, der dem Konto zugeordnet ist, auf dem das Docker-Image des Datenaufbewahrungs-Bot läuft.
Im Folgenden sind die vorhandenen Metriken aufgeführt, die vom Datenaufbewahrungs-Bot unterstützt werden.
| Metrik | Description |
| --- | --- |
| Messages\$1Rx | Empfangene Nachrichten. |
| Messages\$1Rx\$1Failed | Fehler bei der Verarbeitung empfangener Nachrichten. |
| Nachrichten\$1Gespeichert | Nachrichten, die in der Datei mit empfangenen Nachrichten gespeichert wurden. |
| Messages\$1Saved\$1Failed | Fehler beim Speichern von Nachrichten in der Datei mit empfangenen Nachrichten. |
| Gespeicherte Dateien | Empfangene Dateien. |
| Files\$1Saved\$1Bytes | Anzahl der Byte für empfangene Dateien. |
| Files\$1Saved\$1Failed | Fehler beim Speichern von Dateien. |
| Anmeldungen | Anmeldungen (normalerweise ist dies 1 für jedes Intervall). |
| Login\$1Failures | Fehler bei der Anmeldung (normalerweise ist dies 1 für jedes Intervall). |
| S3\$1Post\$1Errors | Fehler beim Posten von Nachrichtendateien und Dateien in den Amazon S3 S3-Bucket. |
| Watchdog\$1Failures | Watchdog-Fehler. |
| Watchdog\$1Warnings | Watchdog-Warnungen. |
Metriken werden generiert, um von CloudWatch verwendet zu werden. Der für Bots verwendete Namespace ist`WickrIO`. Jede Metrik hat eine Reihe von Dimensionen. Im Folgenden finden Sie eine Liste der Dimensionen, die zusammen mit den oben genannten Metriken veröffentlicht werden.
| Dimension | Wert |
| --- | --- |
| Id | Der Benutzername des Bots. |
| Gerät | Beschreibung eines bestimmten Bot-Geräts oder einer bestimmten Instanz. Nützlich, wenn Sie mehrere Bot-Geräte oder -Instanzen ausführen. |
| Produkt | Das Produkt für den Bot. Kann `WickrEnterprise_` mit `Alpha``Beta`, `WickrPro_` oder `Production` angehängt werden. |
| BotType | Der Bot-Typ. Für die **Compliance-Bots** als Compliance gekennzeichnet. |
| Netzwerk | Die ID des zugehörigen Netzwerks. |
# Amazon SNS SNS-Ereignisse für Ihr Wickr-Netzwerk
Die folgenden Ereignisse werden im Amazon SNS SNS-Thema veröffentlicht, das durch den Amazon Resource Name (ARN) -Wert definiert ist, der mithilfe der `WICKRIO_SNS_TOPIC_ARN` Umgebungsvariablen oder des geheimen `sns_topic_arn` Secrets Manager Manager-Werts identifiziert wurde. Weitere Informationen erhalten Sie unter [Umgebungsvariablen zur Konfiguration des Datenaufbewahrungsbots in AWS Wickr](data-retention-bot-env-variables.md) und [Secrets Manager Manager-Werte für AWS Wickr](data-retention-aws-secret-values.md).
Vom Datenaufbewahrungs-Bot generierte Ereignisse werden als JSON-Zeichenfolgen gesendet. Die folgenden Werte sind ab Version 5.116 des Datenaufbewahrungsbots in den Ereignissen enthalten.
| Name | Wert |
| --- | --- |
| ComplianceBot | Der Benutzername des Datenaufbewahrungsbots. |
| DataTime | Das Datum und die Uhrzeit, an dem das Ereignis eingetreten ist. |
| Gerät | Eine Beschreibung des spezifischen Bot-Geräts oder der jeweiligen Bot-Instanz. Nützlich, wenn Sie mehrere Bot-Instanzen ausführen. |
| DockerImage | Das mit dem Bot verknüpfte Docker-Image. |
| DockerTag | Das Tag oder die Version des Docker-Images. |
| Nachricht | Die Ereignisnachricht. Weitere Informationen finden Sie unter [Kritische Ereignisse](#sns-critical-events) und [Normale Ereignisse](#sns-normal-events). |
| notificationType | Dieser Wert wird sein`Bot Event`. |
| severity | Der Schweregrad des Ereignisses. Kann `normal` oder `critical` sein. |
Sie müssen das Amazon SNS SNS-Thema abonnieren, damit Sie die Ereignisse erhalten können. Wenn Sie sich mit einer E-Mail-Adresse anmelden, erhalten Sie eine E-Mail mit Informationen, die dem folgenden Beispiel ähneln.
```
{
"complianceBot": "compliance_1234567890_bot",
"dateTime": "2022-10-12T13:05:39",
"device": "Desktop 1234567890ab",
"dockerImage": "wickr/bot-compliance-cloud",
"dockerTag": "5.116.13.01",
"message": "Logged in",
"notificationType": "Bot Event",
"severity": "normal"
}
```
## Kritische Ereignisse
Diese Ereignisse führen dazu, dass der Bot gestoppt oder neu gestartet wird. Die Anzahl der Neustarts ist begrenzt, um andere Probleme zu vermeiden.
**Fehler bei der Anmeldung**
Im Folgenden sind die möglichen Ereignisse aufgeführt, die generiert werden können, wenn sich der Bot nicht anmelden kann. In jeder Nachricht wird der Grund für den Anmeldefehler angegeben.
| Ereignistyp | Ereignismeldung |
| --- | --- |
| Anmeldung fehlgeschlagen | Schlechte Anmeldeinformationen. Überprüfe das Passwort. |
| Anmeldung fehlgeschlagen | Benutzer wurde nicht gefunden. |
| Anmeldung fehlgeschlagen | Konto oder Gerät ist gesperrt. |
| Bereitstellung | Der Benutzer hat den Befehl beendet. |
| Bereitstellung | Falsches Passwort für die `config.wickr` Datei. |
| Bereitstellung | Die `config.wickr` Datei kann nicht gelesen werden. |
| Anmeldung fehlgeschlagen | Alle Anmeldungen sind fehlgeschlagen. |
| Anmeldung fehlgeschlagen | Neuer Benutzer, aber die Datenbank ist bereits vorhanden. |
**Weitere kritische Ereignisse**
| Ereignistyp | Ereignismeldungen |
| --- | --- |
| Konto gesperrt | Wickr IOClient Main: slotAdminUser Sperren: Code (%1): Grund: %2“ |
| BotDevice Ausgesetzt | Gerät ist gesperrt\$1 |
| WatchDog | Das SwitchBoard System ist seit mehr als < *N* > Minuten ausgefallen |
| S3-Ausfälle | Die Datei < *file-name* ≫ konnte nicht in den S3-Bucket gelegt werden. Fehler: < *AWS-error* > |
| Ausweichschlüssel | VOM SERVER ÜBERMITTELTER FALLBACK-SCHLÜSSEL: Ist kein anerkannter aktiver Fallbackschlüssel für den Client. Bitte senden Sie die Protokolle an Desktop Engineering. |
## Normale Ereignisse
Im Folgenden sind die Ereignisse aufgeführt, die Sie vor normalen Betriebsereignissen warnen. Zu viele Ereignisse dieser Art innerhalb eines bestimmten Zeitraums können Anlass zur Sorge geben.
**Gerät wurde dem Konto hinzugefügt**
Dieses Ereignis wird generiert, wenn dem Bot-Konto für die Datenspeicherung ein neues Gerät hinzugefügt wird. Unter bestimmten Umständen kann dies ein wichtiger Hinweis darauf sein, dass jemand eine Instanz des Datenaufbewahrungsbots erstellt hat. Im Folgenden finden Sie die Nachricht zu dieser Veranstaltung.
```
A device has been added to this account!
```
**Hat sich nicht angemeldet**
Dieses Ereignis wird generiert, wenn sich der Bot erfolgreich angemeldet hat. Es folgt die Nachricht für dieses Ereignis.
```
Logged in
```
**Wird heruntergefahren**
Dieses Ereignis wird generiert, wenn der Bot heruntergefahren wird. Wenn der Benutzer dies nicht explizit initiiert hat, könnte dies ein Hinweis auf ein Problem sein. Im Folgenden finden Sie die Nachricht für dieses Ereignis.
```
Shutting down
```
**Updates verfügbar**
Dieses Ereignis wird generiert, wenn der Datenaufbewahrungs-Bot gestartet wird, und es identifiziert, dass eine neuere Version des zugehörigen Docker-Images verfügbar ist. Dieses Ereignis wird generiert, wenn der Bot gestartet wird, und zwar täglich. Dieses Ereignis umfasst das `versions` Array-Feld, das die neuen Versionen identifiziert, die verfügbar sind. Im Folgenden finden Sie ein Beispiel dafür, wie dieses Ereignis aussieht.
```
{
"complianceBot": "compliance_1234567890_bot",
"dateTime": "2022-10-12T13:05:55",
"device": "Desktop 1234567890ab",
"dockerImage": "wickr/bot-compliance-cloud",
"dockerTag": "5.116.13.01",
"message": "There are updates available",
"notificationType": "Bot Event",
"severity": "normal",
"versions": [
"5.116.10.01"
]
}
```