2017-07-17 05:36:45 +00:00
---
title: "OpenDrive"
description: "Rclone docs for OpenDrive"
2022-11-17 17:56:24 +00:00
versionIntroduced: "v1.42"
2017-07-17 05:36:45 +00:00
---
2021-07-20 18:45:41 +00:00
# {{< icon "fa fa-file" >}} OpenDrive
2017-07-17 05:36:45 +00:00
Paths are specified as `remote:path`
2020-10-13 21:49:58 +00:00
Paths may be as deep as required, e.g. `remote:directory/subdirectory` .
2017-07-17 05:36:45 +00:00
2021-10-14 13:40:18 +00:00
## Configuration
2017-07-17 05:36:45 +00:00
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
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 / OpenDrive
2017-07-17 05:36:45 +00:00
\ "opendrive"
2019-08-26 09:47:17 +00:00
[snip]
Storage> opendrive
2017-07-17 05:36:45 +00:00
Username
username>
Password
y) Yes type in my own password
g) Generate random password
y/g> y
Enter the password:
password:
Confirm the password:
password:
--------------------
[remote]
username =
password = ** * ENCRYPTED ** *
--------------------
y) Yes this is OK
e) Edit this remote
d) Delete this remote
y/e/d> y
```
List directories in top level of your OpenDrive
rclone lsd remote:
List all the files in your OpenDrive
rclone ls remote:
To copy a local directory to an OpenDrive directory called backup
rclone copy /home/source remote:backup
2023-11-18 12:36:46 +00:00
### Modification times and hashes
2017-07-17 05:36:45 +00:00
OpenDrive allows modification times to be set on objects accurate to 1
second. These will be used to detect whether objects need syncing or
not.
2023-11-18 12:36:46 +00:00
The MD5 hash algorithm is supported.
2021-10-14 13:40:18 +00:00
### Restricted filename characters
2018-11-02 12:14:30 +00:00
| Character | Value | Replacement |
| --------- |:-----:|:-----------:|
| NUL | 0x00 | ␀ |
| / | 0x2F | / |
| " | 0x22 | " |
| * | 0x2A | * |
| : | 0x3A | : |
| < | 0x3C | < |
| > | 0x3E | > |
| ? | 0x3F | ? |
| \ | 0x5C | \ |
| \| | 0x7C | | |
File names can also not begin or end with the following characters.
These only get replaced if they are the first or last character in the name:
| Character | Value | Replacement |
| --------- |:-----:|:-----------:|
| SP | 0x20 | ␠ |
| HT | 0x09 | ␉ |
| LF | 0x0A | ␊ |
| VT | 0x0B | ␋ |
| CR | 0x0D | ␍ |
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 / opendrive / opendrive . go then run make backenddocs " > }}
2021-11-01 15:42:05 +00:00
### Standard options
2018-10-01 19:48:54 +00:00
2022-07-09 17:08:20 +00:00
Here are the Standard options specific to opendrive (OpenDrive).
2018-10-01 19:48:54 +00:00
#### --opendrive-username
2021-11-01 15:42:05 +00:00
Username.
2018-10-01 19:48:54 +00:00
2022-03-18 12:29:54 +00:00
Properties:
2018-10-01 19:48:54 +00:00
- Config: username
- Env Var: RCLONE_OPENDRIVE_USERNAME
- Type: string
2022-03-18 12:29:54 +00:00
- Required: true
2018-10-01 19:48:54 +00:00
#### --opendrive-password
Password.
2020-09-02 15:59:04 +00:00
**NB** Input to this must be obscured - see [rclone obscure ](/commands/rclone_obscure/ ).
2022-03-18 12:29:54 +00:00
Properties:
2018-10-01 19:48:54 +00:00
- Config: password
- Env Var: RCLONE_OPENDRIVE_PASSWORD
- Type: string
2022-03-18 12:29:54 +00:00
- Required: true
2018-10-01 19:48:54 +00:00
2021-11-01 15:42:05 +00:00
### Advanced options
2020-02-01 10:31:42 +00:00
2022-07-09 17:08:20 +00:00
Here are the Advanced options specific to opendrive (OpenDrive).
2020-02-01 10:31:42 +00:00
#### --opendrive-encoding
2022-03-18 12:29:54 +00:00
The encoding for the backend.
2020-02-01 10:31:42 +00:00
2021-11-01 15:42:05 +00:00
See the [encoding section in the overview ](/overview/#encoding ) for more info.
2020-02-01 10:31:42 +00:00
2022-03-18 12:29:54 +00:00
Properties:
2020-02-01 10:31:42 +00:00
- Config: encoding
- Env Var: RCLONE_OPENDRIVE_ENCODING
2023-11-26 15:59:12 +00:00
- Type: Encoding
2020-02-01 10:31:42 +00:00
- Default: Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,LeftSpace,LeftCrLfHtVt,RightSpace,RightCrLfHtVt,InvalidUtf8,Dot
#### --opendrive-chunk-size
Files will be uploaded in chunks this size.
Note that these chunks are buffered in memory so increasing them will
increase memory use.
2022-03-18 12:29:54 +00:00
Properties:
2020-02-01 10:31:42 +00:00
- Config: chunk_size
- Env Var: RCLONE_OPENDRIVE_CHUNK_SIZE
- Type: SizeSuffix
2021-07-20 18:45:41 +00:00
- Default: 10Mi
2020-02-01 10:31:42 +00:00
2024-03-10 11:22:43 +00:00
#### --opendrive-description
2024-06-14 15:04:51 +00:00
Description of the remote.
2024-03-10 11:22:43 +00:00
Properties:
- Config: description
- Env Var: RCLONE_OPENDRIVE_DESCRIPTION
- Type: string
- Required: false
2020-05-22 11:22:52 +00:00
{{< rem autogenerated options stop > }}
2017-07-17 05:36:45 +00:00
2021-10-14 13:40:18 +00:00
## Limitations
2017-07-17 05:36:45 +00:00
Note that OpenDrive is case insensitive so you can't have a
file called "Hello.doc" and one called "hello.doc".
There are quite a few characters that can't be in OpenDrive file
names. These can't occur on Windows platforms, but on non-Windows
platforms they are common. Rclone will map these names to and from an
identical looking unicode equivalent. For example if a file has a `?`
in it will be mapped to `?` instead.
2020-11-27 14:08:52 +00:00
`rclone about` is not supported by the OpenDrive backend. Backends without
this capability cannot determine free space for an rclone mount or
use policy `mfs` (most free space) as a member of an rclone union
remote.
2022-05-13 22:06:45 +00:00
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/ )
2020-11-27 14:08:52 +00:00