From b1027f2adde1088d896e7c6896fce92e8ab0e1a3 Mon Sep 17 00:00:00 2001 From: Jan-Peter Klein Date: Fri, 17 Oct 2025 17:33:56 +0200 Subject: [PATCH 1/9] add desktop vault recovery --- docs/desktop/vault-recovery.md | 79 ++++++++++++++++++++++++++++++++++ 1 file changed, 79 insertions(+) create mode 100644 docs/desktop/vault-recovery.md diff --git a/docs/desktop/vault-recovery.md b/docs/desktop/vault-recovery.md new file mode 100644 index 0000000..c106499 --- /dev/null +++ b/docs/desktop/vault-recovery.md @@ -0,0 +1,79 @@ +--- +id: vault-recovery +title: Vault Recovery +sidebar_position: 20 +--- + +# Vault Recovery + +If a vault can’t be opened because important files are missing, Cryptomator can help you recover it. +This feature is designed to restore access to your encrypted files safely and easily — even if your vault configuration or masterkey files were lost or damaged. + +:::note +Vault Recovery does not restore your encrypted files. +It recreates missing configuration files such as `vault.cryptomator` and `masterkey.cryptomator` so that Cryptomator can recognize and unlock your vault again. +::: + +1. [`Recover Masterkey file…`](#recover-masterkey-file) - If your masterkey file went missing… +2. [`Recover Vault config file…`](#recover-vault-config) - If your vault config file went missing… +3. [`Recover Masterkey and Vault config files…`](#recover-full) - If your vault config and masterkey file went missing… +4. [`Add a vault with missing config files and restore them…`](#add-recover-vault) - If you want to add a vault where your config and/or masterkey file went missing… + +## Recover Masterkey file {#recover-masterkey-file} + +If the file `masterkey.cryptomator` is missing from your vault folder, Cryptomator will still recognize the folder as a normal vault. + +When you try to unlock the vault, a dialog appears saying “Masterkey file not found.” + +In this dialog, you can: +- `Choose` a masterkey file manually, if it was stored outside the vault folder. +- Or check the option “Restore the masterkey file instead” and click `Restore`. + +To complete the restore process, you’ll need to enter your recovery key. +Cryptomator will then recreate the missing `masterkey.cryptomator` file in the vault folder, allowing you to unlock it again as usual. + +## Recover Vault config file {#recover-vault-config} + +If the file `vault.cryptomator` is missing, Cryptomator can recreate it using either your vault password or your recovery key. + +In the vault list, the vault is marked with an exclamation mark. +In Vault Details, you’ll see `Vault config is missing.`. +Here you can click `Restore vault config` to start the recovery. + +Choose one of the options: +- Use Recovery Key +- Use Password + +You’ll be guided through the recovery. +During the process, you must enter the Expert Settings. +After confirming, Cryptomator restores the `vault.cryptomator` file and you can open the vault as usual. + +## Recover Masterkey and Vault config files {#recover-full} +:::note +If this is a Cryptomator Hub Vault, you can’t restore the missing files yourself. +Please contact the vault owner, who can recreate the configuration file for you. +::: + +If both – the `masterkey.cryptomator` and `vault.cryptomator` files – are missing, Cryptomator can restore them using your recovery key. + +In the vault list, the vault is marked with an exclamation mark. +In Vault Details, you’ll see `Vault config is missing.`. +Here you can click “Restore vault config” to start the recovery. + +You’ll be asked to enter your Recovery Key to continue. +During the process, you must enter the Expert Settings. + +After confirming, Cryptomator recreates both missing files in the vault folder. +Once the process completes, the vault can be opened again as usual. + +## Add a vault with missing config files and restore them {#add-recover-vault} + +If a vault has no configuration files and does not yet appear in the vault list, you can start the recovery manually. + +Open the main window and click the plus `+` button. +In the context menu, choose `Recover Existing Vault…`. + +Then select the vault directory you want to restore. +Depending on which configuration files are missing, Cryptomator will guide you through the same recovery options described in Recover Masterkey file, Recover Vault config file, or Recover Masterkey and Vault config files. + +After the process completes, the restored vault will be added to your vault list automatically. \ No newline at end of file From c707ae03f6065fc61a747b08fbe794e507288aed Mon Sep 17 00:00:00 2001 From: Jan-Peter Klein Date: Sat, 18 Oct 2025 09:43:53 +0200 Subject: [PATCH 2/9] some wording changes --- docs/desktop/vault-recovery.md | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) diff --git a/docs/desktop/vault-recovery.md b/docs/desktop/vault-recovery.md index c106499..1145968 100644 --- a/docs/desktop/vault-recovery.md +++ b/docs/desktop/vault-recovery.md @@ -6,18 +6,18 @@ sidebar_position: 20 # Vault Recovery -If a vault can’t be opened because important files are missing, Cryptomator can help you recover it. -This feature is designed to restore access to your encrypted files safely and easily — even if your vault configuration or masterkey files were lost or damaged. +If a vault cannot be opened anymore due to missing configuration files, Cryptomator can help you recover it. +This feature is designed to restore access to your encrypted files crypted files in a safe and easy way your vault configuration or masterkey files were lost or damaged. :::note Vault Recovery does not restore your encrypted files. -It recreates missing configuration files such as `vault.cryptomator` and `masterkey.cryptomator` so that Cryptomator can recognize and unlock your vault again. +It only recreates missing configuration files such as `vault.cryptomator` and `masterkey.cryptomator` so that Cryptomator can recognize and unlock your vault again. ::: -1. [`Recover Masterkey file…`](#recover-masterkey-file) - If your masterkey file went missing… -2. [`Recover Vault config file…`](#recover-vault-config) - If your vault config file went missing… -3. [`Recover Masterkey and Vault config files…`](#recover-full) - If your vault config and masterkey file went missing… -4. [`Add a vault with missing config files and restore them…`](#add-recover-vault) - If you want to add a vault where your config and/or masterkey file went missing… +1. [`Recover Masterkey file…`](#recover-masterkey-file) - If the masterkey file went missing. +2. [`Recover Vault config file…`](#recover-vault-config) - If the vault config file went missing. +3. [`Recover Masterkey and Vault config files…`](#recover-full) - If the vault config and masterkey file went missing. +4. [`Add a vault with missing config files and restore them…`](#add-recover-vault) - If you want to add a vault where the config and/or masterkey file went missing. ## Recover Masterkey file {#recover-masterkey-file} @@ -40,9 +40,7 @@ In the vault list, the vault is marked with an exclamation mark. In Vault Details, you’ll see `Vault config is missing.`. Here you can click `Restore vault config` to start the recovery. -Choose one of the options: -- Use Recovery Key -- Use Password +You either need the Recovery Key or the vault password for the recovery process. You’ll be guided through the recovery. During the process, you must enter the Expert Settings. From 8a02438ee6d550bd702c58bf863e7322f445dfb4 Mon Sep 17 00:00:00 2001 From: Jan-Peter Klein Date: Mon, 20 Oct 2025 11:15:50 +0200 Subject: [PATCH 3/9] can't instead of cannot --- docs/desktop/vault-recovery.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/desktop/vault-recovery.md b/docs/desktop/vault-recovery.md index 1145968..d6356ef 100644 --- a/docs/desktop/vault-recovery.md +++ b/docs/desktop/vault-recovery.md @@ -6,7 +6,7 @@ sidebar_position: 20 # Vault Recovery -If a vault cannot be opened anymore due to missing configuration files, Cryptomator can help you recover it. +If a vault can't be opened anymore due to missing configuration files, Cryptomator can help you recover it. This feature is designed to restore access to your encrypted files crypted files in a safe and easy way your vault configuration or masterkey files were lost or damaged. :::note From 6f578d19a03b671fdce525e0cc59ad26a46755de Mon Sep 17 00:00:00 2001 From: Jan-Peter Klein Date: Mon, 20 Oct 2025 11:30:01 +0200 Subject: [PATCH 4/9] added intro --- docs/desktop/vault-recovery.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/desktop/vault-recovery.md b/docs/desktop/vault-recovery.md index d6356ef..1948d4c 100644 --- a/docs/desktop/vault-recovery.md +++ b/docs/desktop/vault-recovery.md @@ -14,6 +14,8 @@ Vault Recovery does not restore your encrypted files. It only recreates missing configuration files such as `vault.cryptomator` and `masterkey.cryptomator` so that Cryptomator can recognize and unlock your vault again. ::: +You can restore your vault even if essential files are missing: + 1. [`Recover Masterkey file…`](#recover-masterkey-file) - If the masterkey file went missing. 2. [`Recover Vault config file…`](#recover-vault-config) - If the vault config file went missing. 3. [`Recover Masterkey and Vault config files…`](#recover-full) - If the vault config and masterkey file went missing. From 1a7fe2281a9292b03ffd2ccb5aa9358b225cd9dd Mon Sep 17 00:00:00 2001 From: Jan-Peter Klein Date: Mon, 20 Oct 2025 11:30:29 +0200 Subject: [PATCH 5/9] added warning --- docs/desktop/vault-recovery.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/desktop/vault-recovery.md b/docs/desktop/vault-recovery.md index 1948d4c..80d6774 100644 --- a/docs/desktop/vault-recovery.md +++ b/docs/desktop/vault-recovery.md @@ -21,6 +21,11 @@ You can restore your vault even if essential files are missing: 3. [`Recover Masterkey and Vault config files…`](#recover-full) - If the vault config and masterkey file went missing. 4. [`Add a vault with missing config files and restore them…`](#add-recover-vault) - If you want to add a vault where the config and/or masterkey file went missing. +:::warning +Recovery of missing files is only supported starting with Vault Format 8 (introduced in Cryptomator 1.6.0). +Vaults created with older formats (e.g., Vault Format 7 or earlier) are not compatible with these recovery options. +For details, see the [Vault Format History](/docs/misc/vault-format-history.md). +::: ## Recover Masterkey file {#recover-masterkey-file} If the file `masterkey.cryptomator` is missing from your vault folder, Cryptomator will still recognize the folder as a normal vault. From e53e90e0b3bea6a213dc9b099fd3a7f86ce2d68f Mon Sep 17 00:00:00 2001 From: Jan-Peter Klein Date: Mon, 20 Oct 2025 11:31:25 +0200 Subject: [PATCH 6/9] infeo suggested change --- docs/desktop/vault-recovery.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/docs/desktop/vault-recovery.md b/docs/desktop/vault-recovery.md index 80d6774..8336940 100644 --- a/docs/desktop/vault-recovery.md +++ b/docs/desktop/vault-recovery.md @@ -49,9 +49,7 @@ Here you can click `Restore vault config` to start the recovery. You either need the Recovery Key or the vault password for the recovery process. -You’ll be guided through the recovery. -During the process, you must enter the Expert Settings. -After confirming, Cryptomator restores the `vault.cryptomator` file and you can open the vault as usual. +You’ll be guided through the recovery, and you can open the vault as usual. ## Recover Masterkey and Vault config files {#recover-full} :::note From 1f6367f491b33c86ebfaa4f41515bd1f60eaa1f5 Mon Sep 17 00:00:00 2001 From: Armin Schrenk Date: Mon, 3 Nov 2025 16:43:46 +0100 Subject: [PATCH 7/9] Update text --- docs/desktop/vault-recovery.md | 47 ++++++++++++++++------------------ 1 file changed, 22 insertions(+), 25 deletions(-) diff --git a/docs/desktop/vault-recovery.md b/docs/desktop/vault-recovery.md index 8336940..391fc60 100644 --- a/docs/desktop/vault-recovery.md +++ b/docs/desktop/vault-recovery.md @@ -6,26 +6,27 @@ sidebar_position: 20 # Vault Recovery -If a vault can't be opened anymore due to missing configuration files, Cryptomator can help you recover it. -This feature is designed to restore access to your encrypted files crypted files in a safe and easy way your vault configuration or masterkey files were lost or damaged. +If a vault cannot be added to Cryptomator or opened from inside the app anymore, you can use the Vault Recovery feature to unlock it again. :::note Vault Recovery does not restore your encrypted files. -It only recreates missing configuration files such as `vault.cryptomator` and `masterkey.cryptomator` so that Cryptomator can recognize and unlock your vault again. +It only recreates missing configuration files such as `vault.cryptomator` in order for Cryptomator to recognize and unlock your vault again. ::: -You can restore your vault even if essential files are missing: +It helps with the following scenarios: -1. [`Recover Masterkey file…`](#recover-masterkey-file) - If the masterkey file went missing. -2. [`Recover Vault config file…`](#recover-vault-config) - If the vault config file went missing. -3. [`Recover Masterkey and Vault config files…`](#recover-full) - If the vault config and masterkey file went missing. -4. [`Add a vault with missing config files and restore them…`](#add-recover-vault) - If you want to add a vault where the config and/or masterkey file went missing. +1. The masterkey file is missing or damaged - [`Recover Masterkey file`](#recover-masterkey-file) +1. The vault config file is missing or damaged - [`Recover Vault config file`](#recover-vault-config) +1. The masterkey and the vault config files are missing or damaged - [`Recover Masterkey and Vault config files`](#recover-full) + +If the damaged vault is not yet added to Cryptomator, you start the recovery during the import process, see [`Add a vault with missing config files and restore them`](#add-recover-vault). :::warning Recovery of missing files is only supported starting with Vault Format 8 (introduced in Cryptomator 1.6.0). Vaults created with older formats (e.g., Vault Format 7 or earlier) are not compatible with these recovery options. For details, see the [Vault Format History](/docs/misc/vault-format-history.md). ::: + ## Recover Masterkey file {#recover-masterkey-file} If the file `masterkey.cryptomator` is missing from your vault folder, Cryptomator will still recognize the folder as a normal vault. @@ -36,8 +37,8 @@ In this dialog, you can: - `Choose` a masterkey file manually, if it was stored outside the vault folder. - Or check the option “Restore the masterkey file instead” and click `Restore`. -To complete the restore process, you’ll need to enter your recovery key. -Cryptomator will then recreate the missing `masterkey.cryptomator` file in the vault folder, allowing you to unlock it again as usual. +For the latter case, you need the vault recovery key to restore the masterkey file. +You’ll be guided through the recovery process and on success, you can unlock the vault as usual. ## Recover Vault config file {#recover-vault-config} @@ -45,38 +46,34 @@ If the file `vault.cryptomator` is missing, Cryptomator can recreate it using ei In the vault list, the vault is marked with an exclamation mark. In Vault Details, you’ll see `Vault config is missing.`. -Here you can click `Restore vault config` to start the recovery. +Here you can click `Restore vault config` to start the recovery process. -You either need the Recovery Key or the vault password for the recovery process. - -You’ll be guided through the recovery, and you can open the vault as usual. +You either need the Recovery Key or the vault password to restore the vault config file. +You’ll be guided through the process and on success, you can open the vault as usual. ## Recover Masterkey and Vault config files {#recover-full} :::note -If this is a Cryptomator Hub Vault, you can’t restore the missing files yourself. +If the vault is created with Cryptomator Hub, you can’t restore the missing config files yourself. Please contact the vault owner, who can recreate the configuration file for you. ::: -If both – the `masterkey.cryptomator` and `vault.cryptomator` files – are missing, Cryptomator can restore them using your recovery key. +If both config files – `masterkey.cryptomator` and `vault.cryptomator` – are missing, Cryptomator can restore them using your recovery key. In the vault list, the vault is marked with an exclamation mark. In Vault Details, you’ll see `Vault config is missing.`. -Here you can click “Restore vault config” to start the recovery. - -You’ll be asked to enter your Recovery Key to continue. -During the process, you must enter the Expert Settings. +Here you can click “Restore vault config” to start the recovery process. -After confirming, Cryptomator recreates both missing files in the vault folder. -Once the process completes, the vault can be opened again as usual. +You need the Recovery Key to restore the vault config file. +You’ll be guided through the process and on success, you can open the vault as usual. ## Add a vault with missing config files and restore them {#add-recover-vault} -If a vault has no configuration files and does not yet appear in the vault list, you can start the recovery manually. +If a vault has no configuration files and is yet not added to Cryptomator, you recover it during the import process. Open the main window and click the plus `+` button. In the context menu, choose `Recover Existing Vault…`. -Then select the vault directory you want to restore. -Depending on which configuration files are missing, Cryptomator will guide you through the same recovery options described in Recover Masterkey file, Recover Vault config file, or Recover Masterkey and Vault config files. +Then select the vault directory you want to recover. +Depending on which configuration files are missing, Cryptomator picks the right recovery options and will guide you through the same steps as described above. After the process completes, the restored vault will be added to your vault list automatically. \ No newline at end of file From 42432b1e1440710277735985d9fc7faea4476ba7 Mon Sep 17 00:00:00 2001 From: Armin Schrenk Date: Wed, 5 Nov 2025 12:00:22 +0100 Subject: [PATCH 8/9] Resolve grammatical issues Apply suggestion from @Copilot Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- docs/desktop/vault-recovery.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/desktop/vault-recovery.md b/docs/desktop/vault-recovery.md index 391fc60..f16e4b4 100644 --- a/docs/desktop/vault-recovery.md +++ b/docs/desktop/vault-recovery.md @@ -19,7 +19,7 @@ It helps with the following scenarios: 1. The vault config file is missing or damaged - [`Recover Vault config file`](#recover-vault-config) 1. The masterkey and the vault config files are missing or damaged - [`Recover Masterkey and Vault config files`](#recover-full) -If the damaged vault is not yet added to Cryptomator, you start the recovery during the import process, see [`Add a vault with missing config files and restore them`](#add-recover-vault). +If the damaged vault has not yet been added to Cryptomator, you start the recovery during the import process, see [`Add a vault with missing config files and restore them`](#add-recover-vault). :::warning Recovery of missing files is only supported starting with Vault Format 8 (introduced in Cryptomator 1.6.0). From 9d08b7184edb235857a7bd4f84afb3b5da96ec2d Mon Sep 17 00:00:00 2001 From: Armin Schrenk Date: Wed, 5 Nov 2025 12:00:46 +0100 Subject: [PATCH 9/9] Apply suggestion from @Copilot Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- docs/desktop/vault-recovery.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/desktop/vault-recovery.md b/docs/desktop/vault-recovery.md index f16e4b4..018cbff 100644 --- a/docs/desktop/vault-recovery.md +++ b/docs/desktop/vault-recovery.md @@ -68,7 +68,7 @@ You’ll be guided through the process and on success, you can open the vault as ## Add a vault with missing config files and restore them {#add-recover-vault} -If a vault has no configuration files and is yet not added to Cryptomator, you recover it during the import process. +If a vault has no configuration files and has not yet been added to Cryptomator, you recover it during the import process. Open the main window and click the plus `+` button. In the context menu, choose `Recover Existing Vault…`.