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