

이 가이드는 2025년 3월 13일에 릴리스된 새로운 AWS Wickr 관리 콘솔을 문서화합니다. AWS Wickr 관리 콘솔의 클래식 버전에 대한 설명서는 [Classic 관리 안내서](https://docs.aws.amazon.com/wickr/latest/adminguide-classic/what-is-wickr.html)를 참조하세요.

기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.

# AWS Wickr의 데이터 보존
<a name="data-retention"></a>

AWS Wickr 데이터 보존은 네트워크의 모든 대화를 유지할 수 있습니다. 여기에는 네트워크 내(내부) 구성원과 네트워크가 페더레이션된 다른 팀(외부 과의 그룹 또는 룸 내 대화와 다이렉트 메시지 대화가 포함됩니다. 데이터 보존은 데이터 보존을 선택한 AWS Wickr Premium 플랜 사용자 및 엔터프라이즈 고객만 사용할 수 있습니다. 프리미엄 플랜에 대한 자세한 내용은 [Wickr 요금 책정](https://aws.amazon.com/wickr/pricing/)을 참조하십시오.

네트워크 관리자가 네트워크에 대한 데이터 보존을 구성하고 활성화하면 네트워크에서 공유되는 모든 메시지와 파일은 조직의 규정 준수 정책에 따라 보관됩니다. 이러한 .txt 파일 출력은 네트워크 관리자가 외부 위치(예: 로컬 스토리지, Amazon S3 버킷 또는 사용자의 선택에 따른 기타 스토리지)에서 액세스할 수 있으며, 여기서 분석, 삭제 또는 전송할 수 있습니다.

**참고**  
Wickr는 메시지와 파일에 절대 액세스하지 않습니다. 따라서 데이터 보존 시스템을 구성하는 것은 사용자의 책임입니다.

**Topics**
+ [AWS Wickr에서 데이터 보존 세부 정보 보기](view-data-retention-details.md)
+ [AWS Wickr의 데이터 보존 구성](configure-data-retention.md)
+ [Wickr 네트워크의 데이터 보존 로그 가져오기](getting-data-retention-logs.md)
+ [Wickr 네트워크의 데이터 보존 지표 및 이벤트](metrics-events.md)

# AWS Wickr에서 데이터 보존 세부 정보 보기
<a name="view-data-retention-details"></a>

Wickr 네트워크의 데이터 보존 세부 정보를 보려면 다음 절차를 완료하십시오. Wickr 네트워크에 대한 데이터 보존을 활성화하거나 비활성화할 수도 있습니다.

1. [https://console.aws.amazon.com/wickr/](https://console.aws.amazon.com/wickr/) AWS Management Console for Wickr를 엽니다.

1. **네트워크** 페이지에서 네트워크 이름을 선택하여 해당 네트워크로 이동합니다.

1. 탐색 창에서 **네트워크 정책을** 선택합니다.

1. **네트워크 정책** 페이지에는 데이터 보존 설정 단계와 데이터 보존 기능을 활성화 또는 비활성화하는 옵션이 표시됩니다. 데이터 보존 구성에 대한 자세한 내용은 [AWS Wickr의 데이터 보존 구성](configure-data-retention.md) 단원을 참조하십시오.

**참고**  
데이터 보존이 활성화되면 네트워크의 모든 사용자에게 **보존 지원 네트워크를 알리는 데이터 보존 켜짐** 메시지가 표시됩니다.

# AWS Wickr의 데이터 보존 구성
<a name="configure-data-retention"></a>

AWS Wickr 네트워크에 대한 데이터 보존을 구성하려면 데이터 보존 봇 Docker 이미지를 로컬 컴퓨터 또는 Amazon Elastic Compute Cloud(Amazon EC2)의 인스턴스와 같은 호스트의 컨테이너에 배포해야 합니다. 봇이 배포된 후, 데이터를 로컬에 저장하거나 Amazon Simple Storage Service(S3) 버킷에 저장하도록 구성할 수 있습니다. (Secrets Manager), Amazon CloudWatch AWS Secrets Manager (CloudWatch), Amazon Simple Notification Service(Amazon SNS) 및 AWS Key Management Service ()와 같은 다른 AWS 서비스를 사용하도록 데이터 보존 봇을 구성할 수도 있습니다AWS KMS. 다음 주제에서는 Wickr 네트워크용 데이터 보존 봇을 구성하고 실행하는 방법을 설명합니다.

**Topics**
+ [AWS Wickr에 대한 데이터 보존을 구성하기 위한 사전 조건](#data-retention-prerequisites)
+ [AWS Wickr의 데이터 보존 봇 암호](data-retention-password.md)
+ [AWS Wickr 네트워크의 스토리지 옵션](data-retention-storage-options.md)
+ [AWS Wickr에서 데이터 보존 봇을 구성하기 위한 환경 변수](data-retention-bot-env-variables.md)
+ [AWS Wickr의 Secrets Manager 값](data-retention-aws-secret-values.md)
+ [AWS 서비스와 함께 데이터 보존을 사용하는 IAM 정책](data-retention-aws-services.md)
+ [Wickr 네트워크의 데이터 보존 봇 시작](starting-data-retention-bot.md)
+ [Wickr 네트워크의 데이터 보존 봇 중지](stopping-data-retention-bot.md)

## AWS Wickr에 대한 데이터 보존을 구성하기 위한 사전 조건
<a name="data-retention-prerequisites"></a>

시작하기 전에 Wickr AWS Management Console 용에서 데이터 보존 봇 이름(**사용자 이름으로** 레이블 지정)과 초기 암호를 가져와야 합니다. 데이터 보존 봇을 처음 시작할 때는 이 두 값을 모두 지정해야 합니다. 또한 콘솔에서 데이터 보존을 활성화해야 합니다. 자세한 내용은 [AWS Wickr에서 데이터 보존 세부 정보 보기](view-data-retention-details.md) 단원을 참조하십시오.

# AWS Wickr의 데이터 보존 봇 암호
<a name="data-retention-password"></a>

데이터 보존 봇을 처음 시작할 때는 다음 옵션 중 하나를 사용하여 초기 암호를 지정합니다.
+ `WICKRIO_BOT_PASSWORD` 환경 변수. 데이터 보존 봇 환경 변수는 이 설명서의 뒷부분에 있는 [AWS Wickr에서 데이터 보존 봇을 구성하기 위한 환경 변수](data-retention-bot-env-variables.md) 섹션에 요약되어 있습니다.
+ Secrets Manager의 **암호** 값은 `AWS_SECRET_NAME`환경 변수에 의해 식별됩니다. 데이터 보존 봇에 대한 Secrets Manager 값은 이 설명서의 뒷부분에 있는 [AWS Wickr의 Secrets Manager 값](data-retention-aws-secret-values.md) 섹션에 요약되어 있습니다.
+ 데이터 보존 봇에서 프롬프트가 표시되면 암호를 입력합니다. `-ti`옵션을 사용하여 대화형 TTY 액세스로 데이터 보존 봇을 실행해야 합니다.

데이터 보존 봇을 처음 구성할 때 새 암호가 생성됩니다. 데이터 보존 봇을 다시 설치해야 하는 경우 생성된 암호를 사용합니다. 데이터 보존 봇을 처음 설치한 후에는 초기 암호가 유효하지 않습니다.

새로 생성된 암호가 다음 예와 같이 표시됩니다.

**중요**  
암호를 안전한 장소에 저장합니다. 암호를 분실하면 데이터 보존 봇을 다시 설치할 수 없습니다. 이 암호를 공유하지 마십시오. Wickr 네트워크의 데이터 보존을 시작할 수 있는 기능을 제공합니다.

```
********************************************************************
**** GENERATED PASSWORD
**** DO NOT LOSE THIS PASSWORD, YOU WILL NEED TO ENTER IT EVERY TIME
**** TO START THE BOT
 "HuEXAMPLERAW4lGgEXAMPLEn"
 ********************************************************************
```

# AWS Wickr 네트워크의 스토리지 옵션
<a name="data-retention-storage-options"></a>

데이터 보존이 활성화되고 데이터 보존 봇이 Wickr 네트워크에 맞게 구성되면 네트워크 내에서 전송되는 모든 메시지와 파일을 캡처합니다. 메시지는 환경 변수를 사용하여 구성할 수 있는 특정 크기 또는 시간제한으로 제한되는 파일에 저장됩니다. 자세한 내용은 [AWS Wickr에서 데이터 보존 봇을 구성하기 위한 환경 변수](data-retention-bot-env-variables.md) 섹션을 참조하십시오.

이 데이터를 저장하기 위해 다음 옵션 중 하나를 구성할 수 있습니다.
+ 캡처된 모든 메시지와 파일을 로컬에 저장합니다. 이 항목이 기본 옵션입니다. 장기 스토리지를 위해 로컬 파일을 다른 시스템으로 이동하고 호스트 디스크의 메모리 또는 스페이스가 부족하지 않은지 확인하는 것은 사용자의 책임입니다.
+ 캡처한 모든 메시지와 파일을 Amazon S3 버킷에 저장합니다. 데이터 보존 봇은 복호화된 모든 메시지와 파일을 지정한 Amazon S3 버킷에 저장합니다. 캡처된 메시지와 파일은 버킷에 성공적으로 저장되면 호스트 머신에서 제거됩니다.
+ 캡처한 모든 메시지와 파일을 암호화하여 Amazon S3 버킷에 저장합니다. 데이터 보존 봇은 사용자가 제공한 키를 사용하여 캡처한 모든 메시지와 파일을 다시 암호화하고 지정한 Amazon S3 버킷에 저장합니다. 캡처된 메시지와 파일은 성공적으로 재암호화되어 버킷에 저장되면 호스트 머신에서 제거됩니다. 메시지와 파일을 해독하려면 소프트웨어가 필요합니다.

  Amazon S3 버킷을 생성하여 데이터 보존 봇을 가지고 사용하는 것에 대한 자세한 내용은 *Amazon S3 사용 설명서*의 [버킷 생성](https://docs.aws.amazon.com/AmazonS3/latest/userguide/create-bucket-overview.html)을 참조하십시오.

# AWS Wickr에서 데이터 보존 봇을 구성하기 위한 환경 변수
<a name="data-retention-bot-env-variables"></a>

다음 환경 변수를 사용하여 데이터 보존 봇을 구성할 수 있습니다. 데이터 보존 봇 Docker 이미지를 실행할 때 `-e` 옵션을 사용하여 이러한 환경 변수를 설정합니다. 자세한 내용은 [Wickr 네트워크의 데이터 보존 봇 시작](starting-data-retention-bot.md) 섹션을 참조하십시오.

**참고**  
달리 지정하지 않는 한 이러한 환경 변수는 선택 사항입니다.

다음 환경 변수를 사용하여 데이터 보존 봇 자격 증명을 지정하십시오.
+ `WICKRIO_BOT_NAME`— 데이터 보존 봇의 이름. 이 변수는 데이터 보존 봇 Docker 이미지를 실행할 때 *필요합니다*.
+ `WICKRIO_BOT_PASSWORD`— 데이터 보존 봇의 초기 암호입니다. 자세한 내용은 [AWS Wickr에 대한 데이터 보존을 구성하기 위한 사전 조건](configure-data-retention.md#data-retention-prerequisites) 섹션을 참조하십시오. 암호 프롬프트로 데이터 보존 봇을 시작하지 않거나 Secrets Manager를 사용하여 데이터 보존 봇 자격 증명을 저장할 계획이 없는 경우 이 변수가 *필요합니다*.

다음 환경 변수를 사용하여 기본 데이터 보존 스트리밍 기능을 구성합니다.
+ `WICKRIO_COMP_MESGDEST`— 메시지가 스트리밍될 디렉터리의 경로 이름입니다. 기본값은 `/tmp/<botname>/compliance/messages`입니다.
+ `WICKRIO_COMP_FILEDEST`— 파일을 스트리밍될 디렉터리의 경로 이름입니다. 기본값은 `/tmp/<botname>/compliance/attachments`입니다.
+ `WICKRIO_COMP_BASENAME`— 수신된 메시지 파일의 기본 이름입니다. 기본값은 `receivedMessages`입니다.
+ `WICKRIO_COMP_FILESIZE`— 받은 메시지의 최대 파일 크기는 키비바이트(KiB)입니다. 최대 크기에 도달하면 새 파일이 시작됩니다. 기본값은 `1000000000`이고, 1024GiB에서와 같습니다.
+ `WICKRIO_COMP_TIMEROTATE`— 데이터 보존 봇이 수신된 메시지를 수신된 메시지 파일에 저장하는 시간의 합계(분). 시간제한에 도달하면 새 파일이 시작됩니다. 사용자는 파일 크기 또는 시간만 사용하여 받은 메시지 파일의 크기를 제한할 수 있습니다. 기본값은 `0`이고 제한은 없습니다.

다음 환경 변수를 사용하여 AWS 리전 사용할 기본값을 정의합니다.
+ `AWS_DEFAULT_REGION` - Secrets Manager와 같은 AWS 서비스에 AWS 리전 사용할 기본값입니다(Amazon S3 또는 에는 사용되지 않음 AWS KMS). 이 환경 변수가 정의되지 않은 경우 기본적으로 `us-east-1` 리전이 사용됩니다.

다음 환경 변수를 사용하여 Secrets Manager를 사용하여 데이터 보존 봇 보안 인증 및 AWS 서비스 정보를 저장하도록 선택할 때 사용할 Secrets Manager 보안 암호를 지정합니다. Secrets Manager에 저장할 수 있는 값에 대한 자세한 내용은 [AWS Wickr의 Secrets Manager 값](data-retention-aws-secret-values.md)을 참조하십시오.
+ `AWS_SECRET_NAME` - 데이터 보존 봇에 필요한 자격 증명 및 AWS 서비스 정보가 포함된 Secrets Manager 보안 암호의 이름입니다.
+ `AWS_SECRET_REGION` - AWS 보안 AWS 리전 암호가 있는 입니다. AWS 보안 암호를 사용 중이고이 값이 정의되지 않은 경우 `AWS_DEFAULT_REGION` 값이 사용됩니다.

**참고**  
다음 환경 변수를 모두 Secrets Manager에 값으로 저장할 수 있습니다. Secrets Manager를 사용하기로 선택하고 이 값을 저장하면 데이터 보존 봇 Docker 이미지를 실행할 때 환경 변수로 지정할 필요가 없습니다. 이 설명서의 앞부분에서 설명한 `AWS_SECRET_NAME` 환경 변수만 지정하면 됩니다. 자세한 내용은 [AWS Wickr의 Secrets Manager 값](data-retention-aws-secret-values.md) 섹션을 참조하십시오.

메시지와 파일을 버킷에 저장하도록 선택할 경우 다음 환경 변수를 사용하여 Amazon S3 버킷을 지정합니다.
+ `WICKRIO_S3_BUCKET_NAME`— 메시지와 파일이 저장되는 Amazon S3 버킷의 이름.
+ `WICKRIO_S3_REGION` - 메시지와 파일이 저장될 Amazon S3 버킷의 AWS 리전입니다.
+ `WICKRIO_S3_FOLDER_NAME`— 메시지 및 파일이 저장되는 Amazon S3 버킷의 선택 가능 폴더 이름입니다. 이 폴더 이름 앞에는 Amazon S3 버킷에 저장된 메시지 및 파일의 키가 표시됩니다.

다음 환경 변수를 사용하여 Amazon S3 버킷에 파일을 저장할 때 클라이언트 측 암호화를 사용하여 파일을 다시 암호화하도록 선택할 때 AWS KMS 세부 정보를 지정합니다.
+ `WICKRIO_KMS_MSTRKEY_ARN` - Amazon S3 버킷에 저장되기 전에 데이터 보존 봇의 메시지 파일과 파일을 다시 암호화하는 데 사용되는 AWS KMS 마스터 키의 Amazon 리소스 이름(ARN)입니다. Amazon S3 
+ `WICKRIO_KMS_REGION` - 마스터 키가 AWS KMS 위치한 AWS 리전입니다.

Amazon SNS 주제에 데이터 보존 이벤트를 전송하도록 선택한 경우, 다음 환경 변수를 사용하여 Amazon SNS 세부 정보를 지정합니다. 전송된 이벤트에는 시작, 종료 및 오류 상태가 포함됩니다.
+ `WICKRIO_SNS_TOPIC_ARN`— 데이터 보존 이벤트를 전송할 Amazon SNS 주제의 ARN입니다.

다음 환경 변수를 사용하여 데이터 보존 지표를 CloudWatch에 전송합니다. 지정된 경우 지표는 60초마다 생성됩니다.
+ `WICKRIO_METRICS_TYPE`— CloudWatch로 지표를 전송하려면 이 환경 변수의 값을 `cloudwatch`로 설정합니다.

# AWS Wickr의 Secrets Manager 값
<a name="data-retention-aws-secret-values"></a>

Secrets Manager를 사용하여 데이터 보존 봇 자격 증명 및 AWS 서비스 정보를 저장할 수 있습니다. Secrets Manager 보안 암호 생성에 대한 자세한 내용은 Secrets Manager 사용 설명서의 보안 [AWS Secrets Manager 암호 생성을 ](https://docs.aws.amazon.com/secretsmanager/latest/userguide/create_secret.html) 참조하세요. ** 

Secrets Manager 보안 암호는 다음과 같은 값을 가질 수 있습니다.
+ `password`— 데이터 보존 봇 암호.
+ `s3_bucket_name`— 메시지와 파일이 저장되는 Amazon S3 버킷의 이름. 설정하지 않으면 기본 파일 스트리밍이 사용됩니다.
+ `s3_region` - 메시지와 파일이 저장될 Amazon S3 버킷의 AWS 리전입니다.
+ `s3_folder_name`— 메시지 및 파일이 저장되는 Amazon S3 버킷의 선택 가능 폴더 이름입니다. 이 폴더 이름 앞에는 Amazon S3 버킷에 저장된 메시지 및 파일의 키가 표시됩니다.
+ `kms_master_key_arn` - Amazon S3 버킷에 저장되기 전에 데이터 보존 봇의 메시지 파일과 파일을 다시 암호화하는 데 사용되는 AWS KMS 마스터 키의 ARN입니다.
+ `kms_region` - AWS KMS 마스터 키가 위치한 AWS 리전입니다.
+ `sns_topic_arn`— 데이터 보존 이벤트를 전송할 Amazon SNS 주제의 ARN입니다.

# AWS 서비스와 함께 데이터 보존을 사용하는 IAM 정책
<a name="data-retention-aws-services"></a>

Wickr 데이터 보존 봇과 함께 다른 AWS 서비스를 사용하려는 경우 호스트에 액세스하기 위한 적절한 AWS Identity and Access Management (IAM) 역할과 정책이 있는지 확인해야 합니다. Secrets Manager, Amazon S3, CloudWatch, Amazon SNS 및를 사용하도록 데이터 보존 봇을 구성할 수 있습니다 AWS KMS. 다음 IAM 정책은 이러한 서비스에 대한 특정 작업에 대한 액세스를 허용합니다.

------
#### [ JSON ]

****  

```
{
    "Version":"2012-10-17",		 	 	 
    "Statement": [
        {
            "Sid": "VisualEditor0",
            "Effect": "Allow",
            "Action": [
                "s3:PutObject",
                "secretsmanager:GetSecretValue",
                "sns:Publish",
                "cloudwatch:PutMetricData",
                "kms:GenerateDataKey"
            ],
            "Resource": "*"
        }
    ]
}
```

------

사용자는 호스트의 컨테이너가 액세스하도록 허용하려는 각 서비스의 특정 객체를 식별하여 보다 엄격한 IAM 정책을 만들 수 있습니다. 사용하지 않을 AWS 서비스에 대한 작업을 제거합니다. 예를 들어, Amazon S3 버킷만 사용하려는 경우, `secretsmanager:GetSecretValue` `sns:Publish``kms:GenerateDataKey`, 및 `cloudwatch:PutMetricData` 작업을 제거하는 다음 정책을 사용하십시오.

------
#### [ JSON ]

****  

```
{
    "Version":"2012-10-17",		 	 	 
    "Statement": [
        {
            "Sid": "VisualEditor0",
            "Effect": "Allow",
            "Action": "s3:PutObject",
            "Resource": "*"
        }
    ]
}
```

------

Amazon Elastic Compute Cloud(Amazon EC2) 인스턴스를 사용하여 데이터 보존 봇을 호스팅하는 경우, Amazon EC2의 일반적인 사례를 사용하는 IAM 역할을 생성하고 위의 정책 정의를 사용하여 정책을 할당하십시오.

# Wickr 네트워크의 데이터 보존 봇 시작
<a name="starting-data-retention-bot"></a>

데이터 보존 봇을 실행하기 전에 원하는 구성 방법을 결정해야 합니다. 다음과 같은 호스트에서 봇을 실행하려는 경우,
+  AWS 서비스에 액세스할 수 없는 경우 옵션이 제한됩니다. 이 경우 기본 메시지 스트리밍 옵션을 사용하게 됩니다. 캡처된 메시지 파일의 크기를 특정 크기 또는 시간 간격으로 제한할지 여부를 결정해야 합니다. 자세한 내용은 [AWS Wickr에서 데이터 보존 봇을 구성하기 위한 환경 변수](data-retention-bot-env-variables.md) 단원을 참조하십시오.
+  AWS 서비스에 액세스할 수 있게 되면 Secrets Manager 보안 암호를 생성하여 봇 자격 증명과 AWS 서비스 구성 세부 정보를 저장해야 합니다. AWS 서비스를 구성한 후, 데이터 보존 봇 Docker 이미지를 시작할 수 있습니다. Secrets Manager 보안 암호에 저장할 수 있는 세부 정보에 대한 자세한 내용은 [AWS Wickr의 Secrets Manager 값](data-retention-aws-secret-values.md)을 참조하십시오.

다음 섹션에서는 데이터 보존 봇 Docker 이미지를 실행하는 예제 명령을 보여줍니다. 각 예제 명령에서, 다음 예제 값을 사용자 자신의 값으로 바꿉니다.
+ `compliance_1234567890_bot`과 데이터 보존 봇의 이름.
+ `password`과 데이터 보존 봇의 암호.
+ 데이터 보존 봇과 함께 사용할 `wickr/data/retention/bot`과 Secrets Manager 보안 암호의 이름.
+ `bucket-name`과 메시지 및 파일이 저장되는 Amazon S3 버킷의 이름.
+ `folder-name`과 메시지 및 파일이 저장되는 Amazon S3 버킷의 폴더 이름.
+ `us-east-1`를 지정하려는 리소스의 AWS 리전으로 바꿉니다. 예를 들어 AWS KMS 마스터 키의 리전 또는 Amazon S3 버킷의 리전입니다.
+ `arn:aws:kms:us-east-1:111122223333:key/12345678-1234-abcde-a617-abababababab`를 메시지 파일 및 파일을 다시 암호화하는 데 사용할 AWS KMS 마스터 키의 Amazon 리소스 이름(ARN)으로 바꿉니다.

# 암호 환경 변수로 봇 시작( AWS 서비스 없음)
<a name="data-retention-basic-startup"></a>

다음 Docker 명령은 데이터 보존 봇을 시작합니다. 암호는 `WICKRIO_BOT_PASSWORD` 환경 변수를 사용하여 지정됩니다. 봇은 기본 파일 스트리밍을 사용하고 이 설명서의 [AWS Wickr에서 데이터 보존 봇을 구성하기 위한 환경 변수](data-retention-bot-env-variables.md) 섹션에 정의된 기본값을 사용하여 시작합니다.

```
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
```

# 암호 프롬프트로 봇 시작( AWS 서비스 없음)
<a name="data-retention-startup-password"></a>

다음 Docker 명령은 데이터 보존 봇을 시작합니다. 데이터 보존 봇에서 암호를 묻는 메시지가 표시되면 암호를 입력합니다. 이 설명서의 [AWS Wickr에서 데이터 보존 봇을 구성하기 위한 환경 변수](data-retention-bot-env-variables.md) 섹션에 정의된 기본값을 사용하여 기본 파일 스트리밍을 사용하기 시작합니다.

```
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:************
```

`-ti` 옵션을 사용하여 봇을 실행하면 암호 프롬프트를 받을 수 있습니다. 또한 도커 이미지를 시작한 후 즉시 `docker attach <container ID or container name>` 명령을 실행하여 암호 프롬프트가 표시되도록 해야 합니다. 이 두 명령은 모두 스크립트로 실행해야 합니다. 도커 이미지에 연결했는데 메시지가 표시되지 않는 경우 **입력** 키를 누르면 프롬프트가 표시됩니다.

# 15분 메시지 파일 교체로 봇 시작( AWS 서비스 없음)
<a name="data-retention-startup-rotation"></a>

다음 Docker 명령은 환경 변수를 사용하여 데이터 보존 봇을 시작합니다. 또한 수신된 메시지 파일을 15분 단위로 회전하도록 구성합니다.

```
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
```

# 봇을 시작하고 Secrets Manager를 사용하여 초기 암호를 지정합니다.
<a name="data-retention-startup-asm"></a>

사용자는 Secrets Manager를 사용하여 데이터 보존 봇의 암호를 식별할 수 있습니다. 데이터 보존 봇을 시작할 때는 이 정보가 저장되는 Secrets Manager를 지정하는 환경 변수를 설정해야 합니다.

```
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
```

`wickrpro/compliance/compliance_1234567890_bot` 보안 암호에는 일반 텍스트로 보이는, 그 안에 표시된 다음과 같은 보안 암호 값이 있습니다.

```
{
    "password":"password"
}
```

# 봇을 시작하고 Secrets Manager를 사용하여 Amazon S3를 구성합니다.
<a name="data-retention-startup-asm-s3"></a>

사용자는 Secrets Manager를 사용하여 자격 증명과 Amazon S3 버킷 정보를 호스팅할 수 있습니다. 데이터 보존 봇을 시작할 때는 이 정보가 저장되는 Secrets Manager를 지정하는 환경 변수를 설정해야 합니다.

```
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
```

`wickrpro/compliance/compliance_1234567890_bot` 보안 암호에는 일반 텍스트로 보이는, 그 안에 표시된 다음과 같은 보안 암호 값이 있습니다.

```
{
    "password":"password",
    "s3_bucket_name":"bucket-name",
    "s3_region":"us-east-1",
    "s3_folder_name":"folder-name"
}
```

봇이 수신한 메시지와 파일은 `network1234567890`이름이 지정된 폴더의 `bot-compliance` 버킷에 저장됩니다.

# 봇을 시작하고 Secrets Manager를 AWS KMS 사용하여 Amazon S3 및 구성
<a name="data-retention-startup-asm-s3-KMS"></a>

Secrets Manager를 사용하여 자격 증명, Amazon S3 버킷 및 AWS KMS 마스터 키 정보를 호스팅할 수 있습니다. 데이터 보존 봇을 시작할 때는 이 정보가 저장되는 Secrets Manager를 지정하는 환경 변수를 설정해야 합니다.

```
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
```

`wickrpro/compliance/compliance_1234567890_bot` 보안 암호에는 일반 텍스트로 보이는, 그 안에 표시된 다음과 같은 보안 암호 값이 있습니다.

```
{
    "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"
}
```

봇이 수신한 메시지와 파일은 ARN 값으로 식별되는 KMS 키를 사용하여 암호화된 다음 “network1234567890"이라는 폴더에 있는 “봇 규정 준수” 버킷에 저장됩니다. 적절한 IAM 정책 설정이 있는지 확인하십시오.

# 봇을 시작하고 환경 변수를 사용하여 Amazon S3를 구성합니다.
<a name="using-env-variables"></a>

Secrets Manager를 사용하여 데이터 보존 봇 자격 증명을 호스팅하지 않으려면 다음 환경 변수를 사용하여 데이터 보존 봇 Docker 이미지를 시작할 수 있습니다. `WICKRIO_BOT_NAME`환경 변수를 사용하여 데이터 보존 봇의 이름을 식별해야 합니다.

```
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
```

환경 값을 사용하여 데이터 보존 봇의 자격 증명, Amazon S3 버킷에 대한 정보, 기본 파일 스트리밍을 위한 구성 정보를 식별할 수 있습니다.

# Wickr 네트워크의 데이터 보존 봇 중지
<a name="stopping-data-retention-bot"></a>

데이터 보존 봇에서 실행되는 소프트웨어는 `SIGTERM` 신호를 캡쳐하고 정상적으로 종료됩니다. 다음 예제와 같이 `docker stop <container ID or container name>` 명령을 사용하여 데이터 보존 봇 Docker 이미지에 `SIGTERM` 명령을 내립니다.

```
docker stop compliance_1234567890_bot
```

# Wickr 네트워크의 데이터 보존 로그 가져오기
<a name="getting-data-retention-logs"></a>

데이터 보존 봇 도커 이미지에서 실행되는 소프트웨어는 `/tmp/<botname>/logs`디렉터리의 로그 파일에 출력됩니다. 파일은 최대 5개 파일로 회전합니다. 다음 명령을 실행하여 로그를 가질 수 있습니다.

```
docker logs <botname>
```

예제:

```
docker logs compliance_1234567890_bot
```

# Wickr 네트워크의 데이터 보존 지표 및 이벤트
<a name="metrics-events"></a>

다음은 AWS Wickr 데이터 보존 봇 5.116 버전에서 현재 지원하는 Amazon CloudWatch 지표와 Amazon Simple Notification Service(SNS) 이벤트입니다.

**Topics**
+ [Wickr 네트워크에 대한 CloudWatch 지표](cloudwatch-metrics.md)
+ [Wickr 네트워크에 대한 Amazon SNS 이벤트](sns-events.md)

# Wickr 네트워크에 대한 CloudWatch 지표
<a name="cloudwatch-metrics"></a>

지표는 봇이 1분 간격으로 생성되어 데이터 보존 봇 도커 이미지가 실행되는 계정과 연결된 CloudWatch 서비스에 전송됩니다.

다음은 데이터 보존 봇이 지원하는 기존 지표입니다.


| 지표 | 설명 | 
| --- | --- | 
|  Messages\$1Rx  |  메시지 수신됨  | 
|  메시지\$1Rx\$1실패함  |  수신된 메시지를 처리하지 못했습니다.  | 
|  메시지\$1저장됨  |  받은 메시지 파일에 메시지가 저장되었습니다.  | 
|  메시지\$1저장\$1실패  |  받은 메시지 파일에 메시지를 저장하지 못했습니다.  | 
|  파일\$1저장됨  |  파일을 받았습니다.  | 
|  파일\$1저장\$1바이트  |  받은 파일의 바이트 수  | 
|  파일\$1저장\$1실패  |  파일 저장 실패.  | 
|  로그인  |  로그인(일반적으로 각 간격마다 1회입니다).  | 
|  로그인\$1실패  |  로그인 실패(일반적으로 각 간격마다 1회씩 발생)  | 
|  S3\$1Post\$1Errors  |  Amazon S3 버킷에 메시지 파일 및 파일을 게시하는 중 오류가 발생했습니다.  | 
|  Watchdog\$1실패  |  Watchdog 장애  | 
|  Watchdog\$1경고  |  Watchdog 경고  | 

지표는 CloudWatch에서 사용할 수 있도록 생성됩니다. 봇에 사용되는 네임스페이스는 `WickrIO`입니다. 각 지표에는 차원 배열이 있습니다. 다음은 위 지표와 함께 게시된 측정기준 목록입니다.


| 측정 기준 | 값 | 
| --- | --- | 
|  Id  |  봇의 사용자 이름입니다.  | 
|  장치  |  특정 봇 기기 또는 인스턴스에 대한 설명. 여러 봇 기기 또는 인스턴스를 실행하는 경우 유용합니다.  | 
|  제품  |  봇을 위한 제품입니다. `WickrPro_` 또는 `WickrEnterprise_`에 `Alpha`, `Beta`, 또는 `Production`가 붙을 수 있습니다.  | 
|  BotType  |  봇 유형. 규정 준수스 봇의 경우 **규정 준수**로 분류됩니다.  | 
|  Network  |  연결된 네트워크의 ID.  | 

# Wickr 네트워크에 대한 Amazon SNS 이벤트
<a name="sns-events"></a>

다음 이벤트는 `WICKRIO_SNS_TOPIC_ARN`환경 변수 또는 Secrets Manager `sns_topic_arn` 비밀 값을 사용하여 식별된 Amazon 리소스 이름(ARN) 값으로 정의된 Amazon SNS 주제에 게시됩니다. 자세한 정보는 [AWS Wickr에서 데이터 보존 봇을 구성하기 위한 환경 변수](data-retention-bot-env-variables.md)및 [AWS Wickr의 Secrets Manager 값](data-retention-aws-secret-values.md) 섹션을 참조하십시오.

데이터 보존 봇에서 생성된 이벤트는 JSON 문자열로 전송됩니다. 데이터 보존 봇 5.116 버전부터 이벤트에 포함된 값은 다음과 같습니다.


| 이름 | 값 | 
| --- | --- | 
|  complianceBot  |  데이터 보존 봇의 사용자 이름.  | 
|  dataTime  |  이벤트가 발생한 날짜와 시간.  | 
|  디바이스  |  특정 봇 디바이스 또는 인스턴스에 대한 설명. 여러 봇 인스턴스를 실행하는 경우 유용합니다.  | 
|  dockerImage  |  봇과 관련된 도커 이미지.  | 
|  dockerTag  |  도커 이미지의 태그 또는 버전입니다.  | 
|  message  |  이벤트 메시지 자세한 내용은 [중요 이벤트](#sns-critical-events) 및 [일반 이벤트](#sns-normal-events) 단원을 참조하십시오.  | 
|  notificationType  |  이 값은 `Bot Event` 입니다.  | 
|  severity  |  이벤트의 심각도. 가능한 값은 `normal` 또는 `critical`입니다.  | 

이벤트를 받으려면 Amazon SNS 주제를 구독해야 합니다. 이메일 주소를 사용하여 구독하는 경우 다음 예제와 유사한 정보가 포함된 이메일이 전송됩니다.

```
{
"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"
}
```

## 중요 이벤트
<a name="sns-critical-events"></a>

이러한 이벤트로 인해 봇이 중지되거나 다시 시작됩니다. 다른 문제가 발생하지 않도록 재시작 횟수를 제한합니다.

**로그인 실패**

봇이 로그인하지 못할 때 생성될 수 있는 이벤트는 다음과 같습니다. 각 메시지에는 로그인 실패 이유가 표시됩니다.


| 이벤트 유형 | 이벤트 메시지 | 
| --- | --- | 
|  failedlogin  |  보안 인증이 잘못되었습니다. 비밀번호를 확인합니다.  | 
|  failedlogin  |  사용자를 찾을 수 없습니다.  | 
|  failedlogin  |  계정 또는 기기가 일시 중지되었습니다.  | 
|  provisioning  |  사용자가 명령을 종료합니다.  | 
|  provisioning  |  `config.wickr`파일의 비밀번호가 잘못되었습니다.  | 
|  provisioning  |  `config.wickr`파일을 읽을 수 없습니다.  | 
|  failedlogin  |  로그인이 모두 실패했습니다.  | 
|  failedlogin  |  새 사용자이지만 데이터베이스가 이미 있습니다.  | 

**더 중요한 이벤트**


| 이벤트 유형 | 이벤트 메시지 | 
| --- | --- | 
|  일시 중지된 계정  |  WickrIOClientMain::slotAdminUserSuspend: code(%1): reason: %2“  | 
|  BotDevice Suspended  |  기기가 일시 중지되었습니다\$1  | 
|  WatchDog  |  SwitchBoard 시스템이 <*N*> 분 이상 다운되었습니다.  | 
|  S3 실패  |  S3 버킷에 파일 <*file-name*≫을 넣지 못했습니다. *오류: <AWS-error*>  | 
|  Fallback Key  |  서버에서 제출한 폴백 키: 인식된 클라이언트 활성 폴백 키가 아닙니다. 데스크탑 엔지니어링에 로그를 제출하십시오.  | 

## 일반 이벤트
<a name="sns-normal-events"></a>

다음은 정상 작동 발생에 대해 경고하는 이벤트입니다. 특정 기간 내에 이러한 유형의 이벤트가 너무 많이 발생하는 것은 우려의 원인이 될 수 있습니다.

**계정에 추가된 기기**

이 이벤트는 새 기기가 데이터 보존 봇 계정에 추가될 때 생성됩니다. 경우에 따라 이는 누군가가 데이터 보존 봇의 인스턴스를 생성했다는 중요한 표시일 수 있습니다. 다음은 이 이벤트의 메시지입니다.

```
A device has been added to this account!
```

**봇이 로그인**

이 이벤트는 봇이 성공적으로 로그인했을 때 생성됩니다. 다음은 이 이벤트의 메시지입니다.

```
Logged in
```

**시스템 종료**

이 이벤트는 봇이 종료될 때 생성됩니다. 사용자가 이를 명시적으로 시작하지 않았다면 문제가 있다는 신호일 수 있습니다. 다음은 이 이벤트의 메시지입니다.

```
Shutting down
```

**업데이트 사용 가능**

이 이벤트는 데이터 보존 봇이 시작될 때 생성되며 관련 도커 이미지의 최신 버전을 사용할 수 있음을 식별합니다. 이 이벤트는 봇이 시작될 때 매일 생성됩니다. 이 이벤트에는 사용 가능한 새 버전을 식별하는 `versions`배열 필드가 포함됩니다. 다음은 이 이벤트의 모습에 대한 예시입니다.

```
{
  "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"
  ]
}
```