diff --git a/README.md b/README.md index bddaf2665..5c54142c3 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ Kopia 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. -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), and [end-to-end 'zero knowledge' encryption](https://kopia.io/docs/features/#end-to-end-zero-knowledge-encryption) -- to get a better understanding of how Kopia works. +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. 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. diff --git a/site/content/docs/Advanced/ECC/_index.md b/site/content/docs/Advanced/ECC/_index.md new file mode 100644 index 000000000..7a6cc5f81 --- /dev/null +++ b/site/content/docs/Advanced/ECC/_index.md @@ -0,0 +1,13 @@ +--- +title: "Error Correction Algorithm" +linkTitle: "Error Correction Algorithm" +weight: 13 +--- + +Starting with v0.12.0, Kopia supports the use of error correction using the Reed-Solomon error correction algorithm. Error correction in Kopia is used to mitigate the likelihood that your snapshots become corrupt due to storage errors caused by the hardware your snapshots are saved on (like bitflips). Most, if not all, cloud storage platforms use their own error correction, so using Kopia's error correction for cloud repositories may be overkill. However, the choice is yours. + +If you use error correction in Kopia, the `Error Correction Overhead` option controls how much extra storage space is needed for the error correction code. So, for example, if you pick the `1%` option, then your repository will use 1% more storage space with error correction enabled compared to without error correction. + +Currently, if you want to use Reed-Solomon error correction with Kopia, you must create a new repository and enable the option when you create the new repository, because there is not yet a way to enable the feature for an existing repository. + +**This feature is currently experimental.** Use at your own risk. You can read more about how the Reed-Solomon algorithm works at [Wikipedia](https://en.wikipedia.org/wiki/Reed%E2%80%93Solomon_error_correction). diff --git a/site/content/docs/Features/_index.md b/site/content/docs/Features/_index.md index a945a2481..7913ca2a6 100644 --- a/site/content/docs/Features/_index.md +++ b/site/content/docs/Features/_index.md @@ -10,6 +10,7 @@ weight: 10 * [Restore Snapshots Using Multiple Methods](#restore-snapshots-using-multiple-methods) * [End-to-End 'Zero Knowledge' Encryption](#end-to-end-zero-knowledge-encryption) * [Compression](#compression) +* [Error Correction](#error-correction) * [Verifying Backup Validity and Consistency](#verifying-backup-validity-and-consistency) * [Recovering Backed Up Data When There is Data Loss](#recovering-backed-up-data-when-there-is-data-loss) * [Regular Automatic Maintence of Repositories](#regular-automatic-maintence-of-repositories) @@ -99,6 +100,10 @@ Kopia can [compress your data](../advanced/compression/) to save storage and ban * [zstd](https://github.com/klauspost/compress/tree/master/zstd) +### Error Correction + +Kopia supports [Reed-Solomon error correction algorithm](../advanced/ecc/) to help prevent your snapshots from being corrupted by faulty hardware, such as bitflips or bitrot. + ### Verifying Backup Validity and Consistency Backing up data is great, but you also need to be able to restore that data when (if) the time arises. Kopia has built-in functions that enable you to verify the consistency/validity of your backed up files. You can run these consistency checks are frequently as you like (e.g., once a month, once a year, etc.). Read the [repository consistency](../advanced/consistency/) help docs for more information. diff --git a/site/content/docs/_index.md b/site/content/docs/_index.md index 2f4f13f31..7dd6edd34 100755 --- a/site/content/docs/_index.md +++ b/site/content/docs/_index.md @@ -7,7 +7,7 @@ weight: 20 Kopia is a fast and secure open-source backup/restore tool that allows you to create [encrypted](features/#end-to-end-zero-knowledge-encryption) snapshots of your data and save the snapshots to [remote or cloud storage](features/#save-snapshots-to-cloud-network-or-local-storage) of your choice, [to network-attached storage or server](features/#save-snapshots-to-cloud-network-or-local-storage), or [locally on your machine](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. -Kopia has both [CLI (command-line interface)](features/#both-command-line-and-graphical-user-interfaces) and [GUI (graphical user interface)](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](features/) -- which include [compression](features/#compression), [deduplication](features/#backup-files-and-directories-using-snapshots), and [end-to-end 'zero knowledge' encryption](features/#end-to-end-zero-knowledge-encryption) -- to get a better understanding of how Kopia works. +Kopia has both [CLI (command-line interface)](features/#both-command-line-and-graphical-user-interfaces) and [GUI (graphical user interface)](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](features/) -- which include [compression](features/#compression), [deduplication](features/#backup-files-and-directories-using-snapshots), [end-to-end 'zero knowledge' encryption](features/#end-to-end-zero-knowledge-encryption), and [error correction](features/#error-correction) -- to get a better understanding of how Kopia works. When ready, head to the [installation](installation/) page to download and install Kopia, and make sure to read the [Getting Started Guide](getting-started/) for a step-by-step walkthrough of how to use Kopia.