Skip to content

Commit 9f0ce27

Browse files
authored
Update Screenshots and Add Documentation for Expert Settings (#61)
1 parent 9092abc commit 9f0ce27

24 files changed

+47
-21
lines changed

source/desktop/accessing-vaults.rst

-3
Original file line numberDiff line numberDiff line change
@@ -70,9 +70,6 @@ Locking a vault
7070

7171
To lock a vault, simply click ``Lock`` and the virtual drive will disappear or render empty. Your files remain encrypted at the vault's location.
7272

73-
.. image:: ../img/desktop/vault-detail-locked.png
74-
:alt: Cryptomator window showing an locked vault
75-
7673
Locate Encrypted File
7774
---------------------
7875

source/desktop/adding-vaults.rst

+45-16
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ You will be presented with two options when adding a vault:
99
.. image:: ../img/desktop/create-or-open-vault.png
1010
:alt: Create a new or open an existing vault
1111

12-
.. |CreateVault| replace:: ``New Vault...``
13-
.. _CreateVault: ./adding-vaults.html#create-a-new-vault
12+
.. |CreateVault| replace:: ``Create New Vault...``
13+
.. _CreateVault: #create-a-new-vault
1414

15-
.. |OpenVault| replace:: ``Existing Vault...``
16-
.. _OpenVault: ./adding-vaults.html#open-an-existing-vault
15+
.. |OpenVault| replace:: ``Open Existing Vault...``
16+
.. _OpenVault: #open-an-existing-vault
1717

1818

1919
.. _desktop/adding-vaults/create-a-new-vault:
@@ -23,8 +23,7 @@ You will be presented with two options when adding a vault:
2323
Create a New Vault
2424
------------------
2525

26-
If you chose to create a new vault, the wizard will guide you through a simple 5-step vault creation process.
27-
26+
If you chose to create a new vault, the wizard will guide you through a simple 6-step vault creation process.
2827

2928
.. _desktop/adding-vaults/1.-choose-a-name:
3029

@@ -36,7 +35,6 @@ Start by choosing a name for your vault.
3635
.. image:: ../img/desktop/add-vault-1.png
3736
:alt: Choosing "My first Vault" as a vault name
3837

39-
4038
.. _desktop/adding-vaults/2.-choose-a-storage-location:
4139

4240
2. Choose a Storage Location
@@ -59,10 +57,41 @@ You need to install the sync software of your cloud storage provider to sync you
5957
.. image:: ../img/desktop/add-vault-2.png
6058
:alt: Choosing Dropbox as a storage location for my vault
6159

60+
.. _desktop/adding-vaults/3.-expert-settings:
61+
62+
3. Expert Settings
63+
^^^^^^^^^^^^^^^^^^^^^
64+
65+
The **Expert Settings** screen provides advanced configuration options for your vault. These settings are intended for users who require greater control over how their data is encrypted and stored.
66+
67+
.. note::
68+
69+
Expert Settings are optional and should only be adjusted if you understand their implications.
70+
71+
**Enable Expert Settings**
72+
73+
To access expert settings, toggle the **Enable Expert Settings** switch. Once enabled, additional configuration options will be available.
74+
75+
**Maximum Length of Encrypted File Names**
76+
77+
One of the primary expert settings allows you to configure the maximum length of encrypted file names. This setting controls the degree of *name shortening* applied to file names during encryption, which is critical for compatibility with filesystems that have strict length limits.
78+
79+
- **Default Behavior**: Cryptomator automatically shortens file names to comply with filesystem constraints.
80+
- **Custom Configuration**: If specific requirements must be met, you can manually set the maximum allowed length for encrypted file names.
6281

63-
.. _desktop/adding-vaults/3.-choose-a-passwords:
82+
Refer to :ref:`Name Shortening <security/vault/name-shortening>` for additional details.
6483

65-
3. Choose a Password
84+
.. image:: ../img/desktop/add-vault-3.png
85+
:alt: Expert settings
86+
87+
.. warning::
88+
89+
Adjusting the maximum length of encrypted file names may affect compatibility with certain filesystems. Ensure you thoroughly test these settings before enabling them for critical data.
90+
91+
92+
.. _desktop/adding-vaults/4.-choose-a-password:
93+
94+
4. Choose a Password
6695
^^^^^^^^^^^^^^^^^^^^^
6796

6897
Now it is time to choose a :ref:`strong password <security/best-practices/good-passwords>` for your vault.
@@ -75,7 +104,7 @@ The bar below the password field will help you estimate the strength of your pas
75104
This is especially important if you plan to share a vault with someone.
76105
Additionally, we recommend sharing passwords only over a secure channel, like PGP encypted emails, or end-to-end encrypted chat apps.
77106

78-
.. image:: ../img/desktop/add-vault-3.png
107+
.. image:: ../img/desktop/add-vault-4.png
79108
:alt: Choose a strong password for your Cryptomator vault
80109

81110
.. warning::
@@ -87,17 +116,17 @@ The bar below the password field will help you estimate the strength of your pas
87116
However, you can reset a vault's password by yourself if you have its *recovery key*.
88117

89118

90-
.. _desktop/adding-vaults/4.-show-recovery-key-(optional-step):
119+
.. _desktop/adding-vaults/5.-show-recovery-key-(optional-step):
91120

92-
4. Show Recovery Key (optional step)
121+
5. Show Recovery Key (optional step)
93122
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
94123

95124
A recovery key allows you to reset your password if you ever forget it.
96125

97126
If you chose to create a recovery key in the previous step, it will now be displayed.
98127
Make sure not to lose it and ideally make a hard copy of it.
99128

100-
.. image:: ../img/desktop/add-vault-4.png
129+
.. image:: ../img/desktop/add-vault-5.png
101130
:alt: Showing the recovery key
102131

103132
.. warning::
@@ -107,17 +136,17 @@ Make sure not to lose it and ideally make a hard copy of it.
107136

108137
For more details, take a look at :ref:`how a recovery key works <desktop/password-and-recovery-key/reset-password>`.
109138

110-
.. _desktop/adding-vaults/5.-done:
139+
.. _desktop/adding-vaults/6.-done:
111140

112-
5. Done
141+
6. Done
113142
^^^^^^^
114143

115144
That's it.
116145
You have successfully created a new vault.
117146

118147
You can now unlock this vault using your password and start adding files into it.
119148

120-
.. image:: ../img/desktop/add-vault-5.png
149+
.. image:: ../img/desktop/add-vault-6.png
121150
:alt: Showing the recovery key
122151

123152

source/desktop/getting-started.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ You can create new vaults (or add existing ones) using the |AddVault|_ button lo
99
.. image:: ../img/desktop/empty-vault-list.png
1010
:alt: Empty vault list
1111

12-
.. |AddVault| replace:: ``Add``
12+
.. |AddVault| replace:: ``+``
1313
.. _AddVault: ./adding-vaults.html
1414

1515
.. _desktop/getting-started/tutorial-video:

source/desktop/password-and-recovery-key.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ If the recovery key is valid, a small message will be displayed below the entere
107107
By design, *only* the correct recovery key is accepted. **A valid but incorrect key won't be accepted to prevent your old data from becoming inaccessible.**
108108

109109
Finally, assign a new password to your vault.
110-
It is the same process as the :ref:`vault creation <desktop/adding-vaults/3.-choose-a-passwords>`, except that no new recovery key is generated.
110+
It is the same process as the :ref:`vault creation <desktop/adding-vaults/4.-choose-a-password>`, except that no new recovery key is generated.
111111
Again, please choose a :ref:`strong password <security/best-practices/good-passwords>`.
112112

113113
Once changed, you can unlock your vault with the new password.

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

205 KB
Loading

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

18.1 KB
Loading

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

-147 KB
Loading

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

12.3 KB
Loading

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

96.8 KB
Loading

source/img/desktop/add-vault-6.png

471 KB
Loading
228 KB
Loading
152 KB
Loading
234 KB
Loading
Loading
Loading
Loading

source/img/desktop/recoverykey.png

234 KB
Loading

source/img/desktop/unlock-prompt.png

140 KB
Loading

source/img/desktop/unlock-success.png

161 KB
Loading
318 KB
Loading
333 KB
Loading
206 KB
Loading
203 KB
Loading
193 KB
Loading

0 commit comments

Comments
 (0)