Panduan ini mendokumentasikan konsol administrasi AWS Wickr baru, yang dirilis pada 13 Maret 2025. Untuk dokumentasi tentang versi klasik konsol administrasi AWS Wickr, lihat Panduan Administrasi [Klasik](https://docs.aws.amazon.com/wickr/latest/adminguide-classic/what-is-wickr.html).
Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
# Retensi data untuk AWS Wickr
AWS Wickr Penyimpanan data dapat mempertahankan semua percakapan dalam jaringan. Ini termasuk percakapan pesan langsung dan percakapan di Grup atau Ruangan antara anggota dalam jaringan (internal) dan orang-orang dengan tim lain (eksternal) dengan siapa jaringan Anda digabungkan. Penyimpanan data hanya tersedia untuk pengguna paket AWS Wickr Premium dan pelanggan perusahaan yang memilih untuk retensi data. Untuk informasi selengkapnya tentang paket Premium, lihat Harga [Wickr](https://aws.amazon.com/wickr/pricing/)
Ketika administrator jaringan mengonfigurasi dan mengaktifkan penyimpanan data untuk jaringan mereka, semua pesan dan file yang dibagikan di jaringan mereka dipertahankan sesuai dengan kebijakan kepatuhan organisasi. Output file.txt ini dapat diakses oleh administrator jaringan di lokasi eksternal (misalnya: penyimpanan lokal, bucket Amazon S3, atau penyimpanan lainnya sesuai pilihan pengguna), dari mana mereka dapat dianalisis, dihapus, atau ditransfer.
**catatan**
Wickr tidak pernah mengakses pesan dan file Anda. Oleh karena itu, Anda bertanggung jawab untuk mengonfigurasi sistem retensi data.
**Topics**
+ [
# Lihat detail retensi data di AWS Wickr
](view-data-retention-details.md)
+ [
# Konfigurasikan retensi data untuk AWS Wickr
](configure-data-retention.md)
+ [
# Dapatkan log retensi data untuk jaringan Wickr Anda
](getting-data-retention-logs.md)
+ [
# Metrik dan peristiwa retensi data untuk jaringan Wickr Anda
](metrics-events.md)
# Lihat detail retensi data di AWS Wickr
Selesaikan prosedur berikut untuk melihat detail penyimpanan data untuk jaringan Wickr Anda. Anda juga dapat mengaktifkan atau menonaktifkan retensi data untuk jaringan Wickr Anda.
1. Buka Konsol Manajemen AWS untuk Wickr di. [https://console.aws.amazon.com/wickr/](https://console.aws.amazon.com/wickr/)
1. Pada halaman **Jaringan**, pilih nama jaringan untuk menavigasi ke jaringan itu.
1. Di panel navigasi, pilih **Kebijakan jaringan**.
1. Halaman **Kebijakan Jaringan** menampilkan langkah-langkah untuk mengatur retensi data, dan opsi untuk mengaktifkan atau menonaktifkan fitur retensi data. Untuk informasi selengkapnya tentang mengonfigurasi retensi data, lihat[Konfigurasikan retensi data untuk AWS Wickr](configure-data-retention.md).
**catatan**
Ketika retensi data diaktifkan, pesan **Retensi Data Dihidupkan** akan terlihat oleh semua pengguna di jaringan Anda yang memberi tahu mereka tentang jaringan yang mendukung retensi.
# Konfigurasikan retensi data untuk AWS Wickr
Untuk mengonfigurasi retensi data untuk jaringan AWS Wickr, Anda harus menerapkan image bot Docker penyimpanan data ke container di host, seperti komputer lokal atau instans di Amazon Elastic Compute Cloud (Amazon EC2). Setelah bot di-deploy, Anda dapat mengonfigurasinya untuk menyimpan data secara lokal atau di bucket Amazon Simple Storage Service (Amazon S3). Anda juga dapat mengonfigurasi bot retensi data untuk menggunakan AWS layanan lain seperti AWS Secrets Manager (Secrets Manager), Amazon CloudWatch (CloudWatch), Amazon Simple Notification Service (Amazon SNS), AWS Key Management Service dan ().AWS KMS Topik berikut menjelaskan cara mengkonfigurasi dan menjalankan bot retensi data untuk jaringan Wickr Anda.
**Topics**
+ [
## Prasyarat untuk mengonfigurasi retensi data untuk AWS Wickr
](#data-retention-prerequisites)
+ [
# Kata sandi untuk bot retensi data di AWS Wickr
](data-retention-password.md)
+ [
# Opsi penyimpanan untuk jaringan AWS Wickr
](data-retention-storage-options.md)
+ [
# Variabel lingkungan untuk mengonfigurasi bot retensi data di AWS Wickr
](data-retention-bot-env-variables.md)
+ [
# Nilai Secrets Manager untuk AWS Wickr
](data-retention-aws-secret-values.md)
+ [
# Kebijakan IAM untuk menggunakan penyimpanan data dengan layanan AWS
](data-retention-aws-services.md)
+ [
# Mulai bot retensi data untuk jaringan Wickr Anda
](starting-data-retention-bot.md)
+ [
# Hentikan bot retensi data untuk jaringan Wickr Anda
](stopping-data-retention-bot.md)
## Prasyarat untuk mengonfigurasi retensi data untuk AWS Wickr
Sebelum memulai, Anda harus mendapatkan nama bot retensi data (diberi label sebagai Nama **Pengguna**) dan kata sandi awal dari Konsol Manajemen AWS untuk Wickr. Anda harus menentukan kedua nilai ini saat pertama kali memulai bot retensi data. Anda juga harus mengaktifkan retensi data di konsol. Untuk informasi selengkapnya, lihat [Lihat detail retensi data di AWS Wickr](view-data-retention-details.md).
# Kata sandi untuk bot retensi data di AWS Wickr
Pertama kali Anda memulai bot retensi data, Anda menentukan kata sandi awal menggunakan salah satu opsi berikut:
+ Variabel `WICKRIO_BOT_PASSWORD` lingkungan. Variabel lingkungan bot retensi data diuraikan di [Variabel lingkungan untuk mengonfigurasi bot retensi data di AWS Wickr](data-retention-bot-env-variables.md) bagian nanti dalam panduan ini.
+ Nilai **kata sandi** di Secrets Manager diidentifikasi oleh variabel `AWS_SECRET_NAME` lingkungan. Nilai Secrets Manager untuk bot retensi data diuraikan di [Nilai Secrets Manager untuk AWS Wickr](data-retention-aws-secret-values.md) bagian nanti dalam panduan ini.
+ Masukkan kata sandi saat diminta oleh bot retensi data. Anda harus menjalankan bot retensi data dengan akses TTY interaktif menggunakan `-ti` opsi.
Kata sandi baru akan dihasilkan saat Anda mengonfigurasi bot retensi data untuk pertama kalinya. Jika Anda perlu menginstal ulang bot retensi data, Anda menggunakan kata sandi yang dihasilkan. Kata sandi awal tidak valid setelah instalasi awal bot retensi data.
Kata sandi yang baru dihasilkan akan ditampilkan seperti yang ditunjukkan pada contoh berikut.
**penting**
Simpan sandi di tempat yang aman. Jika Anda kehilangan kata sandi, Anda tidak akan dapat menginstal ulang bot retensi data. Jangan bagikan kata sandi ini. Ini memberikan kemampuan untuk memulai retensi data untuk jaringan Wickr Anda.
```
********************************************************************
**** GENERATED PASSWORD
**** DO NOT LOSE THIS PASSWORD, YOU WILL NEED TO ENTER IT EVERY TIME
**** TO START THE BOT
"HuEXAMPLERAW4lGgEXAMPLEn"
********************************************************************
```
# Opsi penyimpanan untuk jaringan AWS Wickr
Setelah retensi data diaktifkan dan bot retensi data dikonfigurasi untuk jaringan Wickr Anda, itu akan menangkap semua pesan dan file yang dikirim dalam jaringan Anda. Pesan disimpan dalam file yang terbatas pada ukuran atau batas waktu tertentu yang dapat dikonfigurasi menggunakan variabel lingkungan. Untuk informasi selengkapnya, lihat [Variabel lingkungan untuk mengonfigurasi bot retensi data di AWS Wickr](data-retention-bot-env-variables.md).
Anda dapat mengonfigurasi salah satu opsi berikut untuk menyimpan data ini:
+ Simpan semua pesan dan file yang diambil secara lokal. Ini adalah pilihan default. Anda bertanggung jawab untuk memindahkan file lokal ke sistem lain untuk penyimpanan jangka panjang, dan memastikan disk host tidak kehabisan memori atau ruang.
+ Simpan semua pesan dan file yang diambil dalam bucket Amazon S3. Bot retensi data akan menyimpan semua pesan dan file yang didekripsi ke bucket Amazon S3 yang Anda tentukan. Pesan dan file yang diambil dihapus dari mesin host setelah berhasil disimpan ke ember.
+ Simpan semua pesan dan file yang diambil yang dienkripsi dalam bucket Amazon S3. Bot retensi data akan mengenkripsi ulang semua pesan dan file yang diambil menggunakan kunci yang Anda berikan dan menyimpannya ke bucket Amazon S3 yang Anda tentukan. Pesan dan file yang diambil dihapus dari mesin host setelah berhasil dienkripsi ulang dan disimpan ke ember. Anda akan memerlukan perangkat lunak untuk mendekripsi pesan dan file.
Untuk informasi selengkapnya tentang membuat bucket Amazon S3 untuk digunakan dengan bot retensi data, lihat [Membuat bucket di Panduan](https://docs.aws.amazon.com/AmazonS3/latest/userguide/create-bucket-overview.html) Pengguna *Amazon S3*
# Variabel lingkungan untuk mengonfigurasi bot retensi data di AWS Wickr
Anda dapat menggunakan variabel lingkungan berikut untuk mengonfigurasi bot retensi data. Anda mengatur variabel lingkungan ini menggunakan `-e` opsi saat Anda menjalankan image bot Docker retensi data. Untuk informasi selengkapnya, lihat [Mulai bot retensi data untuk jaringan Wickr Anda](starting-data-retention-bot.md).
**catatan**
Variabel lingkungan ini opsional kecuali ditentukan lain.
Gunakan variabel lingkungan berikut untuk menentukan kredensi bot retensi data:
+ `WICKRIO_BOT_NAME`— Nama bot retensi data. Variabel ini *diperlukan* saat Anda menjalankan image bot Docker retensi data.
+ `WICKRIO_BOT_PASSWORD`— Kata sandi awal untuk bot retensi data. Untuk informasi selengkapnya, lihat [Prasyarat untuk mengonfigurasi retensi data untuk AWS Wickr](configure-data-retention.md#data-retention-prerequisites). Variabel ini *diperlukan* jika Anda tidak berencana untuk memulai bot retensi data dengan prompt kata sandi atau Anda tidak berencana menggunakan Secrets Manager untuk menyimpan kredenal bot retensi data.
Gunakan variabel lingkungan berikut untuk mengonfigurasi kemampuan streaming retensi data default:
+ `WICKRIO_COMP_MESGDEST`— Nama jalur ke direktori tempat pesan akan dialirkan. Nilai default-nya adalah `/tmp//compliance/messages`.
+ `WICKRIO_COMP_FILEDEST`— Nama jalur ke direktori tempat file akan dialirkan. Nilai default-nya adalah `/tmp//compliance/attachments`.
+ `WICKRIO_COMP_BASENAME`— Nama dasar untuk file pesan yang diterima. Nilai default-nya adalah `receivedMessages`.
+ `WICKRIO_COMP_FILESIZE`— Ukuran file maksimum untuk file pesan yang diterima dalam kibibyte (KiB). File baru dimulai ketika ukuran maksimal tercapai. Nilai defaultnya adalah`1000000000`, seperti pada 1024 GiB.
+ `WICKRIO_COMP_TIMEROTATE`— Jumlah waktu, dalam hitungan menit, di mana bot retensi data akan memasukkan pesan yang diterima ke dalam file pesan yang diterima. File baru dimulai ketika batas waktu tercapai. Anda hanya dapat menggunakan ukuran file atau waktu untuk membatasi ukuran file pesan yang diterima. Nilai defaultnya adalah`0`, seperti tanpa batas.
Gunakan variabel lingkungan berikut untuk menentukan default yang Wilayah AWS akan digunakan.
+ `AWS_DEFAULT_REGION`— Default Wilayah AWS untuk digunakan untuk AWS layanan seperti Secrets Manager (tidak digunakan untuk Amazon S3 atau AWS KMS). `us-east-1`Wilayah digunakan secara default jika variabel lingkungan ini tidak didefinisikan.
Gunakan variabel lingkungan berikut untuk menentukan rahasia Secrets Manager yang akan digunakan saat Anda memilih untuk menggunakan Secrets Manager untuk menyimpan kredensi bot retensi data dan informasi AWS layanan. Untuk informasi selengkapnya tentang nilai yang dapat Anda simpan di Secrets Manager lihat[Nilai Secrets Manager untuk AWS Wickr](data-retention-aws-secret-values.md).
+ `AWS_SECRET_NAME`— Nama rahasia Secrets Manager yang berisi kredensil dan informasi AWS layanan yang dibutuhkan oleh bot retensi data.
+ `AWS_SECRET_REGION`— Wilayah AWS AWS Rahasianya terletak di. Jika Anda menggunakan AWS rahasia dan nilai ini tidak ditentukan `AWS_DEFAULT_REGION` nilainya akan digunakan.
**catatan**
Anda dapat menyimpan semua variabel lingkungan berikut sebagai nilai di Secrets Manager. Jika Anda memilih untuk menggunakan Secrets Manager, dan Anda menyimpan nilai-nilai ini di sana, maka Anda tidak perlu menentukannya sebagai variabel lingkungan saat Anda menjalankan image bot Docker retensi data. Anda hanya perlu menentukan variabel `AWS_SECRET_NAME` lingkungan yang dijelaskan sebelumnya dalam panduan ini. Untuk informasi selengkapnya, lihat [Nilai Secrets Manager untuk AWS Wickr](data-retention-aws-secret-values.md).
Gunakan variabel lingkungan berikut untuk menentukan bucket Amazon S3 saat Anda memilih untuk menyimpan pesan dan file ke bucket.
+ `WICKRIO_S3_BUCKET_NAME`— Nama bucket Amazon S3 tempat pesan dan file akan disimpan.
+ `WICKRIO_S3_REGION`— AWS Wilayah bucket Amazon S3 tempat pesan dan file akan disimpan.
+ `WICKRIO_S3_FOLDER_NAME`— Nama folder opsional di bucket Amazon S3 tempat pesan dan file akan disimpan. Nama folder ini akan didahului dengan kunci untuk pesan dan file yang disimpan ke bucket Amazon S3.
Gunakan variabel lingkungan berikut untuk menentukan AWS KMS detail saat Anda memilih untuk menggunakan enkripsi sisi klien untuk mengenkripsi ulang file saat menyimpannya ke bucket Amazon S3.
+ `WICKRIO_KMS_MSTRKEY_ARN`— Nama Sumber Daya Amazon (ARN) dari kunci AWS KMS master yang digunakan untuk mengenkripsi ulang file pesan dan file pada bot retensi data sebelum disimpan ke bucket Amazon S3.
+ `WICKRIO_KMS_REGION`— AWS Wilayah tempat kunci AWS KMS utama berada.
Gunakan variabel lingkungan berikut untuk menentukan detail Amazon SNS saat Anda memilih untuk mengirim peristiwa penyimpanan data ke topik Amazon SNS. Peristiwa yang dikirim termasuk startup, shutdown, serta kondisi kesalahan.
+ `WICKRIO_SNS_TOPIC_ARN`— ARN dari topik Amazon SNS yang ingin Anda kirimkan ke acara penyimpanan data.
Gunakan variabel lingkungan berikut untuk mengirim metrik retensi data ke CloudWatch. Jika ditentukan, metrik akan dihasilkan setiap 60 detik.
+ `WICKRIO_METRICS_TYPE`— Tetapkan nilai variabel lingkungan ini `cloudwatch` untuk mengirim metrik ke CloudWatch.
# Nilai Secrets Manager untuk AWS Wickr
Anda dapat menggunakan Secrets Manager untuk menyimpan kredensi bot retensi data dan informasi AWS layanan. Untuk informasi selengkapnya tentang membuat rahasia Secrets Manager, lihat [Membuat AWS Secrets Manager rahasia](https://docs.aws.amazon.com/secretsmanager/latest/userguide/create_secret.html) *di Panduan Pengguna Secrets Manager*.
Rahasia Secrets Manager dapat memiliki nilai-nilai berikut:
+ `password`— Kata sandi bot retensi data.
+ `s3_bucket_name`— Nama bucket Amazon S3 tempat pesan dan file akan disimpan. Jika tidak diatur, streaming file default akan digunakan.
+ `s3_region`— AWS Wilayah bucket Amazon S3 tempat pesan dan file akan disimpan.
+ `s3_folder_name`— Nama folder opsional di bucket Amazon S3 tempat pesan dan file akan disimpan. Nama folder ini akan didahului dengan kunci untuk pesan dan file yang disimpan ke bucket Amazon S3.
+ `kms_master_key_arn`— ARN dari kunci AWS KMS master digunakan untuk mengenkripsi ulang file pesan dan file pada bot retensi data sebelum disimpan ke bucket Amazon S3.
+ `kms_region`— AWS Wilayah tempat kunci AWS KMS utama berada.
+ `sns_topic_arn`— ARN dari topik Amazon SNS yang ingin Anda kirimkan ke acara penyimpanan data.
# Kebijakan IAM untuk menggunakan penyimpanan data dengan layanan AWS
Jika Anda berencana untuk menggunakan AWS layanan lain dengan bot retensi data Wickr, Anda harus memastikan host memiliki peran dan kebijakan AWS Identity and Access Management (IAM) yang sesuai untuk mengaksesnya. Anda dapat mengonfigurasi bot retensi data untuk menggunakan Secrets Manager, Amazon S3, Amazon SNS CloudWatch, dan. AWS KMS Kebijakan IAM berikut memungkinkan akses ke tindakan spesifik untuk layanan ini.
------
#### [ JSON ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Sid": "VisualEditor0",
"Effect": "Allow",
"Action": [
"s3:PutObject",
"secretsmanager:GetSecretValue",
"sns:Publish",
"cloudwatch:PutMetricData",
"kms:GenerateDataKey"
],
"Resource": "*"
}
]
}
```
------
Anda dapat membuat kebijakan IAM yang lebih ketat dengan mengidentifikasi objek tertentu untuk setiap layanan yang ingin Anda izinkan untuk diakses oleh container di host Anda. Hapus tindakan untuk AWS layanan yang tidak ingin Anda gunakan. Misalnya, jika Anda bermaksud hanya menggunakan bucket Amazon S3, gunakan kebijakan berikut, yang menghapus, `sns:Publish``kms:GenerateDataKey`, `secretsmanager:GetSecretValue` `cloudwatch:PutMetricData` dan tindakan.
------
#### [ JSON ]
****
```
{
"Version":"2012-10-17",
"Statement": [
{
"Sid": "VisualEditor0",
"Effect": "Allow",
"Action": "s3:PutObject",
"Resource": "*"
}
]
}
```
------
Jika Anda menggunakan instans Amazon Elastic Compute Cloud (Amazon EC2) untuk meng-host bot penyimpanan data Anda, buat peran IAM menggunakan kasus umum Amazon EC2 dan tetapkan kebijakan menggunakan definisi kebijakan dari atas.
# Mulai bot retensi data untuk jaringan Wickr Anda
Sebelum Anda menjalankan bot retensi data, Anda harus menentukan bagaimana Anda ingin mengkonfigurasinya. Jika Anda berencana untuk menjalankan bot pada host yang:
+ Tidak akan memiliki akses ke AWS layanan, maka pilihan Anda terbatas. Dalam hal ini Anda akan menggunakan opsi streaming pesan default. Anda harus memutuskan apakah Anda ingin membatasi ukuran file pesan yang diambil ke ukuran atau interval waktu tertentu. Untuk informasi selengkapnya, lihat [Variabel lingkungan untuk mengonfigurasi bot retensi data di AWS Wickr](data-retention-bot-env-variables.md).
+ Akan memiliki akses ke AWS layanan, maka Anda harus membuat rahasia Secrets Manager untuk menyimpan kredensi bot, dan detail konfigurasi AWS layanan. Setelah AWS layanan dikonfigurasi, Anda dapat melanjutkan untuk memulai image bot penyimpanan data Docker. Untuk informasi selengkapnya tentang detail yang dapat Anda simpan di rahasia Secrets Manager, lihat [Nilai Secrets Manager untuk AWS Wickr](data-retention-aws-secret-values.md)
Bagian berikut menunjukkan contoh perintah untuk menjalankan image bot penyimpanan data Docker. Di setiap perintah contoh, ganti nilai contoh berikut dengan milik Anda sendiri:
+ `compliance_1234567890_bot`dengan nama bot retensi data Anda.
+ `password`dengan kata sandi untuk bot retensi data Anda.
+ `wickr/data/retention/bot`dengan nama rahasia Secrets Manager Anda untuk digunakan dengan bot retensi data Anda.
+ `bucket-name`dengan nama bucket Amazon S3 tempat pesan dan file akan disimpan.
+ `folder-name`dengan nama folder di bucket Amazon S3 tempat pesan dan file akan disimpan.
+ `us-east-1`dengan AWS Wilayah sumber daya yang Anda tentukan. Misalnya, Wilayah kunci AWS KMS master atau Wilayah bucket Amazon S3.
+ `arn:aws:kms:us-east-1:111122223333:key/12345678-1234-abcde-a617-abababababab`dengan Nama Sumber Daya Amazon (ARN) dari kunci AWS KMS master Anda untuk digunakan untuk mengenkripsi ulang file dan file pesan.
# Mulai bot dengan variabel lingkungan kata sandi (tidak ada AWS layanan)
Perintah Docker berikut memulai bot retensi data. Kata sandi ditentukan menggunakan variabel `WICKRIO_BOT_PASSWORD` lingkungan. Bot mulai menggunakan streaming file default, dan menggunakan nilai default yang ditentukan di [Variabel lingkungan untuk mengonfigurasi bot retensi data di AWS Wickr](data-retention-bot-env-variables.md) bagian panduan ini.
```
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
```
# Mulai bot dengan prompt kata sandi (tidak ada AWS layanan)
Perintah Docker berikut memulai bot retensi data. Kata sandi dimasukkan saat diminta oleh bot retensi data. Ini akan mulai menggunakan streaming file default menggunakan nilai default yang ditentukan di [Variabel lingkungan untuk mengonfigurasi bot retensi data di AWS Wickr](data-retention-bot-env-variables.md) bagian panduan ini.
```
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:************
```
Jalankan bot menggunakan `-ti` opsi untuk menerima prompt kata sandi. Anda juga harus menjalankan `docker attach ` perintah segera setelah memulai image docker sehingga Anda mendapatkan prompt kata sandi. Anda harus menjalankan kedua perintah ini dalam skrip. Jika Anda melampirkan ke gambar docker dan tidak melihat prompt, tekan **Enter** dan Anda akan melihat prompt.
# Mulai bot dengan rotasi file pesan 15 menit (tidak ada AWS layanan)
Perintah Docker berikut memulai bot retensi data menggunakan variabel lingkungan. Ini juga mengonfigurasinya untuk memutar file pesan yang diterima menjadi 15 menit.
```
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
```
# Mulai bot dan tentukan kata sandi awal dengan Secrets Manager
Anda dapat menggunakan Secrets Manager untuk mengidentifikasi kata sandi bot retensi data. Saat Anda memulai bot retensi data, Anda perlu mengatur variabel lingkungan yang menentukan Secrets Manager tempat informasi ini disimpan.
```
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`Rahasia memiliki nilai rahasia berikut di dalamnya, ditampilkan sebagai plaintext.
```
{
"password":"password"
}
```
# Mulai bot dan konfigurasikan Amazon S3 dengan Secrets Manager
Anda dapat menggunakan Secrets Manager untuk meng-host kredensi, dan informasi bucket Amazon S3. Saat Anda memulai bot retensi data, Anda perlu mengatur variabel lingkungan yang menentukan Secrets Manager tempat informasi ini disimpan.
```
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`Rahasia memiliki nilai rahasia berikut di dalamnya, ditampilkan sebagai plaintext.
```
{
"password":"password",
"s3_bucket_name":"bucket-name",
"s3_region":"us-east-1",
"s3_folder_name":"folder-name"
}
```
Pesan dan file yang diterima oleh bot akan dimasukkan ke dalam `bot-compliance` ember di folder bernama`network1234567890`.
# Mulai bot dan konfigurasikan Amazon S3 dan AWS KMS dengan Secrets Manager
Anda dapat menggunakan Secrets Manager untuk meng-host kredensi, bucket Amazon S3, AWS KMS dan informasi kunci master. Saat Anda memulai bot retensi data, Anda perlu mengatur variabel lingkungan yang menentukan Secrets Manager tempat informasi ini disimpan.
```
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`Rahasia memiliki nilai rahasia berikut di dalamnya, ditampilkan sebagai plaintext.
```
{
"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"
}
```
Pesan dan file yang diterima oleh bot akan dienkripsi menggunakan kunci KMS yang diidentifikasi oleh nilai ARN, kemudian dimasukkan ke dalam ember “kepatuhan bot” di folder bernama “network1234567890”. Pastikan Anda memiliki pengaturan kebijakan IAM yang sesuai.
# Mulai bot dan konfigurasikan Amazon S3 menggunakan variabel lingkungan
Jika Anda tidak ingin menggunakan Secrets Manager untuk meng-host kredensi bot retensi data, Anda dapat memulai image bot Docker retensi data dengan variabel lingkungan berikut. Anda harus mengidentifikasi nama bot retensi data menggunakan variabel `WICKRIO_BOT_NAME` lingkungan.
```
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
```
Anda dapat menggunakan nilai lingkungan untuk mengidentifikasi kredensional bot retensi data, informasi tentang bucket Amazon S3, dan informasi konfigurasi untuk streaming file default.
# Hentikan bot retensi data untuk jaringan Wickr Anda
Perangkat lunak yang berjalan pada bot retensi data akan menangkap `SIGTERM` sinyal dan mematikan dengan anggun. Gunakan `docker stop ` perintah, seperti yang ditunjukkan pada contoh berikut, untuk mengeluarkan `SIGTERM` perintah ke image bot penyimpanan data Docker.
```
docker stop compliance_1234567890_bot
```
# Dapatkan log retensi data untuk jaringan Wickr Anda
Perangkat lunak yang berjalan pada gambar Docker bot retensi data akan menghasilkan file log di `/tmp//logs` direktori. Mereka akan memutar hingga maksimal 5 file. Anda bisa mendapatkan log dengan menjalankan perintah berikut.
```
docker logs
```
Contoh:
```
docker logs compliance_1234567890_bot
```
# Metrik dan peristiwa retensi data untuk jaringan Wickr Anda
Berikut ini adalah metrik Amazon CloudWatch (CloudWatch) dan peristiwa Simple Notification Service Amazon (Amazon SNS) yang saat ini didukung oleh versi 5.116 dari bot retensi data AWS Wickr.
**Topics**
+ [
# CloudWatch metrik untuk jaringan Wickr Anda
](cloudwatch-metrics.md)
+ [
# Acara Amazon SNS untuk jaringan Wickr Anda
](sns-events.md)
# CloudWatch metrik untuk jaringan Wickr Anda
Metrik dihasilkan oleh bot dalam interval 1 menit dan dikirimkan ke CloudWatch layanan yang terkait dengan akun tempat image bot Docker penyimpanan data berjalan.
Berikut ini adalah metrik yang ada yang didukung oleh bot retensi data.
| Metrik | Deskripsi |
| --- | --- |
| Pesan\$1Rx | Pesan diterima. |
| Pesan\$1Rx\$1Gagal | Kegagalan untuk memproses pesan yang diterima. |
| Messages\$1Saved | Pesan disimpan ke file pesan yang diterima. |
| Messages\$1Saved\$1Failed | Kegagalan untuk menyimpan pesan ke file pesan yang diterima. |
| Files\$1Saved | File yang diterima. |
| Files\$1Saved\$1Bytes | Jumlah byte untuk file yang diterima. |
| Files\$1Saved\$1Failed | Kegagalan untuk menyimpan file. |
| Kredensial Masuk | Login (biasanya ini akan menjadi 1 untuk setiap interval). |
| Login\$1Failures | Kegagalan untuk login (biasanya ini akan menjadi 1 untuk setiap interval). |
| S3\$1Post\$1Errors | Kesalahan saat memposting file pesan dan file ke bucket Amazon S3. |
| Watchdog\$1Failures | Kegagalan pengawas. |
| Watchdog\$1Warnings | Peringatan Watchdog. |
Metrik dihasilkan untuk dikonsumsi oleh CloudWatch. Namespace yang digunakan untuk bot adalah. `WickrIO` Setiap metrik memiliki berbagai dimensi. Berikut ini adalah daftar dimensi yang diposting dengan metrik di atas.
| Dimensi | Nilai |
| --- | --- |
| Id | Nama pengguna bot. |
| Perangkat | Deskripsi perangkat atau contoh bot tertentu. Berguna jika Anda menjalankan beberapa perangkat bot atau instance. |
| Produk | Produk untuk bot. Bisa `WickrPro_` atau `WickrEnterprise_` dengan`Alpha`,`Beta`, atau `Production` ditambahkan. |
| BotType | Jenis bot. Dilabeli sebagai **Kepatuhan** untuk bot kepatuhan. |
| Jaringan | ID dari jaringan terkait. |
# Acara Amazon SNS untuk jaringan Wickr Anda
Peristiwa berikut diposting ke topik Amazon SNS yang ditentukan oleh nilai Amazon Resource Name (ARN) yang diidentifikasi menggunakan variabel `WICKRIO_SNS_TOPIC_ARN` lingkungan atau nilai rahasia Secrets Manager`sns_topic_arn`. Untuk informasi selengkapnya, lihat [Variabel lingkungan untuk mengonfigurasi bot retensi data di AWS Wickr](data-retention-bot-env-variables.md) dan [Nilai Secrets Manager untuk AWS Wickr](data-retention-aws-secret-values.md).
Peristiwa yang dihasilkan oleh bot retensi data dikirim sebagai string JSON. Nilai-nilai berikut disertakan dalam peristiwa pada versi 5.116 dari bot retensi data.
| Nama | Nilai |
| --- | --- |
| ComplianceBot | Nama pengguna bot retensi data. |
| DataTime | Tanggal dan waktu ketika peristiwa itu terjadi. |
| pesawat | Deskripsi perangkat atau instance bot tertentu. Berguna jika Anda menjalankan beberapa instance bot. |
| DockerImage | Gambar Docker yang terkait dengan bot. |
| DockerTag | Tag atau versi gambar Docker. |
| pesan | Pesan acara. Untuk informasi lebih lanjut, lihat [Peristiwa kritis](#sns-critical-events) dan [Peristiwa normal](#sns-normal-events). |
| notificationType | Nilai ini akan menjadi`Bot Event`. |
| kepelikan | Tingkat keparahan acara. Bisa `normal` atau`critical`. |
Anda harus berlangganan topik Amazon SNS sehingga Anda dapat menerima acara. Jika Anda berlangganan menggunakan alamat email, email akan dikirimkan kepada Anda yang berisi informasi yang mirip dengan contoh berikut.
```
{
"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"
}
```
## Peristiwa kritis
Peristiwa ini akan menyebabkan bot berhenti atau memulai ulang. Jumlah restart terbatas untuk menghindari menyebabkan masalah lain.
**Kegagalan login**
Berikut ini adalah kemungkinan peristiwa yang dapat dihasilkan ketika bot gagal masuk. Setiap pesan akan menunjukkan alasan kegagalan login.
| Tipe peristiwa | Pesan peristiwa |
| --- | --- |
| failedlogin | Kredensi buruk. Periksa kata sandinya. |
| failedlogin | Pengguna tidak ditemukan. |
| failedlogin | Akun atau perangkat ditangguhkan. |
| penyediaan | Pengguna keluar dari perintah. |
| penyediaan | Kata sandi yang buruk untuk `config.wickr` file. |
| penyediaan | Tidak dapat membaca `config.wickr` file. |
| failedlogin | Semua login gagal. |
| failedlogin | Pengguna baru tetapi database sudah ada. |
**Peristiwa yang lebih kritis**
| Tipe peristiwa | Pesan peristiwa |
| --- | --- |
| Akun yang Ditangguhkan | Wickr IOClient Main:: slotAdminUser Tangguhkan: kode (% 1): alasan:% 2” |
| BotDevice Ditangguhkan | Perangkat ditangguhkan\$1 |
| WatchDog | SwitchBoard Sistem mati selama lebih dari < *N* > menit |
| Kegagalan S3 | Gagal meletakkan file < *file-name* ≫ di bucket S3. Kesalahan: < *AWS-error* > |
| Kunci Fallback | SERVER SUBMIITED FALLBACK KEY: Bukan kunci fallback aktif klien yang diakui. Silakan kirimkan log ke rekayasa desktop. |
## Peristiwa normal
Berikut ini adalah peristiwa yang memperingatkan Anda tentang kejadian operasi normal. Terlalu banyak kejadian dari jenis peristiwa ini dalam jangka waktu tertentu dapat memprihatinkan.
**Perangkat ditambahkan ke akun**
Acara ini dihasilkan ketika perangkat baru ditambahkan ke akun bot retensi data. Dalam beberapa keadaan, ini bisa menjadi indikasi penting bahwa seseorang telah membuat instance bot retensi data. Berikut ini adalah pesan untuk acara ini.
```
A device has been added to this account!
```
**Bot masuk**
Peristiwa ini dihasilkan ketika bot telah berhasil masuk. Berikut ini adalah pesan untuk acara ini.
```
Logged in
```
**Mematikan**
Acara ini dihasilkan saat bot dimatikan. Jika pengguna tidak secara eksplisit memulai ini, itu bisa menjadi indikasi masalah. Berikut ini adalah pesan untuk acara ini.
```
Shutting down
```
**Pembaruan tersedia**
Peristiwa ini dihasilkan ketika bot retensi data dimulai dan mengidentifikasi bahwa ada versi yang lebih baru dari gambar Docker terkait yang tersedia. Acara ini dihasilkan saat bot dimulai, dan setiap hari. Acara ini mencakup bidang `versions` array yang mengidentifikasi versi baru yang tersedia. Berikut ini adalah contoh seperti apa acara ini.
```
{
"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"
]
}
```