Variables d'environnement pour configurer le bot de conservation des données dans AWS Wickr - AWS Wickr

Ce guide fournit de la documentation pour AWS Wickr. Pour Wickr Enterprise, qui est la version locale de Wickr, consultez le Guide d'administration de l'entreprise.

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Variables d'environnement pour configurer le bot de conservation des données dans AWS Wickr

Vous pouvez utiliser les variables d'environnement suivantes pour configurer le bot de conservation des données. Vous définissez ces variables d'environnement à l'aide de l'-eoption lorsque vous exécutez l'image Docker du bot de conservation des données. Pour de plus amples informations, veuillez consulter Démarrez le bot de conservation des données pour votre réseau Wickr.

Note

Ces variables d'environnement sont facultatives sauf indication contraire.

Utilisez les variables d'environnement suivantes pour spécifier les informations d'identification du bot de conservation des données :

  • WICKRIO_BOT_NAME— Le nom du bot de conservation des données. Cette variable est obligatoire lorsque vous exécutez l'image Docker du bot de conservation des données.

  • WICKRIO_BOT_PASSWORD— Le mot de passe initial du bot de conservation des données. Pour de plus amples informations, veuillez consulter Conditions préalables pour configurer la conservation des données pour Wickr AWS. Cette variable est obligatoire si vous ne prévoyez pas de démarrer le bot de conservation des données en demandant un mot de passe ou si vous ne prévoyez pas d'utiliser Secrets Manager pour stocker les informations d'identification du bot de conservation des données.

Utilisez les variables d'environnement suivantes pour configurer les fonctionnalités de streaming de conservation des données par défaut :

  • WICKRIO_COMP_MESGDEST— Le nom du chemin d'accès au répertoire dans lequel les messages seront diffusés. La valeur par défaut est /tmp/<botname>/compliance/messages.

  • WICKRIO_COMP_FILEDEST— Le nom du chemin d'accès au répertoire dans lequel les fichiers seront diffusés. La valeur par défaut est /tmp/<botname>/compliance/attachments.

  • WICKRIO_COMP_BASENAME— Le nom de base des fichiers de messages reçus. La valeur par défaut est receivedMessages.

  • WICKRIO_COMP_FILESIZE— La taille maximale d'un fichier de messages reçus en kibioctet (KiB). Un nouveau fichier est lancé lorsque la taille maximale est atteinte. La valeur par défaut est1000000000, comme dans 1024 GiB.

  • WICKRIO_COMP_TIMEROTATE— Durée, en minutes, pendant laquelle le bot de conservation des données insère les messages reçus dans un fichier de messages reçus. Un nouveau fichier est lancé lorsque le délai est atteint. Vous ne pouvez utiliser la taille ou la durée du fichier que pour limiter la taille du fichier des messages reçus. La valeur par défaut est0, comme dans aucune limite.

Utilisez la variable d'environnement suivante pour définir la valeur par défaut Région AWS à utiliser.

  • AWS_DEFAULT_REGION— La valeur par défaut Région AWS à utiliser pour AWS des services tels que Secrets Manager (non utilisée pour Amazon S3 ou AWS KMS). La us-east-1 région est utilisée par défaut si cette variable d'environnement n'est pas définie.

Utilisez les variables d'environnement suivantes pour spécifier le secret Secrets Manager à utiliser lorsque vous choisissez d'utiliser Secrets Manager pour stocker les informations d'identification et les informations de AWS service du bot de conservation des données. Pour plus d'informations sur les valeurs que vous pouvez stocker dans Secrets Manager, consultezLes valeurs de Secrets Manager pour AWS Wickr.

  • AWS_SECRET_NAME— Le nom du secret Secrets Manager qui contient les informations d'identification et AWS de service nécessaires au bot de conservation des données.

  • AWS_SECRET_REGION— L' Région AWS endroit où se trouve le AWS secret. Si vous utilisez des AWS secrets et que cette valeur n'est pas définie, elle sera utilisée. AWS_DEFAULT_REGION

Note

Vous pouvez stocker toutes les variables d'environnement suivantes sous forme de valeurs dans Secrets Manager. Si vous choisissez d'utiliser Secrets Manager et que vous y stockez ces valeurs, vous n'avez pas besoin de les spécifier en tant que variables d'environnement lorsque vous exécutez l'image Docker du bot de conservation des données. Il vous suffit de spécifier la variable d'AWS_SECRET_NAMEenvironnement décrite plus haut dans ce guide. Pour de plus amples informations, veuillez consulter Les valeurs de Secrets Manager pour AWS Wickr.

Utilisez les variables d'environnement suivantes pour spécifier le compartiment Amazon S3 lorsque vous choisissez de stocker des messages et des fichiers dans un compartiment.

  • WICKRIO_S3_BUCKET_NAME— Le nom du compartiment Amazon S3 dans lequel les messages et les fichiers seront stockés.

  • WICKRIO_S3_REGION— La AWS région du compartiment Amazon S3 dans laquelle les messages et les fichiers seront stockés.

  • WICKRIO_S3_FOLDER_NAME— Le nom du dossier facultatif dans le compartiment Amazon S3 où les messages et les fichiers seront stockés. Ce nom de dossier sera précédé de la clé pour les messages et les fichiers enregistrés dans le compartiment Amazon S3.

Utilisez les variables d'environnement suivantes pour spécifier les AWS KMS détails lorsque vous choisissez d'utiliser le chiffrement côté client pour rechiffrer les fichiers lorsque vous les enregistrez dans un compartiment Amazon S3.

  • WICKRIO_KMS_MSTRKEY_ARN— Le nom de ressource Amazon (ARN) de la clé AWS KMS principale utilisée pour rechiffrer les fichiers de messages et les fichiers sur le bot de conservation des données avant qu'ils ne soient enregistrés dans le compartiment Amazon S3.

  • WICKRIO_KMS_REGION— La AWS région où se trouve la clé AWS KMS principale.

Utilisez la variable d'environnement suivante pour spécifier les SNS informations Amazon lorsque vous choisissez d'envoyer des événements de conservation des données à un SNS sujet Amazon. Les événements envoyés incluent le démarrage, l'arrêt et les conditions d'erreur.

  • WICKRIO_SNS_TOPIC_ARN— Le ARN SNS sujet Amazon auquel vous souhaitez que les événements de conservation des données soient envoyés.

Utilisez la variable d'environnement suivante pour envoyer les métriques de conservation des données à CloudWatch. Si cela est spécifié, les métriques seront générées toutes les 60 secondes.

  • WICKRIO_METRICS_TYPE— Définissez la valeur de cette variable d'environnement cloudwatch à laquelle envoyer les métriques CloudWatch.