Variáveis de ambiente para configurar o bot de retenção de dados no AWS Wickr - AWS Wickr

Este guia fornece documentação para o AWS Wickr. Para o Wickr Enterprise, que é a versão local do Wickr, consulte o Guia de Administração Empresarial.

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Variáveis de ambiente para configurar o bot de retenção de dados no AWS Wickr

É possível usar as seguintes variáveis de ambiente para definir o bot de retenção de dados. Você define essas variáveis de ambiente usando a opção -e ao executar a imagem do Docker do bot de retenção de dados. Para obter mais informações, consulte Inicie o bot de retenção de dados para sua rede Wickr.

nota

Essas variáveis de ambiente são opcionais, a menos que especificado de outra forma.

Use as seguintes variáveis de ambiente para especificar as credenciais do bot de retenção de dados:

  • WICKRIO_BOT_NAME — o nome do bot de retenção de dados. Essa variável é necessária quando você executa a imagem do Docker do bot de retenção de dados.

  • WICKRIO_BOT_PASSWORD — a senha inicial do bot de retenção de dados. Para obter mais informações, consulte Pré-requisitos para configurar a retenção de dados para o Wickr AWS. Essa variável é necessária se você não planeja iniciar o bot de retenção de dados com uma solicitação de senha ou não planeja usar o Secrets Manager para armazenar as credenciais do bot de retenção de dados.

Use as seguintes variáveis de ambiente para configurar os recursos de streaming de retenção de dados padrão:

  • WICKRIO_COMP_MESGDEST — o nome do caminho até o diretório onde as mensagens serão transmitidas. O valor padrão é /tmp/<botname>/compliance/messages.

  • WICKRIO_COMP_FILEDEST — o nome do caminho até o diretório em que os arquivos serão transmitidos. O valor padrão é /tmp/<botname>/compliance/attachments.

  • WICKRIO_COMP_BASENAME — o nome base dos arquivos de mensagens recebidas. O valor padrão é receivedMessages.

  • WICKRIO_COMP_FILESIZE — o tamanho máximo de arquivo de mensagens recebidas em kibibytes (Kib). Um novo arquivo é iniciado quando o tamanho máximo é atingido. O valor padrão é 1000000000, como em 1024 GiB.

  • WICKRIO_COMP_TIMEROTATE — a quantidade de tempo, em minutos, durante a qual o bot de retenção de dados colocará as mensagens recebidas em um arquivo de mensagens recebidas. Um novo arquivo é iniciado quando o limite de tempo é atingido. Você só pode usar o tamanho do arquivo ou o tempo para limitar o tamanho do arquivo de mensagens recebidas. O valor padrão é 0, como em “sem limite”.

Use a variável de ambiente a seguir para definir o padrão Região da AWS a ser usado.

  • AWS_DEFAULT_REGION— O padrão Região da AWS a ser usado para AWS serviços como o Secrets Manager (não usado para Amazon S3 ou AWS KMS). A Região us-east-1 é usada por padrão, se essa variável de ambiente não estiver definida.

Use as seguintes variáveis de ambiente para especificar o segredo do Secrets Manager a ser usado quando você optar por usar o Secrets Manager para armazenar as credenciais do bot de retenção de dados e as informações do AWS serviço. Para obter mais informações sobre os valores que você pode armazenar no Secrets Manager, consulte Valores do Secrets Manager para AWS Wickr.

  • AWS_SECRET_NAME— O nome do segredo do Secrets Manager que contém as credenciais e as informações AWS de serviço necessárias para o bot de retenção de dados.

  • AWS_SECRET_REGION— Aquele em Região da AWS que o AWS segredo está localizado. Se você estiver usando AWS segredos e esse valor não estiver definido, o AWS_DEFAULT_REGION valor será usado.

nota

Você pode armazenar todas as seguintes variáveis de ambiente como valores no Secrets Manager. Se você optar por usar o Secrets Manager e armazenar esses valores lá, não precisará especificá-los como variáveis de ambiente ao executar a imagem do Docker do bot de retenção de dados. Basta especificar a variável de ambiente AWS_SECRET_NAME descrita anteriormente neste guia. Para obter mais informações, consulte Valores do Secrets Manager para AWS Wickr.

Use as seguintes variáveis de ambiente para especificar o bucket do Amazon S3 ao optar por armazenar mensagens e arquivos em um bucket.

  • WICKRIO_S3_BUCKET_NAME – o nome do bucket do Amazon S3 onde as mensagens e arquivos serão armazenados.

  • WICKRIO_S3_REGION— A AWS região do bucket do Amazon S3 onde as mensagens e os arquivos serão armazenados.

  • WICKRIO_S3_FOLDER_NAME – o nome da pasta opcional no bucket do Amazon S3 onde as mensagens e arquivos serão armazenados. O nome da pasta será precedido pela chave para as mensagens e arquivos salvos no bucket do Amazon S3.

Use as seguintes variáveis de ambiente para especificar os AWS KMS detalhes ao optar por usar a criptografia do lado do cliente para recriptografar arquivos ao salvá-los em um bucket do Amazon S3.

  • WICKRIO_KMS_MSTRKEY_ARN— O Amazon Resource Name (ARN) da chave AWS KMS mestra usada para recriptografar os arquivos de mensagens e arquivos no bot de retenção de dados antes de serem salvos no bucket do Amazon S3.

  • WICKRIO_KMS_REGION— A AWS região onde a chave AWS KMS mestra está localizada.

Use a seguinte variável de ambiente para especificar os SNS detalhes da Amazon ao optar por enviar eventos de retenção de dados para um SNS tópico da Amazon. Os eventos enviados incluem startup, desligamento e condições de erro.

  • WICKRIO_SNS_TOPIC_ARN— O SNS tópico ARN da Amazon para o qual você deseja enviar eventos de retenção de dados.

Use a variável de ambiente a seguir para enviar métricas de retenção de dados para CloudWatch. Se especificado, as métricas serão geradas a cada 60 segundos.

  • WICKRIO_METRICS_TYPE— Defina o valor dessa variável de ambiente como cloudwatch para a qual enviar métricas CloudWatch.