github.com/artpar/rclone@v1.67.3/docs/content/sugarsync.md (about) 1 --- 2 title: "SugarSync" 3 description: "Rclone docs for SugarSync" 4 versionIntroduced: "v1.51" 5 --- 6 7 # {{< icon "fas fa-dove" >}} SugarSync 8 9 [SugarSync](https://sugarsync.com) is a cloud service that enables 10 active synchronization of files across computers and other devices for 11 file backup, access, syncing, and sharing. 12 13 ## Configuration 14 15 The initial setup for SugarSync involves getting a token from SugarSync which you 16 can do with rclone. `rclone config` walks you through it. 17 18 Here is an example of how to make a remote called `remote`. First run: 19 20 rclone config 21 22 This will guide you through an interactive setup process: 23 24 ``` 25 No remotes found, make a new one? 26 n) New remote 27 s) Set configuration password 28 q) Quit config 29 n/s/q> n 30 name> remote 31 Type of storage to configure. 32 Enter a string value. Press Enter for the default (""). 33 Choose a number from below, or type in your own value 34 [snip] 35 XX / Sugarsync 36 \ "sugarsync" 37 [snip] 38 Storage> sugarsync 39 ** See help for sugarsync backend at: https://rclone.org/sugarsync/ ** 40 41 Sugarsync App ID. 42 Leave blank to use rclone's. 43 Enter a string value. Press Enter for the default (""). 44 app_id> 45 Sugarsync Access Key ID. 46 Leave blank to use rclone's. 47 Enter a string value. Press Enter for the default (""). 48 access_key_id> 49 Sugarsync Private Access Key 50 Leave blank to use rclone's. 51 Enter a string value. Press Enter for the default (""). 52 private_access_key> 53 Permanently delete files if true 54 otherwise put them in the deleted files. 55 Enter a boolean value (true or false). Press Enter for the default ("false"). 56 hard_delete> 57 Edit advanced config? (y/n) 58 y) Yes 59 n) No (default) 60 y/n> n 61 Remote config 62 Username (email address)> nick@craig-wood.com 63 Your Sugarsync password is only required during setup and will not be stored. 64 password: 65 -------------------- 66 [remote] 67 type = sugarsync 68 refresh_token = https://api.sugarsync.com/app-authorization/XXXXXXXXXXXXXXXXXX 69 -------------------- 70 y) Yes this is OK (default) 71 e) Edit this remote 72 d) Delete this remote 73 y/e/d> y 74 ``` 75 76 Note that the config asks for your email and password but doesn't 77 store them, it only uses them to get the initial token. 78 79 Once configured you can then use `rclone` like this, 80 81 List directories (sync folders) in top level of your SugarSync 82 83 rclone lsd remote: 84 85 List all the files in your SugarSync folder "Test" 86 87 rclone ls remote:Test 88 89 To copy a local directory to an SugarSync folder called backup 90 91 rclone copy /home/source remote:backup 92 93 Paths are specified as `remote:path` 94 95 Paths may be as deep as required, e.g. `remote:directory/subdirectory`. 96 97 **NB** you can't create files in the top level folder you have to 98 create a folder, which rclone will create as a "Sync Folder" with 99 SugarSync. 100 101 ### Modification times and hashes 102 103 SugarSync does not support modification times or hashes, therefore 104 syncing will default to `--size-only` checking. Note that using 105 `--update` will work as rclone can read the time files were uploaded. 106 107 ### Restricted filename characters 108 109 SugarSync replaces the [default restricted characters set](/overview/#restricted-characters) 110 except for DEL. 111 112 Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8), 113 as they can't be used in XML strings. 114 115 ### Deleting files 116 117 Deleted files will be moved to the "Deleted items" folder by default. 118 119 However you can supply the flag `--sugarsync-hard-delete` or set the 120 config parameter `hard_delete = true` if you would like files to be 121 deleted straight away. 122 123 124 {{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/sugarsync/sugarsync.go then run make backenddocs" >}} 125 ### Standard options 126 127 Here are the Standard options specific to sugarsync (Sugarsync). 128 129 #### --sugarsync-app-id 130 131 Sugarsync App ID. 132 133 Leave blank to use rclone's. 134 135 Properties: 136 137 - Config: app_id 138 - Env Var: RCLONE_SUGARSYNC_APP_ID 139 - Type: string 140 - Required: false 141 142 #### --sugarsync-access-key-id 143 144 Sugarsync Access Key ID. 145 146 Leave blank to use rclone's. 147 148 Properties: 149 150 - Config: access_key_id 151 - Env Var: RCLONE_SUGARSYNC_ACCESS_KEY_ID 152 - Type: string 153 - Required: false 154 155 #### --sugarsync-private-access-key 156 157 Sugarsync Private Access Key. 158 159 Leave blank to use rclone's. 160 161 Properties: 162 163 - Config: private_access_key 164 - Env Var: RCLONE_SUGARSYNC_PRIVATE_ACCESS_KEY 165 - Type: string 166 - Required: false 167 168 #### --sugarsync-hard-delete 169 170 Permanently delete files if true 171 otherwise put them in the deleted files. 172 173 Properties: 174 175 - Config: hard_delete 176 - Env Var: RCLONE_SUGARSYNC_HARD_DELETE 177 - Type: bool 178 - Default: false 179 180 ### Advanced options 181 182 Here are the Advanced options specific to sugarsync (Sugarsync). 183 184 #### --sugarsync-refresh-token 185 186 Sugarsync refresh token. 187 188 Leave blank normally, will be auto configured by rclone. 189 190 Properties: 191 192 - Config: refresh_token 193 - Env Var: RCLONE_SUGARSYNC_REFRESH_TOKEN 194 - Type: string 195 - Required: false 196 197 #### --sugarsync-authorization 198 199 Sugarsync authorization. 200 201 Leave blank normally, will be auto configured by rclone. 202 203 Properties: 204 205 - Config: authorization 206 - Env Var: RCLONE_SUGARSYNC_AUTHORIZATION 207 - Type: string 208 - Required: false 209 210 #### --sugarsync-authorization-expiry 211 212 Sugarsync authorization expiry. 213 214 Leave blank normally, will be auto configured by rclone. 215 216 Properties: 217 218 - Config: authorization_expiry 219 - Env Var: RCLONE_SUGARSYNC_AUTHORIZATION_EXPIRY 220 - Type: string 221 - Required: false 222 223 #### --sugarsync-user 224 225 Sugarsync user. 226 227 Leave blank normally, will be auto configured by rclone. 228 229 Properties: 230 231 - Config: user 232 - Env Var: RCLONE_SUGARSYNC_USER 233 - Type: string 234 - Required: false 235 236 #### --sugarsync-root-id 237 238 Sugarsync root id. 239 240 Leave blank normally, will be auto configured by rclone. 241 242 Properties: 243 244 - Config: root_id 245 - Env Var: RCLONE_SUGARSYNC_ROOT_ID 246 - Type: string 247 - Required: false 248 249 #### --sugarsync-deleted-id 250 251 Sugarsync deleted folder id. 252 253 Leave blank normally, will be auto configured by rclone. 254 255 Properties: 256 257 - Config: deleted_id 258 - Env Var: RCLONE_SUGARSYNC_DELETED_ID 259 - Type: string 260 - Required: false 261 262 #### --sugarsync-encoding 263 264 The encoding for the backend. 265 266 See the [encoding section in the overview](/overview/#encoding) for more info. 267 268 Properties: 269 270 - Config: encoding 271 - Env Var: RCLONE_SUGARSYNC_ENCODING 272 - Type: Encoding 273 - Default: Slash,Ctl,InvalidUtf8,Dot 274 275 #### --sugarsync-description 276 277 Description of the remote 278 279 Properties: 280 281 - Config: description 282 - Env Var: RCLONE_SUGARSYNC_DESCRIPTION 283 - Type: string 284 - Required: false 285 286 {{< rem autogenerated options stop >}} 287 288 ## Limitations 289 290 `rclone about` is not supported by the SugarSync backend. Backends without 291 this capability cannot determine free space for an rclone mount or 292 use policy `mfs` (most free space) as a member of an rclone union 293 remote. 294 295 See [List of backends that do not support rclone about](https://rclone.org/overview/#optional-features) and [rclone about](https://rclone.org/commands/rclone_about/) 296