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

PD-1654 / 24.04 / Pd 1654 document cloud sync filename encryption known issue 24.04 #3344

Open
wants to merge 7 commits into
base: 24.04
Choose a base branch
from

Conversation

DjP-iX
Copy link
Contributor

@DjP-iX DjP-iX commented Dec 6, 2024

Thanks for contributing to TrueNAS documentation! By opening a Pull Request, you're acknowledging that your changes will be distributed under the Creative Commons 4.0 license.

@DjP-iX DjP-iX requested a review from a team as a code owner December 6, 2024 21:31
@bugclerk bugclerk changed the title Pd 1654 document cloud sync filename encryption known issue 24.04 PD-1654 / 24.04 / Pd 1654 document cloud sync filename encryption known issue 24.04 Dec 6, 2024
@bugclerk
Copy link
Contributor

bugclerk commented Dec 6, 2024

@linzi-ix linzi-ix added the Technical Writer Review (LM) A technical writer is reviewing the PR. label Dec 12, 2024
@@ -170,9 +170,11 @@ The **Advanced Remote Options** settings are for advanced users to configure rem
| Settings | Description |
|----------|-------------|
| **Remote Encryption** | Select to use [rclone crypt](https://rclone.org/crypt/) encryption during pull and push transfers. Selecting **PUSH** in **Direction** encrypts files before transfer and stores the encrypted files on the remote system. Files are encrypted using the encryption password and encryption salt values. Selecting **PULL** decrypts files stored on the remote system before the transfer. Transferring the encrypted files requires entering the same encryption password and encryption salt used to encrypt the files. Additional details about the encryption algorithm and key derivation are available in the [rclone crypt File formats documentation](https://rclone.org/crypt/#file-formats). |
| **Filename Encryption** | Selected by default. When selected, the pull and push tranfers encrypt or decrypt file names with the rclone [Standard file name encryption mode](https://rclone.org/crypt//#file-name-encryption-modes). The original directory structure of the files is preserved. <br>When enabled, file names are encrypted, file names are limited to 143 characters, directory structure is visible, and files with identical names have identical uploaded names. File names can use sub-paths, single copy files, and shortcuts to shorten the directory recursion. <br>When disabled, encryption does not hide file names or directory structure, file names can be 246 characters long, use sub-paths, and copy single files. |
| **Filename Encryption** | **Not recommended** (see below). When selected, transfers encrypt and decrypt file names with the rclone [Standard file name encryption mode](https://rclone.org/crypt//#file-name-encryption-modes). The original directory structure of the files is preserved. <br>When enabled, file names are encrypted, file names are limited to 143 characters, directory structure is visible, and files with identical names have identical uploaded names. File names can use sub-paths, single copy files, and shortcuts to shorten the directory recursion. <br>When disabled, encryption does not hide file names or directory structure, file names can be 246 characters long, use sub-paths, and copy single files. |
Copy link
Contributor

Choose a reason for hiding this comment

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

"files with identical names have identical uploaded names" could use a few word-swaps if possible, as this reads very strangely.

Copy link
Contributor

@linzi-ix linzi-ix left a comment

Choose a reason for hiding this comment

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

one minor comment

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Technical Writer Review (LM) A technical writer is reviewing the PR.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants