From 282134e489fe97de1fa472f0702218d37db0cd47 Mon Sep 17 00:00:00 2001 From: basldfalksjdf <106879934+basldfalksjdf@users.noreply.github.com> Date: Thu, 7 Jul 2022 01:56:49 -0400 Subject: [PATCH] docs(site): Updating FAQs (#2136) --- site/content/docs/FAQs/_index.md | 63 ++++++++++++++++++++++++++++---- 1 file changed, 56 insertions(+), 7 deletions(-) diff --git a/site/content/docs/FAQs/_index.md b/site/content/docs/FAQs/_index.md index fd6d3ceaf..fb963e959 100644 --- a/site/content/docs/FAQs/_index.md +++ b/site/content/docs/FAQs/_index.md @@ -4,25 +4,37 @@ linkTitle: "Frequently Asked Questions" weight: 4 --- -> NOTE: This page is under development. Feel free to contribute as you see fit. +### Questions + +* [What is a Snapshot?](#what-is-a-snapshot) +* [What is a Repository?](#what-is-a-repository) +* [What is a Policy?](#what-is-a-policy) +* [How to Restore My Backed Up Files/Directories?](#how-to-restore-my-backed-up-filesdirectories) +* [How Do I Enable Encryption?](#how-do-i-enable-encryption) +* [How Do I Enable Compression?](#how-do-i-enable-compression) +* [How Do I Enable Data Deduplication?](#how-do-i-enable-data-deduplication) +* [How Do I Change My Repository Password?](#how-do-i-change-my-repository-password) +* [What is a Kopia Repository Server?](#what-is-a-kopia-repository-server) **Is your question not answered here? Please ask in the [Kopia discussion forums](https://kopia.discourse.group/) for help!** -##### What is a Snapshot? +### Answers + +#### What is a Snapshot? A `snapshot` is a [point-in-time backup](../features#backup-files-and-directories-using-snapshots) of your files/directories; each snapshot contains the files/directories that you can [restore when you need to](../features#restore-snapshots-using-multiple-methods). -##### What is a Repository? +#### What is a Repository? -A `repository` is the storage location where your snapshots are saved; Kopia supports [cloud/remote, network, and local storage locations](../features#save-snapshots-to-cloud-network-or-local-storage) and all repositories are [encrypted](../features/#end-to-end-zero-knowledge-encryption) with a passphrase that you designate. +A `repository` is the storage location where your snapshots are saved; Kopia supports [cloud/remote, network, and local storage locations](../features#save-snapshots-to-cloud-network-or-local-storage) and all repositories are [encrypted](../features/#end-to-end-zero-knowledge-encryption) with a password that you designate. See the [repository help docs](../repository) for more information. -##### What is a Policy? +#### What is a Policy? A `policy` is a set of rules that tells Kopia how to create/manage snapshots; this includes features such as [compression, snapshot retention, and scheduling when to take automatically snapshots](../features#policies-control-what-and-how-filesdirectories-are-saved-in-snapshots). -##### How to Restore Files/Directories? +#### How to Restore My Backed Up Files/Directories? Files/directories are restored from the snapshots you create. To restore the data you backed up in a snapshot, Kopia gives you three options: @@ -34,6 +46,43 @@ Files/directories are restored from the snapshots you create. To restore the dat The [Getting Started Guide](../getting-started/) provides directions on how to restore files/directions [when using Kopia GUI](../getting-started/#restoring-filesdirectories-from-snapshots) and [when using Kopia CLI](../getting-started/#mounting-snapshots-and-restoring-filesdirectories-from-snapshots). -##### What is a Kopia Repository Server? +#### How Do I Enable Encryption? + +Encryption is at the `repository` level, and Kopia encrypts all snapshots in all repositories by default. You should have been asked for a password when you created your `repository`. That password is used to encrypt your backups. (Do not forget it, there is no way to recover the password!) + +By default, Kopia uses the `AES256-GCM-HMAC-SHA256` encryption algorithm for all repositories, but you can choose `CHACHA20-POLY1305-HMAC-SHA256` if you want to. Picking an encryption algorithm is done when you initially create a `repository`. In `KopiaUI`, to pick the `CHACHA20-POLY1305-HMAC-SHA256` encryption algorithm, you need to click the `Show Advanced Options` button at the screen where you enter your password when creating a new `repository`. For Kopia CLI users, you need to use the `--encryption=CHACHA20-POLY1305-HMAC-SHA256` option when [creating a `repository`](../getting-started/#creating-a-repository) with the [`kopia repository create` command](../reference/command-line/common/#commands-to-manipulate-repository). + +Currently, encryption algorithms cannot be changed after a `repository` has been created. + +#### How Do I Enable Compression? + +Compression is controlled by [policies](../features#policies-control-what-and-how-filesdirectories-are-saved-in-snapshots) and is disabled by default. If compression is not working for a snapshot, it is likely that you have not enabled compression yet in your `policy`. + +Enabling compression when using `KopiaUI` is easy; edit the `policy` you want to add compression to and pick a `Compression Algorithm` in the `Compression` section. Kopia CLI users need to use the [`kopia policy set`](..reference/command-line/common/policy-set/) command as shown in the [Getting Started Guide](../getting-started/#policies). You can set compression on a per-source-directory basis... + +```shell +kopia policy set --compression= +``` + +...or globally for all source directories: + +```shell +kopia policy set --global --compression= +``` +If you enable or disable compression or change the compression algorithm, the new setting is applied going forward and not reteroactively. In other words, Kopia will not modify the compression for files/directories already uploaded to your repository. + +#### How Do I Enable Data Deduplication? + +[Data deduplication](../features/#backup-files-and-directories-using-snapshots) is enabled automatically by Kopia for all repositories, regardless of whether you use the GUI or CLI. You do not need to do anything. + +#### How Do I Change My Repository Password? + +You must use Kopia CLI if you want to change your `repository` password; changing password is not currently supported via Kopia GUI. The [`kopia repository change-password` command](../reference/command-line/common/repository-change-password/) is used to change your password. + +Before changing your password, you must be [connected to your `repository`](../getting-started/#connecting-to-repository). This means that you **can** reset your password if you forget your password AND you are still connected to your `repository`. But this also means that you **cannot** reset your password if you forget your password and you are NOT still connected to your `repository`, because you will need your current password to connect to the `repository`. + +Remember to select a secure _repository password_. The password is used to [decrypt](../features/#end-to-end-zero-knowledge-encryption) and access the data in your snapshots. + +#### What is a Kopia Repository Server? See the [Kopia Repository Server help docs](../repository-server) for more information.