-
Notifications
You must be signed in to change notification settings - Fork 41
Feature: Add Info about vault recovery options #98
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
infeo
wants to merge
9
commits into
develop
Choose a base branch
from
recover
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 7 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
b1027f2
add desktop vault recovery
mindmonk c707ae0
some wording changes
mindmonk 8a02438
can't instead of cannot
mindmonk 6f578d1
added intro
mindmonk 1a7fe22
added warning
mindmonk e53e90e
infeo suggested change
mindmonk 1f6367f
Update text
infeo 42432b1
Resolve grammatical issues
infeo 9d08b71
Apply suggestion from @Copilot
infeo File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| --- | ||
| id: vault-recovery | ||
| title: Vault Recovery | ||
| sidebar_position: 20 | ||
| --- | ||
|
|
||
| # Vault Recovery | ||
|
|
||
| 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` in order for Cryptomator to recognize and unlock your vault again. | ||
| ::: | ||
|
|
||
| It helps with the following scenarios: | ||
|
|
||
| 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. | ||
|
|
||
| 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`. | ||
|
|
||
| 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} | ||
|
|
||
| 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 process. | ||
|
|
||
| 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 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 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 process. | ||
|
|
||
| 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 is yet not added to Cryptomator, you recover it during the import process. | ||
infeo marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| 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 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. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.