github.com/xhghs/rclone@v1.51.1-0.20200430155106-e186a28cced8/docs/content/sharefile.md (about) 1 --- 2 title: "Citrix ShareFile" 3 description: "Rclone docs for Citrix ShareFile" 4 date: "2019-09-30" 5 --- 6 7 ## <i class="fas fa-share-square"></i> Citrix ShareFile 8 9 [Citrix ShareFile](https://sharefile.com) is a secure file sharing and transfer service aimed as business. 10 11 The initial setup for Citrix ShareFile involves getting a token from 12 Citrix ShareFile which you can in your browser. `rclone config` walks you 13 through it. 14 15 Here is an example of how to make a remote called `remote`. First run: 16 17 rclone config 18 19 This will guide you through an interactive setup process: 20 21 ``` 22 No remotes found - make a new one 23 n) New remote 24 s) Set configuration password 25 q) Quit config 26 n/s/q> n 27 name> remote 28 Type of storage to configure. 29 Enter a string value. Press Enter for the default (""). 30 Choose a number from below, or type in your own value 31 XX / Citrix Sharefile 32 \ "sharefile" 33 Storage> sharefile 34 ** See help for sharefile backend at: https://rclone.org/sharefile/ ** 35 36 ID of the root folder 37 38 Leave blank to access "Personal Folders". You can use one of the 39 standard values here or any folder ID (long hex number ID). 40 Enter a string value. Press Enter for the default (""). 41 Choose a number from below, or type in your own value 42 1 / Access the Personal Folders. (Default) 43 \ "" 44 2 / Access the Favorites folder. 45 \ "favorites" 46 3 / Access all the shared folders. 47 \ "allshared" 48 4 / Access all the individual connectors. 49 \ "connectors" 50 5 / Access the home, favorites, and shared folders as well as the connectors. 51 \ "top" 52 root_folder_id> 53 Edit advanced config? (y/n) 54 y) Yes 55 n) No 56 y/n> n 57 Remote config 58 Use auto config? 59 * Say Y if not sure 60 * Say N if you are working on a remote or headless machine 61 y) Yes 62 n) No 63 y/n> y 64 If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth?state=XXX 65 Log in and authorize rclone for access 66 Waiting for code... 67 Got code 68 -------------------- 69 [remote] 70 type = sharefile 71 endpoint = https://XXX.sharefile.com 72 token = {"access_token":"XXX","token_type":"bearer","refresh_token":"XXX","expiry":"2019-09-30T19:41:45.878561877+01:00"} 73 -------------------- 74 y) Yes this is OK 75 e) Edit this remote 76 d) Delete this remote 77 y/e/d> y 78 ``` 79 80 See the [remote setup docs](/remote_setup/) for how to set it up on a 81 machine with no Internet browser available. 82 83 Note that rclone runs a webserver on your local machine to collect the 84 token as returned from Citrix ShareFile. This only runs from the moment it opens 85 your browser to the moment you get back the verification code. This 86 is on `http://127.0.0.1:53682/` and this it may require you to unblock 87 it temporarily if you are running a host firewall. 88 89 Once configured you can then use `rclone` like this, 90 91 List directories in top level of your ShareFile 92 93 rclone lsd remote: 94 95 List all the files in your ShareFile 96 97 rclone ls remote: 98 99 To copy a local directory to an ShareFile directory called backup 100 101 rclone copy /home/source remote:backup 102 103 Paths may be as deep as required, eg `remote:directory/subdirectory`. 104 105 ### Modified time and hashes ### 106 107 ShareFile allows modification times to be set on objects accurate to 1 108 second. These will be used to detect whether objects need syncing or 109 not. 110 111 ShareFile supports MD5 type hashes, so you can use the `--checksum` 112 flag. 113 114 ### Transfers ### 115 116 For files above 128MB rclone will use a chunked transfer. Rclone will 117 upload up to `--transfers` chunks at the same time (shared among all 118 the multipart uploads). Chunks are buffered in memory and are 119 normally 64MB so increasing `--transfers` will increase memory use. 120 121 ### Limitations ### 122 123 Note that ShareFile is case insensitive so you can't have a file called 124 "Hello.doc" and one called "hello.doc". 125 126 ShareFile only supports filenames up to 256 characters in length. 127 128 #### Restricted filename characters 129 130 In addition to the [default restricted characters set](/overview/#restricted-characters) 131 the following characters are also replaced: 132 133 | Character | Value | Replacement | 134 | --------- |:-----:|:-----------:| 135 | \\ | 0x5C | ＼ | 136 | * | 0x2A | ＊ | 137 | < | 0x3C | ＜ | 138 | > | 0x3E | ＞ | 139 | ? | 0x3F | ？ | 140 | : | 0x3A | ： | 141 | \| | 0x7C | ｜ | 142 | " | 0x22 | ＂ | 143 144 File names can also not start or end with the following characters. 145 These only get replaced if they are first or last character in the 146 name: 147 148 | Character | Value | Replacement | 149 | --------- |:-----:|:-----------:| 150 | SP | 0x20 | ␠ | 151 | . | 0x2E | ． | 152 153 Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8), 154 as they can't be used in JSON strings. 155 156 <!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/sharefile/sharefile.go then run make backenddocs --> 157 ### Standard Options 158 159 Here are the standard options specific to sharefile (Citrix Sharefile). 160 161 #### --sharefile-root-folder-id 162 163 ID of the root folder 164 165 Leave blank to access "Personal Folders". You can use one of the 166 standard values here or any folder ID (long hex number ID). 167 168 - Config: root_folder_id 169 - Env Var: RCLONE_SHAREFILE_ROOT_FOLDER_ID 170 - Type: string 171 - Default: "" 172 - Examples: 173 - "" 174 - Access the Personal Folders. (Default) 175 - "favorites" 176 - Access the Favorites folder. 177 - "allshared" 178 - Access all the shared folders. 179 - "connectors" 180 - Access all the individual connectors. 181 - "top" 182 - Access the home, favorites, and shared folders as well as the connectors. 183 184 ### Advanced Options 185 186 Here are the advanced options specific to sharefile (Citrix Sharefile). 187 188 #### --sharefile-upload-cutoff 189 190 Cutoff for switching to multipart upload. 191 192 - Config: upload_cutoff 193 - Env Var: RCLONE_SHAREFILE_UPLOAD_CUTOFF 194 - Type: SizeSuffix 195 - Default: 128M 196 197 #### --sharefile-chunk-size 198 199 Upload chunk size. Must a power of 2 >= 256k. 200 201 Making this larger will improve performance, but note that each chunk 202 is buffered in memory one per transfer. 203 204 Reducing this will reduce memory usage but decrease performance. 205 206 - Config: chunk_size 207 - Env Var: RCLONE_SHAREFILE_CHUNK_SIZE 208 - Type: SizeSuffix 209 - Default: 64M 210 211 #### --sharefile-endpoint 212 213 Endpoint for API calls. 214 215 This is usually auto discovered as part of the oauth process, but can 216 be set manually to something like: https://XXX.sharefile.com 217 218 219 - Config: endpoint 220 - Env Var: RCLONE_SHAREFILE_ENDPOINT 221 - Type: string 222 - Default: "" 223 224 #### --sharefile-encoding 225 226 This sets the encoding for the backend. 227 228 See: the [encoding section in the overview](/overview/#encoding) for more info. 229 230 - Config: encoding 231 - Env Var: RCLONE_SHAREFILE_ENCODING 232 - Type: MultiEncoder 233 - Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,Ctl,LeftSpace,LeftPeriod,RightSpace,RightPeriod,InvalidUtf8,Dot 234 235 <!--- autogenerated options stop -->