Skip to content

Commit 5160297

Browse files
authored
fix(docs): correct terminology (#4829)
Other minor rewording for clarity and spurious whitespace removals.
1 parent b418315 commit 5160297

File tree

6 files changed

+63
-40
lines changed

6 files changed

+63
-40
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,16 +18,16 @@ Kopia
1818
> 3. _[fast and secure backup tool](https://kopia.io)_
1919
2020

21-
Kopia is a fast and secure open-source backup/restore tool that allows you to create [encrypted](https://kopia.io/docs/features/#end-to-end-zero-knowledge-encryption) snapshots of your data and save the snapshots to [remote or cloud storage](https://kopia.io/docs/features/#save-snapshots-to-cloud-network-or-local-storage) of your choice, [to network-attached storage or server](https://kopia.io/docs/features/#save-snapshots-to-cloud-network-or-local-storage), or [locally on your machine](https://kopia.io/docs/features/#save-snapshots-to-cloud-network-or-local-storage). Kopia does not 'image' your whole machine. Rather, Kopia allows you to backup/restore any and all files/directories that you deem are important or critical.
21+
Kopia is a fast and secure open-source backup/restore tool that allows you to create [encrypted](https://kopia.io/docs/features/#user-controlled-end-to-end-encryption) snapshots of your data and save the snapshots to [remote or cloud storage](https://kopia.io/docs/features/#save-snapshots-to-cloud-network-or-local-storage) of your choice, [to network-attached storage or server](https://kopia.io/docs/features/#save-snapshots-to-cloud-network-or-local-storage), or [locally on your machine](https://kopia.io/docs/features/#save-snapshots-to-cloud-network-or-local-storage). Kopia does not 'image' your whole machine. Rather, Kopia allows you to backup/restore any and all files/directories that you deem are important or critical.
2222

23-
Kopia has both [CLI (command-line interface)](https://kopia.io/docs/features/#both-command-line-and-graphical-user-interfaces) and [GUI (graphical user interface)](https://kopia.io/docs/features/#both-command-line-and-graphical-user-interfaces) versions, making it the perfect tool for both advanced and regular users. You can read more about Kopia's unique [features](https://kopia.io/docs/features/) -- which include [compression](https://kopia.io/docs/features/#compression), [deduplication](https://kopia.io/docs/features/#backup-files-and-directories-using-snapshots), [end-to-end 'zero knowledge' encryption](https://kopia.io/docs/features/#end-to-end-zero-knowledge-encryption), and [error correction](https://kopia.io/docs/features/#error-correction) -- to get a better understanding of how Kopia works.
23+
Kopia has both [CLI (command-line interface)](https://kopia.io/docs/features/#both-command-line-and-graphical-user-interfaces) and [GUI (graphical user interface)](https://kopia.io/docs/features/#both-command-line-and-graphical-user-interfaces) versions, making it the perfect tool for both advanced and regular users. You can read more about Kopia's unique [features](https://kopia.io/docs/features/) -- which include [compression](https://kopia.io/docs/features/#compression), [deduplication](https://kopia.io/docs/features/#backup-files-and-directories-using-snapshots), [user-controlled end-to-end encryption](https://kopia.io/docs/features/#user-controlled-end-to-end-encryption), and [error correction](https://kopia.io/docs/features/#error-correction) -- to get a better understanding of how Kopia works.
2424

2525
When ready, head to the [installation](https://kopia.io/docs/installation/) page to download and install Kopia, and make sure to read the [Getting Started Guide](https://kopia.io/docs/getting-started/) for a step-by-step walkthrough of how to use Kopia.
2626

2727
Pick the Cloud Storage Provider You Want
2828
---
2929

30-
Kopia supports saving your [encrypted](https://kopia.io/docs/features/#end-to-end-zero-knowledge-encryption) and [compressed](https://kopia.io/docs/features/#compression) snapshots to all of the following [storage locations](https://kopia.io/docs/features/#save-snapshots-to-cloud-network-or-local-storage):
30+
Kopia supports saving your [encrypted](https://kopia.io/docs/features/#user-controlled-end-to-end-encryption) and [compressed](https://kopia.io/docs/features/#compression) snapshots to all of the following [storage locations](https://kopia.io/docs/features/#save-snapshots-to-cloud-network-or-local-storage):
3131

3232
* **Amazon S3** and any **cloud storage that is compatible with S3**
3333
* **Azure Blob Storage**

site/content/docs/FAQs/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ A `snapshot` is a [point-in-time backup](../features#backup-files-and-directorie
3232

3333
#### What is a Repository?
3434

35-
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.
35+
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/#user-controlled-end-to-end-encryption) with a password that you designate.
3636

3737
See the [repository help docs](../repositories) for more information.
3838

@@ -95,7 +95,7 @@ You must use Kopia CLI if you want to change your `repository` password; changin
9595

9696
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`.
9797

98-
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.
98+
Remember to select a secure _repository password_. The password is used to [decrypt](../features/#user-controlled-end-to-end-encryption) and access the data in your snapshots.
9999

100100
#### Does Kopia Support Storage Classes, Like Amazon Glacier?
101101

site/content/docs/Features/_index.md

Lines changed: 39 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ weight: 10
88
* [Policies Control What and How Files/Directories are Saved in Snapshots](#policies-control-what-and-how-filesdirectories-are-saved-in-snapshots)
99
* [Save Snapshots to Cloud, Network, or Local Storage](#save-snapshots-to-cloud-network-or-local-storage)
1010
* [Restore Snapshots Using Multiple Methods](#restore-snapshots-using-multiple-methods)
11-
* [End-to-End 'Zero Knowledge' Encryption](#end-to-end-zero-knowledge-encryption)
11+
* [User-controlled End-to-End Encryption](#user-controlled-end-to-end-encryption)
1212
* [Compression](#compression)
1313
* [Error Correction](#error-correction)
1414
* [Verifying Backup Validity and Consistency](#verifying-backup-validity-and-consistency)
@@ -21,7 +21,7 @@ weight: 10
2121

2222
### Backup Files and Directories Using Snapshots
2323

24-
Kopia creates snapshots of the files and directories you designate, then [encrypts](#end-to-end-zero-knowledge-encryption) these snapshots before they leave your computer, and finally uploads these encrypted snapshots to cloud/network/local storage called a [repository](../repositories/). Snapshots are maintained as a set of historical point-in-time records based on [policies](#policies-control-what-and-how-filesdirectories-are-saved-in-snapshots) that you define.
24+
Kopia creates snapshots of the files and directories you designate, then [encrypts](#user-controlled-end-to-end-encryption) these snapshots before they leave your computer, and finally uploads these encrypted snapshots to cloud/network/local storage called a [repository](../repositories/). Snapshots are maintained as a set of historical point-in-time records based on [policies](#policies-control-what-and-how-filesdirectories-are-saved-in-snapshots) that you define.
2525

2626
Kopia uses [content-addressable storage](https://en.wikipedia.org/wiki/Content-addressable%20storage) for snapshots, which has many benefits:
2727

@@ -76,29 +76,48 @@ With Kopia you’re in full control of where to store your snapshots; you pick t
7676

7777
To restore data, Kopia gives you three options:
7878

79-
* mount the contents of a snapshot as a local disk so that you can browse and copy files/directories from the snapshot as if the snapshot is a local directory on your machine
80-
81-
* restore all files/directories contained in a snapshot to any local or network location that you designate
82-
83-
* selectively restore individual files from a snapshot
84-
85-
### End-to-End 'Zero Knowledge' Encryption
86-
87-
All data is encrypted before it leaves your machine. Encryption is baked into the DNA of Kopia, and you cannot create a backup without using encryption. Kopia allows you to pick from two state-of-the-art encryption algorithms, [AES-256](https://en.wikipedia.org/wiki/AES256) and [ChaCha20](https://en.wikipedia.org/wiki/ChaCha20).
88-
89-
Kopia encrypts both the content and the names of your backed up files/directories.
90-
91-
The data is encrypted using per-content keys which are derived from the 256-bit master key that is stored in the repository. The master key is encrypted with a password you provide. This means that anyone that does not know the password cannot access your backed up files and will not know what files/directories are contained in the snapshots that are saved in the repository. Importantly, the password you provide is never sent to any server or anywhere outside your machine, and only you know your password. In other words, Kopia provides your backups with end-to-end 'zero knowledge' encryption. However, this also means that you cannot restore your files if you forget your password: there is no way to recover a forgotten password because only you know it. (But you can [change your password](../faqs/#how-do-i-change-my-repository-password) if you are still connected to the repository that stores your snapshots.)
79+
- mount the contents of a snapshot as a local disk so that you can browse and copy files/directories from the snapshot as if the snapshot is a local directory on your machine
80+
- restore all files/directories contained in a snapshot to any local or network location that you designate
81+
- selectively restore individual files from a snapshot
82+
83+
### User-Controlled End-to-End Encryption
84+
85+
Kopia uses end-to-end encryption, with user-controlled encryption keys,[^1] to
86+
encrypt all data before it leaves your machine, this includes the content and the
87+
names of the backed up files/directories. Kopia does not allow creating
88+
unencrypted backups.
89+
90+
[^1]: This encryption approach is often imprecisely named 'Zero-knowledge
91+
encryption' in marketing materials. The name can be easily confused with the
92+
term ['Zero-knowledge Proof'](https://en.wikipedia.org/wiki/Zero-knowledge_proof),
93+
which refers to a completely different concept.
94+
95+
When creating or accessing a backup repository, you provide the repository
96+
password, which is not sent to any server or anywhere outside your machine, and
97+
only you know the password.
98+
Instead, the repository password is used to encrypt and decrypt the repository's
99+
primary encryption key. The primary key is securely generated at repository
100+
creation time in the computer that is creating the repository, such as your laptop.
101+
This means that the repository password is required to read any data stored in
102+
that repository. Without the password, you will not be able to read the contents
103+
of files stored in backups, nor see what files/directories are contained in
104+
the backups, nor list what backups are in the repository. It also means that
105+
you cannot restore your files if you forget your password, there is no way to
106+
recover a forgotten password because only you know it. You can
107+
[change your password](../faqs/#how-do-i-change-my-repository-password) if
108+
you are still connected to the repository.
109+
110+
You can pick from two standard encryption algorithms,
111+
[AES-256](https://en.wikipedia.org/wiki/AES256) and
112+
[ChaCha20](https://en.wikipedia.org/wiki/ChaCha20), for encrypting your backups.
92113

93114
### Compression
94115

95116
Kopia can [compress your data](../advanced/compression/) to save storage and bandwidth. Several compression methods are supported, including:
96117

97-
* [pgzip](https://github.com/klauspost/pgzip)
98-
99-
* [s2](https://github.com/klauspost/compress/tree/master/s2)
100-
101-
* [zstd](https://github.com/klauspost/compress/tree/master/zstd)
118+
- [pgzip](https://github.com/klauspost/pgzip)
119+
- [s2](https://github.com/klauspost/compress/tree/master/s2)
120+
- [zstd](https://github.com/klauspost/compress/tree/master/zstd)
102121

103122
### Error Correction
104123

0 commit comments

Comments
 (0)