Skip to content

Commit 823bc5c

Browse files
authored
Merge pull request #176 from cryptomator/feature/restore-files-from-backup
Add restoring files from backup
2 parents 5fc5d14 + 3ec1537 commit 823bc5c

10 files changed

Lines changed: 59 additions & 8 deletions

‎docs/desktop/admin-config.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: admin-config
33
title: Admin Configuration
4-
sidebar_position: 12
4+
sidebar_position: 13
55
---
66

77
# Admin Configuration

‎docs/desktop/common-errors.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: common-errors
33
title: Common Errors
4-
sidebar_position: 15
4+
sidebar_position: 16
55
---
66

77
# Common Errors

‎docs/desktop/encrypted-file-names.mdx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ File name and directory structure encryption **cannot** be disabled.
1313
Cryptomator protects your files by not only encrypting their content, but also their names and the overall directory structure of the vault. As a result, encrypted files and folders inside the vault storage location do not reveal the original names or layout (for an example see [below](#technical-example)).
1414

1515
This matters whenever you need to match a cleartext file in your unlocked vault with its encrypted counterpart in the vault storage location, for example when restoring an older version from a cloud provider or backup tool.
16+
For step-by-step instructions, see [Restoring Files from a Backup](/docs/desktop/restoring-files-from-backup.mdx).
1617

1718
The app offers two features to reveal the mapping between the cleartext and the encrypted files:
1819
* `Locate Encrypted File`: You have the cleartext file in the unlocked vault and want to find its encrypted counterpart in the vault storage location.

‎docs/desktop/error-handling.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: error-handling
33
title: Error Handling
4-
sidebar_position: 10
4+
sidebar_position: 11
55
---
66

77
# Error Handling

‎docs/desktop/network.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: network
33
title: Network Settings
4-
sidebar_position: 13
4+
sidebar_position: 14
55
---
66

77
# Network Settings
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
id: restoring-files-from-backup
3+
title: Restoring Files from a Backup
4+
sidebar_position: 8
5+
---
6+
7+
# Restoring Files from a Backup
8+
9+
Cryptomator encrypts not only file names but also the directory structure of your vault (see [Encrypted File Names](/docs/desktop/encrypted-file-names.mdx)).
10+
In a backup of the vault storage location, you therefore can't tell which encrypted file belongs to which cleartext file, especially if it sits deep in a subdirectory.
11+
12+
There are two ways to restore a file or folder:
13+
14+
1. [Open the backup as a second vault](#open-backup-as-vault) - Recommended. Works at any nesting depth and also for files and folders that have already been deleted from the vault.
15+
2. [Restore a single encrypted file](#restore-single-encrypted-file) - Use this if the file still exists in the vault with the same name and in the same folder as at the time of the backup, you only need an older version of it, and your backup tool can restore individual files.
16+
17+
Both methods require Cryptomator for Windows, macOS, or Linux.
18+
19+
## Open the Backup as a Second Vault {/* #open-backup-as-vault */}
20+
21+
1. Restore the **complete** vault folder from the backup to a separate location. It must contain the `d` folder and the `vault.cryptomator` and/or `masterkey.cryptomator` file.
22+
Do not restore it inside the existing vault folder or inside a cloud-synced folder.
23+
2. In Cryptomator, click the plus `+` button, choose [`Open Existing Vault…`](/docs/desktop/adding-vaults.mdx#open-an-existing-vault), and select the `vault.cryptomator` file of the restored copy. If only a `masterkey.cryptomator` file exists, select that instead.
24+
The copy appears as an additional vault next to your original one.
25+
3. Unlock the copy.
26+
For a password-based vault, use the password that was valid at the time of the backup.
27+
For a [Cryptomator Hub](/docs/hub/introduction.mdx) vault, [unlock it through Hub](/docs/hub/user-guide/access-vault.mdx#unlocking-a-vault) as usual.
28+
Unlock your original vault as well.
29+
4. In the unlocked copy, navigate to the file or folder you want to restore and copy it into your original vault.
30+
5. Lock the copy and [remove it from the vault list](/docs/desktop/vault-management.mdx#remove-vaults) by right-clicking it and choosing `Remove…`.
31+
This only removes the list entry and doesn't delete any encrypted files.
32+
You can then delete the restored vault folder manually.
33+
34+
## Restore a Single Encrypted File {/* #restore-single-encrypted-file */}
35+
36+
This method only works if the file still exists in the vault with the same name and in the same folder as at the time of the backup.
37+
If the file was renamed or moved to a different folder since the backup, its encrypted path has changed, so [open the backup as a second vault](#open-backup-as-vault) instead.
38+
39+
1. Unlock the vault and use [`Locate Encrypted File`](/docs/desktop/encrypted-file-names.mdx#locate-encrypted-file) on the file you want to restore.
40+
Note the path of the encrypted file shown in the file manager.
41+
2. Lock the vault.
42+
3. With your backup tool, restore exactly that encrypted file to exactly the same path, overwriting the current one.
43+
If the file ends up anywhere else, the vault won't recognize it, because its name is encrypted using the ID of its parent directory.
44+
4. Unlock the vault again.
45+
46+
:::note
47+
If you use `Locate Encrypted File` on a folder, the file manager shows the folder's content directory under `d/`.
48+
It only contains the files directly inside that folder.
49+
Subfolders are stored as links (`dir.c9r`) to other directories under `d/`, so to restore a folder with subfolders, [open the backup as a second vault](#open-backup-as-vault).
50+
:::

‎docs/desktop/sync-conflicts.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: sync-conflicts
33
title: Synchronization Conflicts
4-
sidebar_position: 11
4+
sidebar_position: 12
55
---
66

77
# Synchronization Conflicts

‎docs/desktop/troubleshooting.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: troubleshooting
33
title: Troubleshooting
4-
sidebar_position: 14
4+
sidebar_position: 15
55
---
66

77
# Troubleshooting

‎docs/desktop/vault-events.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: vault-events
33
title: Events and Event View
4-
sidebar_position: 9
4+
sidebar_position: 10
55
---
66

77
# Events and Event View

‎docs/desktop/volume-type.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
id: volume-type
33
title: Volume Types
4-
sidebar_position: 8
4+
sidebar_position: 9
55
---
66

77
# Volume Types

0 commit comments

Comments
 (0)