Skip to content
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

Update Screenshots and Add Documentation for Expert Settings #61

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions source/desktop/accessing-vaults.rst
Original file line number Diff line number Diff line change
Expand Up @@ -70,9 +70,6 @@ Locking a vault

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.

.. image:: ../img/desktop/vault-detail-locked.png
:alt: Cryptomator window showing an locked vault

Locate Encrypted File
---------------------

Expand Down
61 changes: 45 additions & 16 deletions source/desktop/adding-vaults.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ You will be presented with two options when adding a vault:
.. image:: ../img/desktop/create-or-open-vault.png
:alt: Create a new or open an existing vault

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

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


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

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

If you chose to create a new vault, the wizard will guide you through a simple 6-step vault creation process.
mindmonk marked this conversation as resolved.
Show resolved Hide resolved

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

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


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

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

.. _desktop/adding-vaults/3.-expert-settings:

3. Expert Settings
^^^^^^^^^^^^^^^^^^^^^

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.

.. note::

Expert Settings are optional and should only be adjusted if you understand their implications.

**Enable Expert Settings**

To access expert settings, toggle the **Enable Expert Settings** switch. Once enabled, additional configuration options will be available.

**Maximum Length of Encrypted File Names**

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.

- **Default Behavior**: Cryptomator automatically shortens file names to comply with filesystem constraints.
- **Custom Configuration**: If specific requirements must be met, you can manually set the maximum allowed length for encrypted file names.

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

3. Choose a Password
.. image:: ../img/desktop/add-vault-3.png
:alt: Expert settings
Comment on lines +84 to +85
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codebase verification

Image paths need to be updated to match the actual location

The referenced images exist but with incorrect paths. The current paths use ../img/desktop/ but should be img/desktop/ since they are relative to the source directory.

  • Update line 85: .. image:: img/desktop/add-vault-3.png
  • Update line 108: .. image:: img/desktop/add-vault-4.png
  • Update line 130: .. image:: img/desktop/add-vault-5.png
  • Update line 150: .. image:: img/desktop/add-vault-6.png
🔗 Analysis chain

Verify all referenced images exist.

The image references and alt text look good, but let's verify that all the new images exist in the repository.

Also applies to: 108-108, 130-130, 150-150


Let me try another verification approach to check if the images exist in a different location, since the relative paths might be incorrect.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check if all referenced images exist in the repository

# List of images to check
images=(
  "../img/desktop/add-vault-3.png"
  "../img/desktop/add-vault-4.png"
  "../img/desktop/add-vault-5.png"
  "../img/desktop/add-vault-6.png"
)

# Check each image from the repository root
for img in "${images[@]}"; do
  if [ -f "source/$img" ]; then
    echo "✓ Found: $img"
  else
    echo "✗ Missing: $img"
  fi
done

Length of output: 830


Script:

#!/bin/bash
# Search for the image files anywhere in the repository
fd "add-vault-[3-6].png" --type f

Length of output: 175


.. warning::

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.


.. _desktop/adding-vaults/4.-choose-a-password:

4. Choose a Password
^^^^^^^^^^^^^^^^^^^^^

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

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

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


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

4. Show Recovery Key (optional step)
5. Show Recovery Key (optional step)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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

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

.. image:: ../img/desktop/add-vault-4.png
.. image:: ../img/desktop/add-vault-5.png
:alt: Showing the recovery key

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

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

.. _desktop/adding-vaults/5.-done:
.. _desktop/adding-vaults/6.-done:

5. Done
6. Done
^^^^^^^

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

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

.. image:: ../img/desktop/add-vault-5.png
.. image:: ../img/desktop/add-vault-6.png
:alt: Showing the recovery key


Expand Down
2 changes: 1 addition & 1 deletion source/desktop/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ You can create new vaults (or add existing ones) using the |AddVault|_ button lo
.. image:: ../img/desktop/empty-vault-list.png
:alt: Empty vault list

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

.. _desktop/getting-started/tutorial-video:
Expand Down
2 changes: 1 addition & 1 deletion source/desktop/password-and-recovery-key.rst
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ If the recovery key is valid, a small message will be displayed below the entere
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.**

Finally, assign a new password to your vault.
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.
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.
Again, please choose a :ref:`strong password <security/best-practices/good-passwords>`.

Once changed, you can unlock your vault with the new password.
Expand Down
Binary file modified source/img/desktop/add-vault-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/img/desktop/add-vault-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/img/desktop/add-vault-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/img/desktop/add-vault-4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/img/desktop/add-vault-5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/img/desktop/add-vault-6.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/img/desktop/change-password-prompt.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/img/desktop/create-or-open-vault.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/img/desktop/empty-vault-list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/img/desktop/preferences-virtual-drive.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/img/desktop/recoverykey-recover-enter.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/img/desktop/recoverykey-recover-valid.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/img/desktop/recoverykey.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/img/desktop/unlock-prompt.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/img/desktop/unlock-success.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/img/desktop/vault-detail-locked.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/img/desktop/vault-detail-unlocked.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/img/desktop/vault-options-general.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/img/desktop/vault-options-mounting.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/img/desktop/vault-options-password.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.