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