Variables de entorno para configurar el bot de retención de datos en Wickr AWS

Puede usar las siguientes variables de entorno para configurar el bot de retención de datos. Estas variables de entorno se configuran mediante la opción -e cuando se ejecuta la imagen de Docker del bot de retención de datos. Para obtener más información, consulte Inicie el bot de retención de datos para su red Wickr.

nota

Estas variables de entorno son opcionales a menos que se especifique lo contrario.

Use las siguientes variables de entorno para especificar las credenciales del bot de retención de datos:

• WICKRIO_BOT_NAME: el nombre del bot de retención de datos. Esta variable es obligatoria cuando se ejecuta la imagen de Docker del bot de retención de datos.

• WICKRIO_BOT_PASSWORD: la contraseña inicial del bot de retención de datos. Para obtener más información, consulte Requisitos previos para configurar la retención de datos para Wickr AWS. Esta variable es obligatoria si no planea iniciar el bot de retención de datos con una solicitud de contraseña o si no planea usar Secrets Manager para almacenar las credenciales del bot de retención de datos.

Use las siguientes variables de entorno para configurar las capacidades de transmisión de retención de datos predeterminadas:

• WICKRIO_COMP_MESGDEST: el nombre de la ruta al directorio donde se transmitirán los mensajes. El valor predeterminado es /tmp/<botname>/compliance/messages.

• WICKRIO_COMP_FILEDEST: el nombre de la ruta al directorio donde se transmitirán los archivos. El valor predeterminado es /tmp/<botname>/compliance/attachments.

• WICKRIO_COMP_BASENAME: el nombre base de los archivos de mensajes recibidos. El valor predeterminado es receivedMessages.

• WICKRIO_COMP_FILESIZE: el tamaño de archivo máximo de un archivo de mensajes recibidos en kibibyte (KiB). Se inicia un nuevo archivo cuando se alcanza el tamaño máximo. El valor predeterminado es 1000000000, como en 1024 GiB.

• WICKRIO_COMP_TIMEROTATE: el tiempo, en minutos, durante el que el bot de retención de datos colocará los mensajes recibidos en un archivo de mensajes recibidos. Se inicia un nuevo archivo cuando se alcanza el tiempo límite. Solo puede usar el tamaño o el tiempo del archivo para limitar el tamaño del archivo de mensajes recibidos. El valor predeterminado es 0, como sin límite.

Utilice la siguiente variable de entorno para definir la variable de entorno predeterminada Región de AWS que se utilizará.

• AWS_DEFAULT_REGION— Es la opción predeterminada Región de AWS para AWS servicios como Secrets Manager (no se usa para Amazon S3 o AWS KMS). Se usa de forma predeterminada la región us-east-1 si esta variable de entorno no está definida.

Utilice las siguientes variables de entorno para especificar el secreto de Secrets Manager que se utilizará cuando opte por utilizar Secrets Manager para almacenar las credenciales del bot de retención de datos y la información de AWS servicio. Para obtener más información sobre los valores que puede almacenar en Secrets Manager, consulte Valores de Secrets Manager para AWS Wickr.

• AWS_SECRET_NAME— El nombre del secreto de Secrets Manager que contiene las credenciales y la información de AWS servicio que necesita el bot de retención de datos.

• AWS_SECRET_REGION— En el Región de AWS que se encuentra el AWS secreto. Si está utilizando AWS secretos y este valor no está definido, se utilizará el AWS_DEFAULT_REGION valor.

nota

Puede almacenar todas las siguientes variables de entorno como valores en Secrets Manager. Si opta por usar Secrets Manager y almacena estos valores allí, no necesitará especificarlos como variables de entorno cuando ejecute la imagen de Docker del bot de retención de datos. Solo tiene que especificar la variable de entorno de AWS_SECRET_NAME descrita anteriormente en esta guía. Para obtener más información, consulte Valores de Secrets Manager para AWS Wickr.

Use las siguientes variables de entorno para especificar el bucket de Amazon S3 cuando opte por almacenar mensajes y archivos en un bucket.

• WICKRIO_S3_BUCKET_NAME: el nombre del bucket de Amazon S3 donde se almacenarán los mensajes y archivos.

• WICKRIO_S3_REGION— La AWS región del bucket de Amazon S3 en la que se almacenarán los mensajes y los archivos.

• WICKRIO_S3_FOLDER_NAME: el nombre de carpeta opcional en el bucket de Amazon S3 donde se almacenarán los mensajes y archivos. El nombre de esta carpeta irá precedido de la clave de los mensajes y archivos guardados en el bucket de Amazon S3.

Utilice las siguientes variables de entorno para especificar los AWS KMS detalles cuando opte por utilizar el cifrado del lado del cliente para volver a cifrar los archivos al guardarlos en un bucket de Amazon S3.

• WICKRIO_KMS_MSTRKEY_ARN— El nombre del recurso de Amazon (ARN) de la clave AWS KMS maestra utilizada para volver a cifrar los archivos de mensajes y los archivos del bot de retención de datos antes de guardarlos en el bucket de Amazon S3.

• WICKRIO_KMS_REGION— La AWS región en la que se encuentra la clave AWS KMS maestra.

Usa la siguiente variable de entorno para especificar los SNS detalles de Amazon cuando optes por enviar eventos de retención de datos a un SNS tema de Amazon. Los eventos enviados incluyen el inicio, el cierre y las condiciones de error.

• WICKRIO_SNS_TOPIC_ARN— El SNS tema ARN de Amazon al que quieres que se envíen los eventos de retención de datos.

Utilice la siguiente variable de entorno para enviar las métricas de retención de datos a CloudWatch. Si se especifica, las métricas se generarán cada 60 segundos.

• WICKRIO_METRICS_TYPE— Defina el valor de esta variable de entorno en cloudwatch el que enviar las métricas CloudWatch.