github.com/10XDev/rclone@v1.52.3-0.20200626220027-16af9ab76b2a/docs/content/mailru.md (about) 1 --- 2 title: "Mailru" 3 description: "Mail.ru Cloud" 4 --- 5 6 {{< icon "fas fa-at" >}} Mail.ru Cloud 7 ---------------------------------------- 8 9 [Mail.ru Cloud](https://cloud.mail.ru/) is a cloud storage provided by a Russian internet company [Mail.Ru Group](https://mail.ru). The official desktop client is [Disk-O:](https://disk-o.cloud/), available only on Windows. (Please note that official sites are in Russian) 10 11 Currently it is recommended to disable 2FA on Mail.ru accounts intended for rclone until it gets eventually implemented. 12 13 ### Features highlights ### 14 15 - Paths may be as deep as required, eg `remote:directory/subdirectory` 16 - Files have a `last modified time` property, directories don't 17 - Deleted files are by default moved to the trash 18 - Files and directories can be shared via public links 19 - Partial uploads or streaming are not supported, file size must be known before upload 20 - Maximum file size is limited to 2G for a free account, unlimited for paid accounts 21 - Storage keeps hash for all files and performs transparent deduplication, 22 the hash algorithm is a modified SHA1 23 - If a particular file is already present in storage, one can quickly submit file hash 24 instead of long file upload (this optimization is supported by rclone) 25 26 ### Configuration ### 27 28 Here is an example of making a mailru configuration. First create a Mail.ru Cloud 29 account and choose a tariff, then run 30 31 rclone config 32 33 This will guide you through an interactive setup process: 34 35 ``` 36 No remotes found - make a new one 37 n) New remote 38 s) Set configuration password 39 q) Quit config 40 n/s/q> n 41 name> remote 42 Type of storage to configure. 43 Type of storage to configure. 44 Enter a string value. Press Enter for the default (""). 45 Choose a number from below, or type in your own value 46 [snip] 47 XX / Mail.ru Cloud 48 \ "mailru" 49 [snip] 50 Storage> mailru 51 User name (usually email) 52 Enter a string value. Press Enter for the default (""). 53 user> username@mail.ru 54 Password 55 y) Yes type in my own password 56 g) Generate random password 57 y/g> y 58 Enter the password: 59 password: 60 Confirm the password: 61 password: 62 Skip full upload if there is another file with same data hash. 63 This feature is called "speedup" or "put by hash". It is especially efficient 64 in case of generally available files like popular books, video or audio clips 65 [snip] 66 Enter a boolean value (true or false). Press Enter for the default ("true"). 67 Choose a number from below, or type in your own value 68 1 / Enable 69 \ "true" 70 2 / Disable 71 \ "false" 72 speedup_enable> 1 73 Edit advanced config? (y/n) 74 y) Yes 75 n) No 76 y/n> n 77 Remote config 78 -------------------- 79 [remote] 80 type = mailru 81 user = username@mail.ru 82 pass = *** ENCRYPTED *** 83 speedup_enable = true 84 -------------------- 85 y) Yes this is OK 86 e) Edit this remote 87 d) Delete this remote 88 y/e/d> y 89 ``` 90 91 Configuration of this backend does not require a local web browser. 92 You can use the configured backend as shown below: 93 94 See top level directories 95 96 rclone lsd remote: 97 98 Make a new directory 99 100 rclone mkdir remote:directory 101 102 List the contents of a directory 103 104 rclone ls remote:directory 105 106 Sync `/home/local/directory` to the remote path, deleting any 107 excess files in the path. 108 109 rclone sync /home/local/directory remote:directory 110 111 ### Modified time ### 112 113 Files support a modification time attribute with up to 1 second precision. 114 Directories do not have a modification time, which is shown as "Jan 1 1970". 115 116 ### Hash checksums ### 117 118 Hash sums use a custom Mail.ru algorithm based on SHA1. 119 If file size is less than or equal to the SHA1 block size (20 bytes), 120 its hash is simply its data right-padded with zero bytes. 121 Hash sum of a larger file is computed as a SHA1 sum of the file data 122 bytes concatenated with a decimal representation of the data length. 123 124 ### Emptying Trash ### 125 126 Removing a file or directory actually moves it to the trash, which is not 127 visible to rclone but can be seen in a web browser. The trashed file 128 still occupies part of total quota. If you wish to empty your trash 129 and free some quota, you can use the `rclone cleanup remote:` command, 130 which will permanently delete all your trashed files. 131 This command does not take any path arguments. 132 133 ### Quota information ### 134 135 To view your current quota you can use the `rclone about remote:` 136 command which will display your usage limit (quota) and the current usage. 137 138 #### Restricted filename characters 139 140 In addition to the [default restricted characters set](/overview/#restricted-characters) 141 the following characters are also replaced: 142 143 | Character | Value | Replacement | 144 | --------- |:-----:|:-----------:| 145 | " | 0x22 | ＂ | 146 | * | 0x2A | ＊ | 147 | : | 0x3A | ： | 148 | < | 0x3C | ＜ | 149 | > | 0x3E | ＞ | 150 | ? | 0x3F | ？ | 151 | \ | 0x5C | ＼ | 152 | \| | 0x7C | ｜ | 153 154 Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8), 155 as they can't be used in JSON strings. 156 157 ### Limitations ### 158 159 File size limits depend on your account. A single file size is limited by 2G 160 for a free account and unlimited for paid tariffs. Please refer to the Mail.ru 161 site for the total uploaded size limits. 162 163 Note that Mailru is case insensitive so you can't have a file called 164 "Hello.doc" and one called "hello.doc". 165 166 {{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/mailru/mailru.go then run make backenddocs" >}} 167 ### Standard Options 168 169 Here are the standard options specific to mailru (Mail.ru Cloud). 170 171 #### --mailru-user 172 173 User name (usually email) 174 175 - Config: user 176 - Env Var: RCLONE_MAILRU_USER 177 - Type: string 178 - Default: "" 179 180 #### --mailru-pass 181 182 Password 183 184 **NB** Input to this must be obscured - see [rclone obscure](/commands/rclone_obscure/). 185 186 - Config: pass 187 - Env Var: RCLONE_MAILRU_PASS 188 - Type: string 189 - Default: "" 190 191 #### --mailru-speedup-enable 192 193 Skip full upload if there is another file with same data hash. 194 This feature is called "speedup" or "put by hash". It is especially efficient 195 in case of generally available files like popular books, video or audio clips, 196 because files are searched by hash in all accounts of all mailru users. 197 Please note that rclone may need local memory and disk space to calculate 198 content hash in advance and decide whether full upload is required. 199 Also, if rclone does not know file size in advance (e.g. in case of 200 streaming or partial uploads), it will not even try this optimization. 201 202 - Config: speedup_enable 203 - Env Var: RCLONE_MAILRU_SPEEDUP_ENABLE 204 - Type: bool 205 - Default: true 206 - Examples: 207 - "true" 208 - Enable 209 - "false" 210 - Disable 211 212 ### Advanced Options 213 214 Here are the advanced options specific to mailru (Mail.ru Cloud). 215 216 #### --mailru-speedup-file-patterns 217 218 Comma separated list of file name patterns eligible for speedup (put by hash). 219 Patterns are case insensitive and can contain '*' or '?' meta characters. 220 221 - Config: speedup_file_patterns 222 - Env Var: RCLONE_MAILRU_SPEEDUP_FILE_PATTERNS 223 - Type: string 224 - Default: "*.mkv,*.avi,*.mp4,*.mp3,*.zip,*.gz,*.rar,*.pdf" 225 - Examples: 226 - "" 227 - Empty list completely disables speedup (put by hash). 228 - "*" 229 - All files will be attempted for speedup. 230 - "*.mkv,*.avi,*.mp4,*.mp3" 231 - Only common audio/video files will be tried for put by hash. 232 - "*.zip,*.gz,*.rar,*.pdf" 233 - Only common archives or PDF books will be tried for speedup. 234 235 #### --mailru-speedup-max-disk 236 237 This option allows you to disable speedup (put by hash) for large files 238 (because preliminary hashing can exhaust you RAM or disk space) 239 240 - Config: speedup_max_disk 241 - Env Var: RCLONE_MAILRU_SPEEDUP_MAX_DISK 242 - Type: SizeSuffix 243 - Default: 3G 244 - Examples: 245 - "0" 246 - Completely disable speedup (put by hash). 247 - "1G" 248 - Files larger than 1Gb will be uploaded directly. 249 - "3G" 250 - Choose this option if you have less than 3Gb free on local disk. 251 252 #### --mailru-speedup-max-memory 253 254 Files larger than the size given below will always be hashed on disk. 255 256 - Config: speedup_max_memory 257 - Env Var: RCLONE_MAILRU_SPEEDUP_MAX_MEMORY 258 - Type: SizeSuffix 259 - Default: 32M 260 - Examples: 261 - "0" 262 - Preliminary hashing will always be done in a temporary disk location. 263 - "32M" 264 - Do not dedicate more than 32Mb RAM for preliminary hashing. 265 - "256M" 266 - You have at most 256Mb RAM free for hash calculations. 267 268 #### --mailru-check-hash 269 270 What should copy do if file checksum is mismatched or invalid 271 272 - Config: check_hash 273 - Env Var: RCLONE_MAILRU_CHECK_HASH 274 - Type: bool 275 - Default: true 276 - Examples: 277 - "true" 278 - Fail with error. 279 - "false" 280 - Ignore and continue. 281 282 #### --mailru-user-agent 283 284 HTTP user agent used internally by client. 285 Defaults to "rclone/VERSION" or "--user-agent" provided on command line. 286 287 - Config: user_agent 288 - Env Var: RCLONE_MAILRU_USER_AGENT 289 - Type: string 290 - Default: "" 291 292 #### --mailru-quirks 293 294 Comma separated list of internal maintenance flags. 295 This option must not be used by an ordinary user. It is intended only to 296 facilitate remote troubleshooting of backend issues. Strict meaning of 297 flags is not documented and not guaranteed to persist between releases. 298 Quirks will be removed when the backend grows stable. 299 Supported quirks: atomicmkdir binlist gzip insecure retry400 300 301 - Config: quirks 302 - Env Var: RCLONE_MAILRU_QUIRKS 303 - Type: string 304 - Default: "" 305 306 #### --mailru-encoding 307 308 This sets the encoding for the backend. 309 310 See: the [encoding section in the overview](/overview/#encoding) for more info. 311 312 - Config: encoding 313 - Env Var: RCLONE_MAILRU_ENCODING 314 - Type: MultiEncoder 315 - Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Del,Ctl,InvalidUtf8,Dot 316 317 {{< rem autogenerated options stop >}}