github.com/rclone/rclone@v1.66.1-0.20240517100346-7b89735ae726/docs/content/opendrive.md (about)

     1  ---
     2  title: "OpenDrive"
     3  description: "Rclone docs for OpenDrive"
     4  versionIntroduced: "v1.42"
     5  ---
     6  
     7  # {{< icon "fa fa-file" >}} OpenDrive
     8  
     9  Paths are specified as `remote:path`
    10  
    11  Paths may be as deep as required, e.g. `remote:directory/subdirectory`.
    12  
    13  ## Configuration
    14  
    15  Here is an example of how to make a remote called `remote`.  First run:
    16  
    17       rclone config
    18  
    19  This will guide you through an interactive setup process:
    20  
    21  ```
    22  n) New remote
    23  d) Delete remote
    24  q) Quit config
    25  e/n/d/q> n
    26  name> remote
    27  Type of storage to configure.
    28  Choose a number from below, or type in your own value
    29  [snip]
    30  XX / OpenDrive
    31     \ "opendrive"
    32  [snip]
    33  Storage> opendrive
    34  Username
    35  username>
    36  Password
    37  y) Yes type in my own password
    38  g) Generate random password
    39  y/g> y
    40  Enter the password:
    41  password:
    42  Confirm the password:
    43  password:
    44  --------------------
    45  [remote]
    46  username =
    47  password = *** ENCRYPTED ***
    48  --------------------
    49  y) Yes this is OK
    50  e) Edit this remote
    51  d) Delete this remote
    52  y/e/d> y
    53  ```
    54  
    55  List directories in top level of your OpenDrive
    56  
    57      rclone lsd remote:
    58  
    59  List all the files in your OpenDrive
    60  
    61      rclone ls remote:
    62  
    63  To copy a local directory to an OpenDrive directory called backup
    64  
    65      rclone copy /home/source remote:backup
    66  
    67  ### Modification times and hashes
    68  
    69  OpenDrive allows modification times to be set on objects accurate to 1
    70  second. These will be used to detect whether objects need syncing or
    71  not.
    72  
    73  The MD5 hash algorithm is supported.
    74  
    75  ### Restricted filename characters
    76  
    77  | Character | Value | Replacement |
    78  | --------- |:-----:|:-----------:|
    79  | NUL       | 0x00  | ␀           |
    80  | /         | 0x2F  | ／          |
    81  | "         | 0x22  | ＂          |
    82  | *         | 0x2A  | ＊          |
    83  | :         | 0x3A  | ：          |
    84  | <         | 0x3C  | ＜          |
    85  | >         | 0x3E  | ＞          |
    86  | ?         | 0x3F  | ？          |
    87  | \         | 0x5C  | ＼          |
    88  | \|        | 0x7C  | ｜          |
    89  
    90  File names can also not begin or end with the following characters.
    91  These only get replaced if they are the first or last character in the name:
    92  
    93  | Character | Value | Replacement |
    94  | --------- |:-----:|:-----------:|
    95  | SP        | 0x20  | ␠           |
    96  | HT        | 0x09  | ␉           |
    97  | LF        | 0x0A  | ␊           |
    98  | VT        | 0x0B  | ␋           |
    99  | CR        | 0x0D  | ␍           |
   100  
   101  
   102  Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8),
   103  as they can't be used in JSON strings.
   104  
   105  {{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/opendrive/opendrive.go then run make backenddocs" >}}
   106  ### Standard options
   107  
   108  Here are the Standard options specific to opendrive (OpenDrive).
   109  
   110  #### --opendrive-username
   111  
   112  Username.
   113  
   114  Properties:
   115  
   116  - Config:      username
   117  - Env Var:     RCLONE_OPENDRIVE_USERNAME
   118  - Type:        string
   119  - Required:    true
   120  
   121  #### --opendrive-password
   122  
   123  Password.
   124  
   125  **NB** Input to this must be obscured - see [rclone obscure](/commands/rclone_obscure/).
   126  
   127  Properties:
   128  
   129  - Config:      password
   130  - Env Var:     RCLONE_OPENDRIVE_PASSWORD
   131  - Type:        string
   132  - Required:    true
   133  
   134  ### Advanced options
   135  
   136  Here are the Advanced options specific to opendrive (OpenDrive).
   137  
   138  #### --opendrive-encoding
   139  
   140  The encoding for the backend.
   141  
   142  See the [encoding section in the overview](/overview/#encoding) for more info.
   143  
   144  Properties:
   145  
   146  - Config:      encoding
   147  - Env Var:     RCLONE_OPENDRIVE_ENCODING
   148  - Type:        Encoding
   149  - Default:     Slash,LtGt,DoubleQuote,Colon,Question,Asterisk,Pipe,BackSlash,LeftSpace,LeftCrLfHtVt,RightSpace,RightCrLfHtVt,InvalidUtf8,Dot
   150  
   151  #### --opendrive-chunk-size
   152  
   153  Files will be uploaded in chunks this size.
   154  
   155  Note that these chunks are buffered in memory so increasing them will
   156  increase memory use.
   157  
   158  Properties:
   159  
   160  - Config:      chunk_size
   161  - Env Var:     RCLONE_OPENDRIVE_CHUNK_SIZE
   162  - Type:        SizeSuffix
   163  - Default:     10Mi
   164  
   165  #### --opendrive-description
   166  
   167  Description of the remote
   168  
   169  Properties:
   170  
   171  - Config:      description
   172  - Env Var:     RCLONE_OPENDRIVE_DESCRIPTION
   173  - Type:        string
   174  - Required:    false
   175  
   176  {{< rem autogenerated options stop >}}
   177  
   178  ## Limitations
   179  
   180  Note that OpenDrive is case insensitive so you can't have a
   181  file called "Hello.doc" and one called "hello.doc".
   182  
   183  There are quite a few characters that can't be in OpenDrive file
   184  names.  These can't occur on Windows platforms, but on non-Windows
   185  platforms they are common.  Rclone will map these names to and from an
   186  identical looking unicode equivalent.  For example if a file has a `?`
   187  in it will be mapped to `？` instead.
   188  
   189  `rclone about` is not supported by the OpenDrive backend. Backends without
   190  this capability cannot determine free space for an rclone mount or
   191  use policy `mfs` (most free space) as a member of an rclone union
   192  remote.
   193  
   194  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/)
   195  
   196