Feature: Section about storing passwords #92
Conversation
|
""" WalkthroughA new section titled "Storing Passwords" was added to the documentation for Cryptomator's desktop application. This section explains that vault passwords are not stored on disk by default but can be optionally saved in the system keychain for convenience. It provides detailed instructions on enabling this feature, storing and removing passwords, and enumerates supported keychain options on macOS, Windows, and Linux, including their security characteristics and prerequisites. The vault unlocking instructions were refined to specify selecting a vault from the vault list and clicking the unlock button, with updated wording for the password storage option and related warnings. No changes were made to the application's exported or public entities; the update is limited to documentation. Possibly related PRs
Suggested reviewers
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
docs/desktop/password-and-recovery-key.md (4)
63-65: Add the missing comma and fix a small verb-tense omissionMinor copy-editing for flow and correctness.
-By default Cryptomator does not store your vault's password on your hard drive. -It is only used to unlock the vault and destroyed afterwards. +By default, Cryptomator does not store your vault's password on your hard drive. +It is only used to unlock the vault and is destroyed afterwards.
98-101: Clarify Touch ID sentenceThe preposition feels abrupt; adding “you can” keeps the sentence active and reader-oriented.
- Uses the built-in macOS keychain, but requires authentication with Touch ID before accessing the password. + Uses the built-in macOS keychain, but requires authentication with Touch ID before you can access the password.
120-124: Missing comma after “system”- Requires GNOME keyring to be installed and running on your Linux system with the default keyring created. + Requires GNOME Keyring to be installed and running on your Linux system, with the default keyring created.
128-132: Add comma for parallelism- Requires KDE Wallet to be installed and running on your Linux system with the default wallet created. + Requires KDE Wallet to be installed and running on your Linux system, with the default wallet created.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/desktop/password-and-recovery-key.md(1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: JaniruTEC
PR: cryptomator/docs#60
File: source/misc/supported-cloud-services.rst:1-91
Timestamp: 2024-10-09T15:53:13.453Z
Learning: In the Cryptomator documentation, CSV files used in RST files may have headers that include quotes and footnotes, and this is acceptable.
docs/desktop/password-and-recovery-key.md (1)
Learnt from: JaniruTEC
PR: cryptomator/docs#60
File: source/misc/supported-cloud-services.rst:1-91
Timestamp: 2024-10-09T15:53:13.453Z
Learning: In the Cryptomator documentation, CSV files used in RST files may have headers that include quotes and footnotes, and this is acceptable.
🪛 LanguageTool
docs/desktop/password-and-recovery-key.md
[uncategorized] ~62-~62: Did you mean: “By default,”?
Context: ... trust the keychain you are using. ::: By default Cryptomator does not store your vault's...
(BY_DEFAULT_COMMA)
[locale-violation] ~64-~64: In American English, ‘afterward’ is the preferred variant. ‘Afterwards’ is more commonly used in British English and other dialects.
Context: ... used to unlock the vault and destroyed afterwards. However, you can enable the option to...
(AFTERWARDS_US)
[uncategorized] ~98-~98: Possible missing preposition found.
Context: ...
Touch ID (macOS)
Uses the built-in macOS keychain, but requir...(AI_HYDRA_LEO_MISSING_IT)
[uncategorized] ~123-~123: Possible missing comma found.
Context: ... be installed and running on your Linux system with the default keyring created. </det...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~131-~131: Possible missing comma found.
Context: ... be installed and running on your Linux system with the default wallet created. </deta...
(AI_HYDRA_LEO_MISSING_COMMA)
|
We should mention the community plugins in your new section, as we're doing in https://docs.cryptomator.org/desktop/accessing-vaults/#unlocking-a-vault already. And then link from the article I've mentioned to your new section, so that we don't have redundant information. |
|
Crosslinked and reordered the unlock vault section a tad: |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (8)
docs/desktop/password-and-recovery-key.md (5)
57-63: Use a stronger admonition for the security warning
Storing passwords is a potential attack surface.:::warningis more appropriate than:::info, ensuring the reader doesn’t skim over the risk.-:::info +:::warning Storing passwords in a keychain can be convenient, but it also poses a security risk if your device is compromised. Ensure that your device is secure and that you trust the used keychain. -::: +:::
64-66: Consistent locale: use “afterward” (US-English) instead of “afterwards”
Your docs largely follow US spelling; switching mid-paragraph is jarring.-It is only used to unlock the vault and is destroyed afterwards. +It is only used to unlock the vault and is destroyed afterward.
70-76: Minor UI-label accuracy & typography
- The preference is labelled “Store passwords with …” (capital “P”, trailing ellipsis).
- A real ellipsis (
…) is good, but add a non-breaking space before it to avoid ugly line wraps.-2. Check the box `Store passwords with…` and select your preferred keychain +2. Check the box `Store Passwords with …` and select your preferred keychain
90-133: Reduce repetition across keychain descriptions
Every<details>block repeats the sentence “The password is only stored locally …”. Consider factoring that into a single sentence above the list to tighten the section and keep all blocks to unique platform-specific facts.
135-139: Grammar & link check in plug-in paragraph
- Remove the superfluous comma after “Cryptomator”.
- Add periods at the end of bullet sentences.
- Double-check that
https://plugin.purejava.orgis the canonical URL; the current homepage ishttps://purejava.org/cryptomator-keepassxc(redirects today).-There are also third-party plug-ins available for Cryptomator, that allow you to store Cryptomator's vault passwords in third-party password managers: +There are also third-party plug-ins for Cryptomator that allow you to store vault passwords in external password managers: -- [KeePassXC plug-in](https://plugin.purejava.org) stores Cryptomator's vault passwords in a KeePassXC database -- [Bitwarden plug-in](https://github.com/purejava/cryptomator-bitwarden/wiki) stores the vault passwords in Bitwarden's Secrets Manager +- [KeePassXC plug-in](https://plugin.purejava.org) stores Cryptomator vault passwords in a KeePassXC database. +- [Bitwarden plug-in](https://github.com/purejava/cryptomator-bitwarden/wiki) stores the passwords in Bitwarden Secrets Manager.docs/desktop/accessing-vaults.md (3)
15-19: Let Markdown handle list numbering to avoid future diff churn
Using1.for every item renders the same but keeps edits simple and blame cleaner.-1. Select the vault you wish to unlock in the vault list. -2. Click on the large `Unlock` button in the vault detail view of the Cryptomator window. -3. Enter your vault's password. -4. Click the `Unlock` button. +1. Select the vault you wish to unlock in the vault list. +1. Click the large `Unlock` button in the vault detail view. +1. Enter your vault's password. +1. Click `Unlock`.
22-26: Checkbox label mismatch
Here you reference “Remember password” (lower-case “p”), but the unlock dialog in the app shows “Remember Password”. Keep wording identical to the UI.-You can store the password in your operating system's keychain by checking the "Remember password" checkbox. +You can store the password in your operating system's keychain by checking the "Remember Password" checkbox.
32-34: Minor flow tweak for readability
Break the long sentence and drop an extra “either”.-You can either close the success window by clicking `Done` or click on `Reveal Vault` to show your unlocked vault in the file manager. +Close the success window by clicking `Done`, or click `Reveal Vault` to show the unlocked vault in your file manager.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/desktop/accessing-vaults.md(1 hunks)docs/desktop/password-and-recovery-key.md(1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: JaniruTEC
PR: cryptomator/docs#60
File: source/misc/supported-cloud-services.rst:1-91
Timestamp: 2024-10-09T15:53:13.453Z
Learning: In the Cryptomator documentation, CSV files used in RST files may have headers that include quotes and footnotes, and this is acceptable.
docs/desktop/password-and-recovery-key.md (1)
Learnt from: JaniruTEC
PR: cryptomator/docs#60
File: source/misc/supported-cloud-services.rst:1-91
Timestamp: 2024-10-09T15:53:13.453Z
Learning: In the Cryptomator documentation, CSV files used in RST files may have headers that include quotes and footnotes, and this is acceptable.
🪛 LanguageTool
docs/desktop/accessing-vaults.md
[grammar] ~15-~15: Use proper spacing conventions.
Context: ...lt you wish to unlock in the vault list. 2. Click on the large Unlock button in th...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~16-~16: Use proper spacing conventions.
Context: ...t detail view of the Cryptomator window. 3. Enter your vault's password. 4. Click th...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~17-~17: Use proper spacing conventions.
Context: ... window. 3. Enter your vault's password. 4. Click the Unlock button. <Image src="...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~18-~18: Use proper spacing conventions.
Context: ... password. 4. Click the Unlock button. 
:::note You can store the password in yo...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~23-~23: Use proper spacing conventions.
Context: ...ecking the "Remember password" checkbox. With a saved password, you can unlock yo...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~24-~24: Use proper spacing conventions.
Context: ...thout typing a password on every unlock. For more information, see the [Storing P...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~25-~25: Use proper spacing conventions.
Context: ...overy-key.md#storing-passwords) section. :::warning Only store your password in t...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~28-~28: Use proper spacing conventions.
Context: ...he system's keychain on trusted devices. Anyone with access to these devices will...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~29-~29: Use proper spacing conventions.
Context: ... in some cases, even read your password. ::: If your password is correct, a succ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~30-~30: Use proper spacing conventions.
Context: ...some cases, even read your password. ::: If your password is correct, a success m...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~32-~32: Use proper spacing conventions.
Context: ...splayed, and the vault will be unlocked. You can either close the success window ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~33-~33: Use proper spacing conventions.
Context: ...your unlocked vault in the file manager. 
## Locking a Vault {#locking-a-vault} To l...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
docs/desktop/password-and-recovery-key.md
[grammar] ~57-~57: Use proper spacing conventions.
Context: ...# Storing Passwords {#storing-passwords} :::info Storing passwords in a keychain ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~61-~61: Use proper spacing conventions.
Context: ...re and that you trust the used keychain. ::: By default, Cryptomator does not st...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~62-~62: Use proper spacing conventions.
Context: ...nd that you trust the used keychain. ::: By default, Cryptomator does not store y...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~64-~64: Use proper spacing conventions.
Context: ...our vault's password on your hard drive. It is only used to unlock the vault and ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[locale-violation] ~65-~65: In American English, ‘afterward’ is the preferred variant. ‘Afterwards’ is more commonly used in British English and other dialects.
Context: ...ed to unlock the vault and is destroyed afterwards. However, you can enable the option to...
(AFTERWARDS_US)
[grammar] ~65-~65: Use proper spacing conventions.
Context: ...k the vault and is destroyed afterwards. However, you can enable the option to st...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~67-~67: Use proper spacing conventions.
Context: ...ore the password in the system keychain. This is useful if you want to avoid ente...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~68-~68: Use proper spacing conventions.
Context: ...assword every time you unlock the vault. To enable this option: 1. Navigate to th...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~71-~71: Use proper spacing conventions.
Context: ...to the General tab in the preferences. 2. Check the box Store passwords with… an...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~72-~72: Use proper spacing conventions.
Context: ...chain, Windows Hello, or GNOME Keyring). :::note Not all keychains are supported ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~76-~76: Use proper spacing conventions.
Context: ... Hello is only available on Windows. ::: To store a password for a vault: 1. Star...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~80-~80: Use proper spacing conventions.
Context: ...Remember Password` in the unlock dialog. 3. Enter the vault's password and click on ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~81-~81: Use proper spacing conventions.
Context: ... vault's password and click on Unlock. The password will be stored in the selec...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~83-~83: Use proper spacing conventions.
Context: ...ult without entering the password again. Some keychains may require you to authen...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~84-~84: Use proper spacing conventions.
Context: ...) before storing/accessing the password. The stored password can be removed at an...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~86-~86: Use proper spacing conventions.
Context: ...and clicking on Remove saved password. Available keychains are:
Details
<s...(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~88-~88: Use proper spacing conventions.
Context: ...ved password`. Available keychains are:
macOS Keychain (macOS)
Uses the built-in macOS keychain to stor...(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~93-~93: Use proper spacing conventions.
Context: ...n macOS keychain to store your password. The password is only stored locally on...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~99-~99: There might be a mistake here.
Context: ...ary> Uses the built-in macOS keychain, but requires authentication with Touch ...
(QB_NEW_EN_OTHER)
[grammar] ~99-~99: Use proper spacing conventions.
Context: ...h ID before you can access the password. The password is only stored locally on...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~102-~102: Use proper spacing conventions.
Context: ... a compatible Mac with Touch ID enabled.
Windows Hello (Windows)
Uses the Windows Hello feature to encryp...(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~107-~107: Use proper spacing conventions.
Context: ... Hello feature to encrypt your password. The password is only stored locally on...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~110-~110: Use proper spacing conventions.
Context: ...ndows device with Windows Hello enabled.
Windows Data Protection API (Windows)
Uses the Windows Data Protection API to ...(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~115-~115: Use proper spacing conventions.
Context: ...Protection API to encrypt your password. The password is only stored locally on...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~121-~121: Use proper spacing conventions.
Context: ...he GNOME keyring to store your password. The password is only stored locally in...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~124-~124: Use proper spacing conventions.
Context: ...ystem, with the default keyring present.
KDE Wallet (Linux)
Uses the KDE Wallet to store your passwo...(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~129-~129: Use proper spacing conventions.
Context: ...s the KDE Wallet to store your password. The password is only stored locally in...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~132-~132: Use proper spacing conventions.
Context: ...system, with the default wallet present.
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~135-~135: There might be a mistake here.
Context: ...party plug-ins available for Cryptomator, that allow you to store Cryptomator's v...
(QB_NEW_EN_OTHER)
[grammar] ~135-~135: Use proper spacing conventions.
Context: ...swords in third-party password managers: - [KeePassXC plug-in](https://plugin.pureja...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~137-~137: There might be a mistake here.
Context: ...omator's vault passwords in a KeePassXC database - [Bitwarden plug-in](https://github.co...
(QB_NEW_EN_OTHER)
[grammar] ~138-~138: Place a period at the end of declarative sentences.
Context: ...passwords in Bitwarden's Secrets Manager ## Show Recovery Key {#show-recovery-key} ...
(QB_NEW_EN_OTHER_ERROR_IDS_000178)
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
docs/desktop/accessing-vaults.md (1)
23-26: Link text & anchor are great – keep casing consistentThe checkbox label here is “Remember password” (lower-case p).
Make sure the same casing is used inpassword-and-recovery-key.md(currently “Remember Password”) to avoid reader confusion.
🧹 Nitpick comments (5)
docs/desktop/password-and-recovery-key.md (3)
59-66: Remove double-space gaps flagged by LanguageToolSeveral sentences end with two spaces before the next word (“destroyed afterward. However, …”).
Markdown renders them identically, but they trip style checkers and make diffs noisy.-It is only used to unlock the vault and is destroyed afterward. -However, you can enable the option to store the password in the system keychain. +It is only used to unlock the vault and is destroyed afterward. +However, you can enable the option to store the password in the system keychain.(Repeat for the other occurrences in lines 59-86.)
Cleaning this up now avoids future CI/MD-lint warnings.
70-73: Use explicit numbering for ordered listsUsing “1.” for every item is valid Markdown, but the raw file is harder to scan and reviewers must mentally count.
Incrementing the numbers improves readability and avoids accidental re-ordering glitches in some renderers.-1. Navigate to the `General` tab in the preferences. -1. Check the box `Store passwords with …` and select your preferred keychain … +1. Navigate to the `General` tab in the preferences. +2. Check the box `Store passwords with …` and select your preferred keychain …Do the same for the list in lines 78-81.
78-83: Unify checkbox label casing with “Accessing Vaults” pageHere the text says “Remember Password” (capital “P”), while
accessing-vaults.mduses “Remember password”.
In-app strings seem to use the latter (all lower-case after the first word). Please pick one variant to stay consistent and avoid confusing screenshots/doc text mismatch.docs/desktop/accessing-vaults.md (2)
15-18: Indentation/numeration glitch in the 4-step listLine 17 (“3. Enter …”) wasn’t touched in this PR, but it’s indented by two spaces whereas the surrounding items are flush-left.
Some Markdown renderers treat this as a sub-list, breaking numbering.-3. Enter your vault's password. +3. Enter your vault's password.Remove the extra spaces so all four items align.
28-30: Minor wording tweak for clarity“Anyone with access to these devices will be able to unlock your vault, and in some cases, even read your password.”
Consider adding “stored” before “password” for emphasis:
… and in some cases, even read your stored password.
Not critical, but improves precision.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/desktop/accessing-vaults.md(1 hunks)docs/desktop/password-and-recovery-key.md(1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: JaniruTEC
PR: cryptomator/docs#60
File: source/misc/supported-cloud-services.rst:1-91
Timestamp: 2024-10-09T15:53:13.453Z
Learning: In the Cryptomator documentation, CSV files used in RST files may have headers that include quotes and footnotes, and this is acceptable.
docs/desktop/password-and-recovery-key.md (1)
Learnt from: JaniruTEC
PR: cryptomator/docs#60
File: source/misc/supported-cloud-services.rst:1-91
Timestamp: 2024-10-09T15:53:13.453Z
Learning: In the Cryptomator documentation, CSV files used in RST files may have headers that include quotes and footnotes, and this is acceptable.
🪛 LanguageTool
docs/desktop/accessing-vaults.md
[grammar] ~15-~15: Use proper spacing conventions.
Context: ...lt you wish to unlock in the vault list. 2. Click on the large Unlock button in th...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~16-~16: Use proper spacing conventions.
Context: ...t detail view of the Cryptomator window. 3. Enter your vault's password. 4. Click th...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~17-~17: Use proper spacing conventions.
Context: ... window. 3. Enter your vault's password. 4. Click the Unlock button. <Image src="...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~18-~18: Use proper spacing conventions.
Context: ... password. 4. Click the Unlock button. :::note You can store the password in yo...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~23-~23: Use proper spacing conventions.
Context: ...ecking the "Remember password" checkbox. With a saved password, you can unlock yo...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~24-~24: Use proper spacing conventions.
Context: ...thout typing a password on every unlock. For more information, see the [Storing P...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~25-~25: Use proper spacing conventions.
Context: ...overy-key.md#storing-passwords) section. :::warning Only store your password in t...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~28-~28: Use proper spacing conventions.
Context: ...he system's keychain on trusted devices. Anyone with access to these devices will...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~29-~29: Use proper spacing conventions.
Context: ... in some cases, even read your password. ::: If your password is correct, a succ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~30-~30: Use proper spacing conventions.
Context: ...some cases, even read your password. ::: If your password is correct, a success m...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~32-~32: Use proper spacing conventions.
Context: ...splayed, and the vault will be unlocked. You can close the success window by clic...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~33-~33: Use proper spacing conventions.
Context: ...the unlocked vault in your file manager. ## Locking a Vault {#locking-a-vault} To l...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
docs/desktop/password-and-recovery-key.md
[grammar] ~57-~57: Use proper spacing conventions.
Context: ...# Storing Passwords {#storing-passwords} :::info Storing passwords in a keychain ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~61-~61: Use proper spacing conventions.
Context: ...re and that you trust the used keychain. ::: By default, Cryptomator does not st...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~62-~62: Use proper spacing conventions.
Context: ...nd that you trust the used keychain. ::: By default, Cryptomator does not store y...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~64-~64: Use proper spacing conventions.
Context: ...our vault's password on your hard drive. It is only used to unlock the vault and ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[uncategorized] ~65-~65: Do not mix variants of the same word (‘afterward’ and ‘afterwards’) within a single text.
Context: ...ed to unlock the vault and is destroyed afterward. However, you can enable the option to...
(EN_WORD_COHERENCY)
[grammar] ~65-~65: Use proper spacing conventions.
Context: ...ck the vault and is destroyed afterward. However, you can enable the option to st...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~67-~67: Use proper spacing conventions.
Context: ...ore the password in the system keychain. This is useful if you want to avoid ente...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~68-~68: Use proper spacing conventions.
Context: ...assword every time you unlock the vault. To enable this option: 1. Navigate to th...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~71-~71: Use proper spacing conventions.
Context: ...to the General tab in the preferences. 1. Check the box Store passwords with … a...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~72-~72: Use proper spacing conventions.
Context: ...chain, Windows Hello, or GNOME Keyring). :::note Not all keychains are supported ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~76-~76: Use proper spacing conventions.
Context: ... Hello is only available on Windows. ::: To store a password for a vault: 1. Star...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~80-~80: Use proper spacing conventions.
Context: ...Remember Password` in the unlock dialog. 1. Enter the vault's password and click on ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~81-~81: Use proper spacing conventions.
Context: ... vault's password and click on Unlock. The password will be stored in the selec...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~83-~83: Use proper spacing conventions.
Context: ...ult without entering the password again. Some keychains may require you to authen...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~84-~84: Use proper spacing conventions.
Context: ...) before storing/accessing the password. The stored password can be removed at an...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~86-~86: Use proper spacing conventions.
Context: ...and clicking on Remove saved password. Available keychains are:
Details
<s...(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~88-~88: Use proper spacing conventions.
Context: ...ved password`. Available keychains are:
macOS Keychain (macOS)
Uses the built-in macOS keychain to stor...(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~93-~93: Use proper spacing conventions.
Context: ...n macOS keychain to store your password. The password is only stored locally on...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~99-~99: There might be a mistake here.
Context: ...ary> Uses the built-in macOS keychain, but requires authentication with Touch ...
(QB_NEW_EN_OTHER)
[grammar] ~99-~99: Use proper spacing conventions.
Context: ...h ID before you can access the password. The password is only stored locally on...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~102-~102: Use proper spacing conventions.
Context: ... a compatible Mac with Touch ID enabled.
Windows Hello (Windows)
Uses the Windows Hello feature to encryp...(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~107-~107: Use proper spacing conventions.
Context: ... Hello feature to encrypt your password. The password is only stored locally on...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~110-~110: Use proper spacing conventions.
Context: ...ndows device with Windows Hello enabled.
Windows Data Protection API (Windows)
Uses the Windows Data Protection API to ...(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~115-~115: Use proper spacing conventions.
Context: ...Protection API to encrypt your password. The password is only stored locally on...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~121-~121: Use proper spacing conventions.
Context: ...he GNOME keyring to store your password. The password is only stored locally in...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~124-~124: Use proper spacing conventions.
Context: ...ystem, with the default keyring present.
KDE Wallet (Linux)
Uses the KDE Wallet to store your passwo...(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~129-~129: Use proper spacing conventions.
Context: ...s the KDE Wallet to store your password. The password is only stored locally in...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~132-~132: Use proper spacing conventions.
Context: ...system, with the default wallet present.
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~135-~135: Use proper spacing conventions.
Context: ...passwords in external password managers: - [KeePassXC plug-in](https://plugin.pureja...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~137-~137: Use proper spacing conventions.
Context: ...vault passwords in a KeePassXC database. - [Bitwarden plug-in](https://github.com/pu...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~138-~138: Use proper spacing conventions.
Context: ...asswords in Bitwarden's Secrets Manager. ## Show Recovery Key {#show-recovery-key} ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
🔇 Additional comments (1)
docs/desktop/password-and-recovery-key.md (1)
135-139: Verify third-party plug-in links & wording
https://plugin.purejava.orgcurrently redirects and may not clearly describe the KeePassXC plug-in.- “Bitwarden's Secrets Manager” could mislead users who expect the standard vault rather than Secrets Manager (a paid tier).
Please double-check the URLs and consider rephrasing to match the plug-ins’ actual names.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (6)
docs/desktop/password-and-recovery-key.md (4)
60-62: Re-phrase slightly for clarity and style“Ensure that your device is secure and that you trust the used keychain.” reads a bit awkward.
Consider:-Ensure that your device is secure and that you trust the used keychain. +Ensure that your device is secure and that you trust the keychain you choose.
64-66: Consistency: “afterward” vs. “afterwards”Elsewhere in the docs the British variant “afterwards” is used. Staying consistent avoids LanguageTool warnings.
-It is only used to unlock the vault and is destroyed afterward. +It is only used to unlock the vault and is destroyed afterwards.
69-75: Minor list / admonition spacingMarkdown parsers differ on whether a blank line is required between a list and the following admonition.
Insert an extra blank line after the last list item to be safe with Docusaurus:1. Check the box `Store passwords with …` and select your preferred keychain (e.g., macOS Keychain, Windows Hello, or GNOME Keyring). + :::note
134-134: Remove stray leading spaceThere is an unintended leading space at the beginning of the paragraph.
- There are also third-party plug-ins for Cryptomator that allow you to store vault passwords in external password managers: +There are also third-party plug-ins for Cryptomator that allow you to store vault passwords in external password managers:docs/desktop/accessing-vaults.md (2)
15-18: Differentiate the two “Unlock” clicksStep 2 and Step 4 both instruct the user to click an Unlock button.
Clarifying that the second click happens in the dialog avoids confusion:-4. Click the `Unlock` button. +4. Click `Unlock` in the dialog.
22-26: Optional: shorten first sentence“You can store the password … by checking the ‘Remember password’ checkbox.” → the two occurrences of password in the same clause feel repetitive.
-You can store the password in your operating system's keychain by checking the "Remember password" checkbox. +Store it in your operating system’s keychain by checking the “Remember password” box.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/desktop/accessing-vaults.md(1 hunks)docs/desktop/password-and-recovery-key.md(1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: JaniruTEC
PR: cryptomator/docs#60
File: source/misc/supported-cloud-services.rst:1-91
Timestamp: 2024-10-09T15:53:13.453Z
Learning: In the Cryptomator documentation, CSV files used in RST files may have headers that include quotes and footnotes, and this is acceptable.
docs/desktop/password-and-recovery-key.md (1)
Learnt from: JaniruTEC
PR: cryptomator/docs#60
File: source/misc/supported-cloud-services.rst:1-91
Timestamp: 2024-10-09T15:53:13.453Z
Learning: In the Cryptomator documentation, CSV files used in RST files may have headers that include quotes and footnotes, and this is acceptable.
🪛 LanguageTool
docs/desktop/accessing-vaults.md
[grammar] ~15-~15: Use proper spacing conventions.
Context: ...lt you wish to unlock in the vault list. 2. Click on the large Unlock button in th...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~16-~16: Use proper spacing conventions.
Context: ...t detail view of the Cryptomator window. 3. Enter your vault's password. 4. Click th...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~17-~17: Use proper spacing conventions.
Context: ... window. 3. Enter your vault's password. 4. Click the Unlock button. <Image src="...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~18-~18: Use proper spacing conventions.
Context: ... password. 4. Click the Unlock button. :::note You can store the password in yo...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~23-~23: Use proper spacing conventions.
Context: ...ecking the "Remember password" checkbox. With a saved password, you can unlock yo...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~24-~24: Use proper spacing conventions.
Context: ...thout typing a password on every unlock. For more information, see the [Storing P...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~25-~25: Use proper spacing conventions.
Context: ...overy-key.md#storing-passwords) section. :::warning Only store your password in t...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~28-~28: Use proper spacing conventions.
Context: ...he system's keychain on trusted devices. Anyone with access to these devices will...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~29-~29: Use proper spacing conventions.
Context: ...e cases, even read your stored password. ::: If your password is correct, a succ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~30-~30: Use proper spacing conventions.
Context: ...ses, even read your stored password. ::: If your password is correct, a success m...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~32-~32: Use proper spacing conventions.
Context: ...splayed, and the vault will be unlocked. You can close the success window by clic...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~33-~33: Use proper spacing conventions.
Context: ...the unlocked vault in your file manager. ## Locking a Vault {#locking-a-vault} To l...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
docs/desktop/password-and-recovery-key.md
[grammar] ~57-~57: Use proper spacing conventions.
Context: ...# Storing Passwords {#storing-passwords} :::info Storing passwords in a keychain ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~61-~61: Use proper spacing conventions.
Context: ...re and that you trust the used keychain. ::: By default, Cryptomator does not st...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~62-~62: Use proper spacing conventions.
Context: ...nd that you trust the used keychain. ::: By default, Cryptomator does not store y...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~64-~64: Use proper spacing conventions.
Context: ...our vault's password on your hard drive. It is only used to unlock the vault and ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[uncategorized] ~65-~65: Do not mix variants of the same word (‘afterward’ and ‘afterwards’) within a single text.
Context: ...ed to unlock the vault and is destroyed afterward. However, you can enable the option to ...
(EN_WORD_COHERENCY)
[grammar] ~65-~65: Use proper spacing conventions.
Context: ...ck the vault and is destroyed afterward. However, you can enable the option to st...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~66-~66: Use proper spacing conventions.
Context: ...ore the password in the system keychain. This is useful if you want to avoid ente...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~67-~67: Use proper spacing conventions.
Context: ...assword every time you unlock the vault. To enable this option: 1. Navigate to th...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~70-~70: Use proper spacing conventions.
Context: ...to the General tab in the preferences. 1. Check the box Store passwords with … a...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~71-~71: Use proper spacing conventions.
Context: ...chain, Windows Hello, or GNOME Keyring). :::note Not all keychains are supported ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~75-~75: Use proper spacing conventions.
Context: ... Hello is only available on Windows. ::: To store a password for a vault: 1. Star...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~79-~79: Use proper spacing conventions.
Context: ...Remember password` in the unlock dialog. 1. Enter the vault's password and click on ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~80-~80: Use proper spacing conventions.
Context: ... vault's password and click on Unlock. The password will be stored in the selec...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~82-~82: Use proper spacing conventions.
Context: ...ult without entering the password again. Some keychains may require you to authen...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~83-~83: Use proper spacing conventions.
Context: ...) before storing/accessing the password. The stored password can be removed at an...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~85-~85: Use proper spacing conventions.
Context: ...and clicking on Remove saved password. Available keychains are:
Details
<s...(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~87-~87: Use proper spacing conventions.
Context: ...ved password`. Available keychains are:
macOS Keychain (macOS)
Uses the built-in macOS keychain to stor...(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~92-~92: Use proper spacing conventions.
Context: ...n macOS keychain to store your password. The password is only stored locally on...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~98-~98: There might be a mistake here.
Context: ...ary> Uses the built-in macOS keychain, but requires authentication with Touch ...
(QB_NEW_EN_OTHER)
[grammar] ~98-~98: Use proper spacing conventions.
Context: ...h ID before you can access the password. The password is only stored locally on...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~101-~101: Use proper spacing conventions.
Context: ... a compatible Mac with Touch ID enabled.
Windows Hello (Windows)
Uses the Windows Hello feature to encryp...(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~106-~106: Use proper spacing conventions.
Context: ... Hello feature to encrypt your password. The password is only stored locally on...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~109-~109: Use proper spacing conventions.
Context: ...ndows device with Windows Hello enabled.
Windows Data Protection API (Windows)
Uses the Windows Data Protection API to ...(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~114-~114: Use proper spacing conventions.
Context: ...Protection API to encrypt your password. The password is only stored locally on...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~120-~120: Use proper spacing conventions.
Context: ...he GNOME keyring to store your password. The password is only stored locally in...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~123-~123: Use proper spacing conventions.
Context: ...ystem, with the default keyring present.
KDE Wallet (Linux)
Uses the KDE Wallet to store your passwo...(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~128-~128: Use proper spacing conventions.
Context: ...s the KDE Wallet to store your password. The password is only stored locally in...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~131-~131: Use proper spacing conventions.
Context: ...system, with the default wallet present.
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~134-~134: Use proper spacing conventions.
Context: ...passwords in external password managers: - [KeePassXC plug-in](https://plugin.pureja...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~136-~136: Use proper spacing conventions.
Context: ...vault passwords in a KeePassXC database. - [Bitwarden plug-in](https://github.com/pu...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
[grammar] ~137-~137: Use proper spacing conventions.
Context: ...asswords in Bitwarden's Secrets Manager. ## Show Recovery Key {#show-recovery-key} ...
(QB_NEW_EN_OTHER_ERROR_IDS_000007)
2 participants
This PR adds a section about storing passwords with Cryptomator.
It describes.