2014-07-17 19:03:11 +00:00
---
title: "Dropbox"
description: "Rclone docs for Dropbox"
---
2020-05-22 11:22:52 +00:00
{{< icon " fab fa-dropbox " > }} Dropbox
2014-07-17 19:03:11 +00:00
---------------------------------
Paths are specified as `remote:path`
2020-10-13 21:49:58 +00:00
Dropbox paths may be as deep as required, e.g.
2014-07-17 19:03:11 +00:00
`remote:directory/subdirectory` .
The initial setup for dropbox involves getting a token from Dropbox
which you need to do in your browser. `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:
```
n) New remote
d) Delete remote
q) Quit config
e/n/d/q> n
name> remote
2016-02-21 13:39:04 +00:00
Type of storage to configure.
Choose a number from below, or type in your own value
2019-08-26 09:47:17 +00:00
[snip]
XX / Dropbox
2016-02-21 13:39:04 +00:00
\ "dropbox"
2019-08-26 09:47:17 +00:00
[snip]
Storage> dropbox
2015-10-03 13:23:12 +00:00
Dropbox App Key - leave blank normally.
2017-01-09 05:09:19 +00:00
app_key>
2015-10-03 13:23:12 +00:00
Dropbox App Secret - leave blank normally.
2017-01-09 05:09:19 +00:00
app_secret>
2014-07-17 19:03:11 +00:00
Remote config
Please visit:
https://www.dropbox.com/1/oauth2/authorize?client_id=XXXXXXXXXXXXXXX& response_type=code
Enter the code: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX_XXXXXXXXXX
--------------------
[remote]
2017-01-09 05:09:19 +00:00
app_key =
app_secret =
2014-07-17 19:03:11 +00:00
token = XXXXXXXXXXXXXXXXXXXXXXXXXXXXX_XXXX_XXXXXXXXXXXXXXXXXXXXXXXXXXXXX
--------------------
y) Yes this is OK
e) Edit this remote
d) Delete this remote
y/e/d> y
```
You can then use it like this,
List directories in top level of your dropbox
rclone lsd remote:
List all the files in your dropbox
rclone ls remote:
To copy a local directory to a dropbox directory called backup
rclone copy /home/source remote:backup
2018-05-28 09:50:31 +00:00
### Dropbox for business ###
Rclone supports Dropbox for business and Team Folders.
When using Dropbox for business `remote:` and `remote:path/to/file`
will refer to your personal folder.
If you wish to see Team Folders you must use a leading `/` in the
path, so `rclone lsd remote:/` will refer to the root and show you all
Team Folders and your User Folder.
You can then use team folders like this `remote:/TeamFolder` and
`remote:/TeamFolder/path/to/file` .
A leading `/` for a Dropbox personal account will do nothing, but it
will take an extra HTTP transaction so it should be avoided.
2017-05-26 14:09:31 +00:00
### Modified time and Hashes ###
2014-07-17 19:03:11 +00:00
2017-05-21 20:35:33 +00:00
Dropbox supports modified times, but the only way to set a
modification time is to re-upload the file.
This means that if you uploaded your data with an older version of
rclone which didn't support the v2 API and modified times, rclone will
decide to upload all your old data to fix the modification times. If
you don't want this to happen use `--size-only` or `--checksum` flag
to stop it.
2015-05-18 19:07:49 +00:00
2017-05-26 14:09:31 +00:00
Dropbox supports [its own hash
type](https://www.dropbox.com/developers/reference/content-hash) which
is checked for all transfers.
2018-11-02 12:14:02 +00:00
#### Restricted filename characters
| Character | Value | Replacement |
| --------- |:-----:|:-----------:|
| NUL | 0x00 | ␀ |
| / | 0x2F | / |
| DEL | 0x7F | ␡ |
| \ | 0x5C | \ |
File names can also not end with the following characters.
2020-05-25 23:30:30 +00:00
These only get replaced if they are the last character in the name:
2018-11-02 12:14:02 +00:00
| Character | Value | Replacement |
| --------- |:-----:|:-----------:|
| SP | 0x20 | ␠ |
Invalid UTF-8 bytes will also be [replaced ](/overview/#invalid-utf8 ),
as they can't be used in JSON strings.
2020-05-22 11:22:52 +00:00
{{< rem autogenerated options start " - DO NOT EDIT - instead edit fs . RegInfo in backend / dropbox / dropbox . go then run make backenddocs " > }}
2018-10-01 19:48:54 +00:00
### Standard Options
Here are the standard options specific to dropbox (Dropbox).
#### --dropbox-client-id
2020-09-02 15:59:04 +00:00
OAuth Client Id
2018-10-01 19:48:54 +00:00
Leave blank normally.
- Config: client_id
- Env Var: RCLONE_DROPBOX_CLIENT_ID
- Type: string
- Default: ""
#### --dropbox-client-secret
2020-09-02 15:59:04 +00:00
OAuth Client Secret
2018-10-01 19:48:54 +00:00
Leave blank normally.
- Config: client_secret
- Env Var: RCLONE_DROPBOX_CLIENT_SECRET
- Type: string
- Default: ""
### Advanced Options
Here are the advanced options specific to dropbox (Dropbox).
2020-09-02 15:59:04 +00:00
#### --dropbox-token
OAuth Access Token as a JSON blob.
- Config: token
- Env Var: RCLONE_DROPBOX_TOKEN
- Type: string
- Default: ""
#### --dropbox-auth-url
Auth server URL.
Leave blank to use the provider defaults.
- Config: auth_url
- Env Var: RCLONE_DROPBOX_AUTH_URL
- Type: string
- Default: ""
#### --dropbox-token-url
Token server url.
Leave blank to use the provider defaults.
- Config: token_url
- Env Var: RCLONE_DROPBOX_TOKEN_URL
- Type: string
- Default: ""
2018-10-01 19:48:54 +00:00
#### --dropbox-chunk-size
Upload chunk size. (< 150M ) .
Any files larger than this will be uploaded in chunks of this size.
Note that chunks are buffered in memory (one at a time) so rclone can
deal with retries. Setting this larger will increase the speed
slightly (at most 10% for 128MB in tests) at the cost of using more
memory. It can be set smaller if you are tight on memory.
- Config: chunk_size
- Env Var: RCLONE_DROPBOX_CHUNK_SIZE
- Type: SizeSuffix
- Default: 48M
2018-11-24 13:44:25 +00:00
#### --dropbox-impersonate
Impersonate this user when using a business account.
2021-03-31 18:12:08 +00:00
Note that if you want to use impersonate, you should make sure this
flag is set when running "rclone config" as this will cause rclone to
request the "members.read" scope which it won't normally. This is
needed to lookup a members email address into the internal ID that
dropbox uses in the API.
Using the "members.read" scope will require a Dropbox Team Admin
to approve during the OAuth flow.
You will have to use your own App (setting your own client_id and
client_secret) to use this option as currently rclone's default set of
permissions doesn't include "members.read". This can be added once
v1.55 or later is in use everywhere.
2018-11-24 13:44:25 +00:00
- Config: impersonate
- Env Var: RCLONE_DROPBOX_IMPERSONATE
- Type: string
- Default: ""
2020-09-04 14:01:59 +00:00
#### --dropbox-shared-files
Instructs rclone to work on individual shared files.
In this mode rclone's features are extremely limited - only list (ls, lsl, etc.)
operations and read operations (e.g. downloading) are supported in this mode.
All other operations will be disabled.
- Config: shared_files
- Env Var: RCLONE_DROPBOX_SHARED_FILES
- Type: bool
- Default: false
#### --dropbox-shared-folders
Instructs rclone to work on shared folders.
When this flag is used with no path only the List operation is supported and
all available shared folders will be listed. If you specify a path the first part
will be interpreted as the name of shared folder. Rclone will then try to mount this
shared to the root namespace. On success shared folder rclone proceeds normally.
The shared folder is now pretty much a normal folder and all normal operations
are supported.
Note that we don't unmount the shared folder afterwards so the
--dropbox-shared-folders can be omitted after the first use of a particular
shared folder.
- Config: shared_folders
- Env Var: RCLONE_DROPBOX_SHARED_FOLDERS
- Type: bool
- Default: false
2020-02-01 10:31:42 +00:00
#### --dropbox-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_DROPBOX_ENCODING
- Type: MultiEncoder
- Default: Slash,BackSlash,Del,RightSpace,InvalidUtf8,Dot
2020-05-22 11:22:52 +00:00
{{< rem autogenerated options stop > }}
2015-11-14 11:38:35 +00:00
2015-06-06 09:05:21 +00:00
### Limitations ###
2015-05-18 19:07:49 +00:00
2015-11-14 11:20:04 +00:00
Note that Dropbox is case insensitive so you can't have a file called
2015-07-30 19:26:29 +00:00
"Hello.doc" and one called "hello.doc".
2015-08-20 17:36:06 +00:00
There are some file names such as `thumbs.db` which Dropbox can't
store. There is a full list of them in the ["Ignored Files" section
of this document](https://www.dropbox.com/en/help/145). Rclone will
issue an error message `File name disallowed - not uploading` if it
2018-04-13 12:24:58 +00:00
attempts to upload one of those file names, but the sync won't fail.
2016-03-22 14:46:43 +00:00
2020-05-31 11:22:54 +00:00
Some errors may occur if you try to sync copyright-protected files
because Dropbox has its own [copyright detector ](https://techcrunch.com/2014/03/30/how-dropbox-knows-when-youre-sharing-copyrighted-stuff-without-actually-looking-at-your-stuff/ ) that
prevents this sort of file being downloaded. This will return the error `ERROR :
/path/to/your/file: Failed to copy: failed to open source object:
path/restricted_content/.`
2016-03-22 14:46:43 +00:00
If you have more than 10,000 files in a directory then `rclone purge
dropbox:dir` will return the error `Failed to purge: There are too
many files involved in this operation`. As a work-around do an
2017-04-24 15:38:49 +00:00
`rclone delete dropbox:dir` followed by an `rclone rmdir dropbox:dir` .
2019-10-28 16:49:16 +00:00
### Get your own Dropbox App ID ###
When you use rclone with Dropbox in its default configuration you are using rclone's App ID. This is shared between all the rclone users.
Here is how to create your own Dropbox App ID for rclone:
1. Log into the [Dropbox App console ](https://www.dropbox.com/developers/apps/create ) with your Dropbox Account (It need not
to be the same account as the Dropbox you want to access)
2. Choose an API => Usually this should be `Dropbox API`
2020-03-18 13:31:04 +00:00
3. Choose the type of access you want to use => `Full Dropbox` or `App Folder`
2019-10-28 16:49:16 +00:00
2020-03-18 13:31:04 +00:00
4. Name your App. The app name is global, so you can't use `rclone` for example
2019-10-28 16:49:16 +00:00
5. Click the button `Create App`
2020-03-18 13:31:04 +00:00
5. Fill `Redirect URIs` as `http://localhost:53682/`
2019-10-28 16:49:16 +00:00
6. Find the `App key` and `App secret` Use these values in rclone config to add a new remote or edit an existing remote.