Skip to content

Commit c683ffc

Browse files
authored
feat(crypt) fix doc typos (#254)
* feat(crypt): update doc * feat(crypt): update doc typos
1 parent f8e5fb8 commit c683ffc

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

docs/guide/drivers/Crypt.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,15 @@ star: true
2222

2323
What is `Crypt`?
2424

25-
In simple words, it's a two-password-protected safe. No one can be open it without the key. The password and salt value in the configuration form the key.
25+
In simple words, it's a two-password-protected safe. No one can open it without the key. The password and the salt in the configuration form the key.
2626

2727
::: Tips
2828

2929
1. If you don’t know how to use this encryption/decryption driver, please read this guide carefully
30-
2. Please test it locally to understand it before use it in the production environment.
31-
3. The data loss is 100% caused by configuration change. If data has been stored within Crypt, change configuration won't re-encrypt data!
30+
2. Please test it locally to understand it fully before use in the production environment.
31+
3. The data loss is 100% caused by configuration change. If data has been stored within Crypt, change configuration won't re-encrypt data, those data will be inaccessible to Crypt!
3232

33-
==Remind again, please read the document carefully, otherwise the data will be lost!==
33+
==Remind again, please read the document carefully, otherwise the data may be lost!==
3434

3535
:::
3636

@@ -61,17 +61,17 @@ If you don’t know how to configure, you can use the simpler default configurat
6161

6262

6363

64-
:::danger Please read the precautions carefully --- very important
64+
:::danger Please read carefully --- very important
6565

66-
Once the configuration is filled and started using, do not modify it, do not modify it, do not modify it!
66+
Once the configuration is set and started using, do not modify it, do not modify it, do not modify it!
6767

68-
[**Password**](#password) [**Salt**](#salt) Keep in mind,after saving config, these two options will be encrypted and can't be reveled (the text above shows that it has not been stored)
68+
The original [**Password**](#password) and [**Salt**](#salt) should be kept in other places. These two options will be encrypted and can't be reveled after saving.
6969

7070
- **If you forget the password before uploading any file, you can modify and re-fill in the password configuration**
7171

7272
-----
7373

74-
If you have not uploaded files in the Crypt drive, you can modify the configuration, otherwise do not modify it!!!
74+
If you have not uploaded any file in the Crypt, you may modify the configuration, otherwise do not modify it!!!
7575

7676
If you have data in Crypt, and changed the configuration, `Crypt` will try to filter out illegal files/folders, but the illegal data still exist in the remote storage
7777

@@ -102,10 +102,10 @@ If you don’t understand, you can use the default configuration
102102

103103
- 1.**The default is `off` state**
104104
- Whether the file name needs to be encrypted, and the file name is encrypted after uploading
105-
105+
106106
- 2.**Standard Encryption**
107107
- Standard encryption safety level high^(recommended)^
108-
108+
109109
- 3.**Simple Obfuscate**
110110
- The security level is very low, but friendly to long file name. Note: for the Chinese file name, special characters will be generated. Some network disk storage may not support them
111111

@@ -121,7 +121,7 @@ If you don’t understand, you can use the default configuration
121121

122122
### <i class="fa-solid fa-folder-open" style="color: #409eff;"></i> **Directory name encryption**
123123

124-
default is `false`, i.e disabled. don't use it if you don't understand below description
124+
default is `false`, i.e disabled. don't use it if you don't understand below description
125125

126126
When you turn on the folder encryption, you must select a **filename encryption** type. Otherwise, the folder encryption will not take effect
127127

@@ -169,11 +169,11 @@ If the file name is encrypted, the encryption suffix `will not be used
169169

170170
Advanced usage is only applicable to those who know about **`rclone`**
171171

172-
If you know the **`rclone`** very well, you can check :point_right: [**rclone crypt document **](https://rclone.org/crypt) Currently fully compatible
172+
If you know the **`rclone`** very well, you can check :point_right: [**rclone crypt document**](https://rclone.org/crypt) Currently fully compatible
173173

174174
Note: `Alist Crypt` used `filename_encoding = base64` in default. If you want to use Rclone, please config it in the advanced config. (Reason: more friendly to long filename)
175175

176-
since Alist does not consider any case-insensitive internally, you may encounter problems when remote storage is case-insensitive. e.g.: use alist local driver on Windows, then use Crypt on it.
176+
Since Alist does not consider any case-insensitive internally, you may encounter problems when remote storage is case-insensitive. e.g.: use alist local driver on Windows, then use Crypt on it.
177177

178178

179179
<br/>

0 commit comments

Comments
 (0)