Skip to content

Commit cdf2724

Browse files
Documented "Create New Vault" Wizard
1 parent 1f915ec commit cdf2724

14 files changed

+109
-20
lines changed

README.md

+8
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,11 @@ If you want to contribute documentation in different languages, please let us kn
1111
- View the [MkDocs documentation](https://www.mkdocs.org).
1212
- Fork this repo
1313
- Send us a pull request
14+
15+
<!--
16+
How tow record `.gif`s:
17+
18+
1. Record screen using Quicktime on #FCFCFC background
19+
2. Generate palette for PNG: `ffmpeg -i recording.mov -vf "fps=10,palettegen" -y palette.png`
20+
2. Generate GIF: `ffmpeg -i recording.mov -i palette.png -lavfi "fps=10 [x]; [x][1:v] paletteuse" -y result.gif`
21+
-->

docs/desktop/adding-vaults.md

+78
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
# Adding your first vault
2+
3+
On your first use of Cryptomator, you will not yet have any vaults. Before you can encrypt files, you need to add a vault. To do so, start by clicking the `Add Vault` button.
4+
5+
![Empty vault list](../img/desktop/empty-vault-list.png)
6+
7+
If you want to create a vault yourself, choose `Create New Vault`. If you already have a vault, for example because someone shared a vault with you via a cloud storage service, you can instead choose `Open Existing Vault`.
8+
9+
![Create a new or open an existing vault](../img/desktop/create-or-open-vault.png)
10+
11+
12+
# Create a New Vault
13+
14+
If you chose to create a new vault, the wizard will now guide you through the vault creation process.
15+
16+
17+
## 1. Choose a Name
18+
19+
You start by simply choosing a name for your vault.
20+
21+
![Choosing "My first Vault" as a vault name](../img/desktop/add-vault-1.png)
22+
23+
!!! note
24+
Your vault name will be used as a directory name on your file system. Make sure not to use any characters that might cause problems with your setup. Especially if you want to share the vault via the cloud with other users, keep in mind that these users might use different software or operating systems that might not cope well with special characters.
25+
26+
27+
## 2. Choose a Storage Location
28+
29+
Next, choose where you want to save your vault. Usually this would be inside your cloud-synced directory. But you can choose any storage location, you like.
30+
31+
In this example I want to encrypt files that get synchronized via Dropbox.
32+
33+
![Choosing Dropbox as a storage location for my vault](../img/desktop/add-vault-2.png)
34+
35+
!!! note
36+
You might not see all the above options, depending on what cloud services you have installed on your PC. Cryptomator tries to detect some well-known locations. You can always choose `Custom Location` and navigate to your cloud storage directory manually.
37+
38+
39+
## 3. Choose a Passwords
40+
41+
Now it is time to choose a [good password](../../security/advice/#good-passwords) for your vault. Cryptomator requires at least 8 characters but we recommend you to use a longer phrases such as pass-sentences. The bar below the password field estimates the strength of your password.
42+
43+
![Choosing a sufficiently secure password](../img/desktop/add-vault-3.png)
44+
45+
!!! warning
46+
Nobody except for yourself knows this password and there is no way to "reset" it as you may know it from online services.
47+
48+
!!! tip
49+
If you plan to share this vault with a different person, you will both need to know the password. In this case, choose a password that is different from anything you tend to only use yourself. To share the password, use an encrypted messenger or any other secure means of communication.
50+
51+
Since we can not reset your password, we recommend you to create an additional _recovery key_.
52+
53+
54+
## 4. Show Recovery Key (optional step)
55+
56+
If you chose to create a recovery key in the previous step, it will now be displayed. Make sure not to lose it. Ideally make a hard copy of it.
57+
58+
![Showing the recovery key](../img/desktop/add-vault-4.png)
59+
60+
!!! warning
61+
Keep the recovery key secret. Remember, just like your password, its purpose is to gain access to your vault!
62+
63+
64+
## 5. Done
65+
66+
That's it. You have successfully created a new vault.
67+
68+
You can now unlock this vault using your password and start adding sensitive files to it.
69+
70+
![Showing the recovery key](../img/desktop/add-vault-5.png)
71+
72+
73+
# Open an Existing Vault
74+
75+
If you chose to open an existing vault, all you need to do is to locate the `masterkey.cryptomator` file of the vault you want to open.
76+
77+
!!! note
78+
If you created the vault on another device and cannot find it or its masterkey file, make sure that the directory containing the vault is properly synchronized and fully accessible on your device.

docs/desktop/basic-concepts.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Vaults
2+
3+
With Cryptomator you can create encrypted *vaults*. Each vault is protected by a password and can contain as many files and folders as you like.
4+
5+
You can [create](../adding-vaults/#create-a-new-vault) as many vaults as you like and use separate passwords for every vault.
6+
7+
# Virtual Drives
8+
9+
When you unlock a vault, using your password, the vault's contents will become available as a virtual drive on your PC. Just as if you were using a USB drive.
10+
11+
You can then work on this virtual drive just the same as with any hard drive. Once you're done, you can lock your vault, which will remove the virtual drive from your system.
12+
13+
!!! tip
14+
On Windows, you can choose the drive letter of the virtual drive for each vault.
15+
16+
# Synchronizing Vaults with the Cloud
17+
18+
Cryptomator is not a sync tool. You still need the software from your favourite cloud storage service. To sync a vault with the cloud, simply specify its storage location to be inside a directory that will get sync'ed with your cloud. For example, if you're using Dropbox, create a vault inside your Dropbox folder.
19+
20+
!!! warning
21+
Cryptomator can only encrypt files that you put _inside_ your vault. It will not affect any other files laying around in your cloud folder.

docs/desktop/vault-management.md

-20
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,3 @@
1-
# Create a New Vault
2-
3-
To create a new vault, click on the plus sign ① and choose _Create New Vault_ ②. You will now be prompted to select the storage location of your vault. This can be somewhere inside your Dropbox or Google Drive or anywhere on your hard disk. The storage location doesn't need to be a cloud-synced directory.
4-
5-
![How to create a new vault](../img/desktop/create-new-vault.png)
6-
7-
After choosing the storage location you will be prompted for a password ③.
8-
9-
!!! warning
10-
You have to remember this password at all times because there is **no way to access your data if you forget your password**. Choose a [good password](../../security/advice/#good-passwords) to make your data secure.
11-
12-
Finish by clicking _Create Vault_ ④, then you can [access your data](access-vault.md).
13-
14-
# Add Existing Vaults
15-
16-
It is possible to access already existing vaults by adding them to the vault list. To do this, click on the plus sign and choose `Open Vault`. Navigate to the storage location of your vault and choose the file `masterkey.cryptomator` and click on `Open`.
17-
18-
!!! note
19-
If you created the vault on another device and cannot find it or its masterkey file, make sure that the directory containing the vault is accessible and properly synchronized.
20-
211
# Remove Vaults
222

233
If you want a specific vault to stop being displayed in Cryptomator, you can select it and remove it using the minus sign or by right-clicking on it. This is only possible while the vault is locked. By removing a vault, it is only removed from the list but not deleted from your filesystem. You can re-add the vault afterwards.

docs/img/desktop/add-vault-1.png

105 KB
Loading

docs/img/desktop/add-vault-2.png

121 KB
Loading

docs/img/desktop/add-vault-3.png

125 KB
Loading

docs/img/desktop/add-vault-4.png

139 KB
Loading

docs/img/desktop/add-vault-5.png

117 KB
Loading

docs/img/desktop/create-new-vault.png

-25.9 KB
Binary file not shown.
130 KB
Loading

docs/img/desktop/empty-vault-list.png

44.3 KB
Loading

docs/img/desktop/move-vaults.gif

216 KB
Loading

mkdocs.yml

+2
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ nav:
2323
- Home: index.md
2424
- Desktop Application:
2525
- Setup: desktop/setup.md
26+
- Basic Concepts: desktop/basic-concepts.md
27+
- Adding Vaults: desktop/adding-vaults.md
2628
- Vault Management: desktop/vault-management.md
2729
- Accessing a Vault: desktop/access-vault.md
2830
- Troubleshooting: desktop/troubleshooting.md

0 commit comments

Comments
 (0)