mirror of
https://github.com/rclone/rclone.git
synced 2024-11-23 17:04:01 +01:00
253 lines
6.1 KiB
Markdown
253 lines
6.1 KiB
Markdown
|
---
|
||
|
|
title: "SugarSync"
|
||
|
|
description: "Rclone docs for SugarSync"
|
||
|
|
date: "2020-01-17"
|
||
|
|
---
|
||
|
|
|
||
|
|
<i class="fas fa-dove"></i> SugarSync
|
||
|
|
-----------------------------------------
|
||
|
|
|
||
|
|
[SugarSync](https://sugarsync.com) is a cloud service that enables
|
||
|
|
active synchronization of files across computers and other devices for
|
||
|
|
file backup, access, syncing, and sharing.
|
||
|
|
|
||
|
|
The initial setup for SugarSync involves getting a token from SugarSync which you
|
||
|
|
can do with rclone. `rclone config` walks you through it.
|
||
|
|
|
||
|
|
Here is an example of how to make a remote called `remote`. First run:
|
||
|
|
|
||
|
|
rclone config
|
||
|
|
|
||
|
|
This will guide you through an interactive setup process:
|
||
|
|
|
||
|
|
```
|
||
|
|
No remotes found - make a new one
|
||
|
|
n) New remote
|
||
|
|
s) Set configuration password
|
||
|
|
q) Quit config
|
||
|
|
n/s/q> n
|
||
|
|
name> remote
|
||
|
|
Type of storage to configure.
|
||
|
|
Enter a string value. Press Enter for the default ("").
|
||
|
|
Choose a number from below, or type in your own value
|
||
|
|
[snip]
|
||
|
|
XX / Sugarsync
|
||
|
|
\ "sugarsync"
|
||
|
|
[snip]
|
||
|
|
Storage> sugarsync
|
||
|
|
** See help for sugarsync backend at: https://rclone.org/sugarsync/ **
|
||
|
|
|
||
|
|
Sugarsync App ID.
|
||
|
|
Leave blank to use rclone's.
|
||
|
|
Enter a string value. Press Enter for the default ("").
|
||
|
|
app_id>
|
||
|
|
Sugarsync Access Key ID.
|
||
|
|
Leave blank to use rclone's.
|
||
|
|
Enter a string value. Press Enter for the default ("").
|
||
|
|
access_key_id>
|
||
|
|
Sugarsync Private Access Key
|
||
|
|
Leave blank to use rclone's.
|
||
|
|
Enter a string value. Press Enter for the default ("").
|
||
|
|
private_access_key>
|
||
|
|
Permanently delete files if true
|
||
|
|
otherwise put them in the deleted files.
|
||
|
|
Enter a boolean value (true or false). Press Enter for the default ("false").
|
||
|
|
hard_delete>
|
||
|
|
Edit advanced config? (y/n)
|
||
|
|
y) Yes
|
||
|
|
n) No (default)
|
||
|
|
y/n> n
|
||
|
|
Remote config
|
||
|
|
Username (email address)> nick@craig-wood.com
|
||
|
|
Your Sugarsync password is only required during setup and will not be stored.
|
||
|
|
password:
|
||
|
|
--------------------
|
||
|
|
[remote]
|
||
|
|
type = sugarsync
|
||
|
|
refresh_token = https://api.sugarsync.com/app-authorization/XXXXXXXXXXXXXXXXXX
|
||
|
|
--------------------
|
||
|
|
y) Yes this is OK (default)
|
||
|
|
e) Edit this remote
|
||
|
|
d) Delete this remote
|
||
|
|
y/e/d> y
|
||
|
|
```
|
||
|
|
|
||
|
|
Note that the config asks for your email and password but doesn't
|
||
|
|
store them, it only uses them to get the initial token.
|
||
|
|
|
||
|
|
Once configured you can then use `rclone` like this,
|
||
|
|
|
||
|
|
List directories (sync folders) in top level of your SugarSync
|
||
|
|
|
||
|
|
rclone lsd remote:
|
||
|
|
|
||
|
|
List all the files in your SugarSync folder "Test"
|
||
|
|
|
||
|
|
rclone ls remote:Test
|
||
|
|
|
||
|
|
To copy a local directory to an SugarSync folder called backup
|
||
|
|
|
||
|
|
rclone copy /home/source remote:backup
|
||
|
|
|
||
|
|
Paths are specified as `remote:path`
|
||
|
|
|
||
|
|
Paths may be as deep as required, eg `remote:directory/subdirectory`.
|
||
|
|
|
||
|
|
**NB** you can't create files in the top level folder you have to
|
||
|
|
create a folder, which rclone will create as a "Sync Folder" with
|
||
|
|
SugarSync.
|
||
|
|
|
||
|
|
### Modified time and hashes ###
|
||
|
|
|
||
|
|
SugarSync does not support modification times or hashes, therefore
|
||
|
|
syncing will default to `--size-only` checking. Note that using
|
||
|
|
`--update` will work as rclone can read the time files were uploaded.
|
||
|
|
|
||
|
|
#### Restricted filename characters
|
||
|
|
|
||
|
|
SugarSync replaces the [default restricted characters set](/overview/#restricted-characters)
|
||
|
|
except for DEL.
|
||
|
|
|
||
|
|
Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8),
|
||
|
|
as they can't be used in XML strings.
|
||
|
|
|
||
|
|
### Deleting files ###
|
||
|
|
|
||
|
|
Deleted files will be moved to the "Deleted items" folder by default.
|
||
|
|
|
||
|
|
However you can supply the flag `--sugarsync-hard-delete` or set the
|
||
|
|
config parameter `hard_delete = true` if you would like files to be
|
||
|
|
deleted straight away.
|
||
|
|
|
||
|
|
|
||
|
|
<!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/sugarsync/sugarsync.go then run make backenddocs -->
|
||
|
|
### Standard Options
|
||
|
|
|
||
|
|
Here are the standard options specific to sugarsync (Sugarsync).
|
||
|
|
|
||
|
|
#### --sugarsync-app-id
|
||
|
|
|
||
|
|
Sugarsync App ID.
|
||
|
|
|
||
|
|
Leave blank to use rclone's.
|
||
|
|
|
||
|
|
- Config: app_id
|
||
|
|
- Env Var: RCLONE_SUGARSYNC_APP_ID
|
||
|
|
- Type: string
|
||
|
|
- Default: ""
|
||
|
|
|
||
|
|
#### --sugarsync-access-key-id
|
||
|
|
|
||
|
|
Sugarsync Access Key ID.
|
||
|
|
|
||
|
|
Leave blank to use rclone's.
|
||
|
|
|
||
|
|
- Config: access_key_id
|
||
|
|
- Env Var: RCLONE_SUGARSYNC_ACCESS_KEY_ID
|
||
|
|
- Type: string
|
||
|
|
- Default: ""
|
||
|
|
|
||
|
|
#### --sugarsync-private-access-key
|
||
|
|
|
||
|
|
Sugarsync Private Access Key
|
||
|
|
|
||
|
|
Leave blank to use rclone's.
|
||
|
|
|
||
|
|
- Config: private_access_key
|
||
|
|
- Env Var: RCLONE_SUGARSYNC_PRIVATE_ACCESS_KEY
|
||
|
|
- Type: string
|
||
|
|
- Default: ""
|
||
|
|
|
||
|
|
#### --sugarsync-hard-delete
|
||
|
|
|
||
|
|
Permanently delete files if true
|
||
|
|
otherwise put them in the deleted files.
|
||
|
|
|
||
|
|
- Config: hard_delete
|
||
|
|
- Env Var: RCLONE_SUGARSYNC_HARD_DELETE
|
||
|
|
- Type: bool
|
||
|
|
- Default: false
|
||
|
|
|
||
|
|
### Advanced Options
|
||
|
|
|
||
|
|
Here are the advanced options specific to sugarsync (Sugarsync).
|
||
|
|
|
||
|
|
#### --sugarsync-refresh-token
|
||
|
|
|
||
|
|
Sugarsync refresh token
|
||
|
|
|
||
|
|
Leave blank normally, will be auto configured by rclone.
|
||
|
|
|
||
|
|
- Config: refresh_token
|
||
|
|
- Env Var: RCLONE_SUGARSYNC_REFRESH_TOKEN
|
||
|
|
- Type: string
|
||
|
|
- Default: ""
|
||
|
|
|
||
|
|
#### --sugarsync-authorization
|
||
|
|
|
||
|
|
Sugarsync authorization
|
||
|
|
|
||
|
|
Leave blank normally, will be auto configured by rclone.
|
||
|
|
|
||
|
|
- Config: authorization
|
||
|
|
- Env Var: RCLONE_SUGARSYNC_AUTHORIZATION
|
||
|
|
- Type: string
|
||
|
|
- Default: ""
|
||
|
|
|
||
|
|
#### --sugarsync-authorization-expiry
|
||
|
|
|
||
|
|
Sugarsync authorization expiry
|
||
|
|
|
||
|
|
Leave blank normally, will be auto configured by rclone.
|
||
|
|
|
||
|
|
- Config: authorization_expiry
|
||
|
|
- Env Var: RCLONE_SUGARSYNC_AUTHORIZATION_EXPIRY
|
||
|
|
- Type: string
|
||
|
|
- Default: ""
|
||
|
|
|
||
|
|
#### --sugarsync-user
|
||
|
|
|
||
|
|
Sugarsync user
|
||
|
|
|
||
|
|
Leave blank normally, will be auto configured by rclone.
|
||
|
|
|
||
|
|
- Config: user
|
||
|
|
- Env Var: RCLONE_SUGARSYNC_USER
|
||
|
|
- Type: string
|
||
|
|
- Default: ""
|
||
|
|
|
||
|
|
#### --sugarsync-root-id
|
||
|
|
|
||
|
|
Sugarsync root id
|
||
|
|
|
||
|
|
Leave blank normally, will be auto configured by rclone.
|
||
|
|
|
||
|
|
- Config: root_id
|
||
|
|
- Env Var: RCLONE_SUGARSYNC_ROOT_ID
|
||
|
|
- Type: string
|
||
|
|
- Default: ""
|
||
|
|
|
||
|
|
#### --sugarsync-deleted-id
|
||
|
|
|
||
|
|
Sugarsync deleted folder id
|
||
|
|
|
||
|
|
Leave blank normally, will be auto configured by rclone.
|
||
|
|
|
||
|
|
- Config: deleted_id
|
||
|
|
- Env Var: RCLONE_SUGARSYNC_DELETED_ID
|
||
|
|
- Type: string
|
||
|
|
- Default: ""
|
||
|
|
|
||
|
|
#### --sugarsync-encoding
|
||
|
|
|
||
|
|
This sets the encoding for the backend.
|
||
|
|
|
||
|
|
See: the [encoding section in the overview](/overview/#encoding) for more info.
|
||
|
|
|
||
|
|
- Config: encoding
|
||
|
|
- Env Var: RCLONE_SUGARSYNC_ENCODING
|
||
|
|
- Type: MultiEncoder
|
||
|
|
- Default: Slash,Ctl,InvalidUtf8,Dot
|
||
|
|
|
||
|
|
<!--- autogenerated options stop -->
|