github.com/10XDev/rclone@v1.52.3-0.20200626220027-16af9ab76b2a/docs/content/yandex.md (about)

     1  ---
     2  title: "Yandex"
     3  description: "Yandex Disk"
     4  ---
     5  
     6  {{< icon "fa fa-space-shuttle" >}}Yandex Disk
     7  ----------------------------------------
     8  
     9  [Yandex Disk](https://disk.yandex.com) is a cloud storage solution created by [Yandex](https://yandex.com).
    10  
    11  Here is an example of making a yandex configuration.  First run
    12  
    13      rclone config
    14  
    15  This will guide you through an interactive setup process:
    16  
    17  ```
    18  No remotes found - make a new one
    19  n) New remote
    20  s) Set configuration password
    21  n/s> n
    22  name> remote
    23  Type of storage to configure.
    24  Choose a number from below, or type in your own value
    25  [snip]
    26  XX / Yandex Disk
    27     \ "yandex"
    28  [snip]
    29  Storage> yandex
    30  Yandex Client Id - leave blank normally.
    31  client_id>
    32  Yandex Client Secret - leave blank normally.
    33  client_secret>
    34  Remote config
    35  Use auto config?
    36   * Say Y if not sure
    37   * Say N if you are working on a remote or headless machine
    38  y) Yes
    39  n) No
    40  y/n> y
    41  If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth
    42  Log in and authorize rclone for access
    43  Waiting for code...
    44  Got code
    45  --------------------
    46  [remote]
    47  client_id =
    48  client_secret =
    49  token = {"access_token":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx","token_type":"bearer","expiry":"2016-12-29T12:27:11.362788025Z"}
    50  --------------------
    51  y) Yes this is OK
    52  e) Edit this remote
    53  d) Delete this remote
    54  y/e/d> y
    55  ```
    56  
    57  See the [remote setup docs](/remote_setup/) for how to set it up on a
    58  machine with no Internet browser available.
    59  
    60  Note that rclone runs a webserver on your local machine to collect the
    61  token as returned from Yandex Disk. This only runs from the moment it
    62  opens your browser to the moment you get back the verification code.
    63  This is on `http://127.0.0.1:53682/` and this it may require you to
    64  unblock it temporarily if you are running a host firewall.
    65  
    66  Once configured you can then use `rclone` like this,
    67  
    68  See top level directories
    69  
    70      rclone lsd remote:
    71  
    72  Make a new directory
    73  
    74      rclone mkdir remote:directory
    75  
    76  List the contents of a directory
    77  
    78      rclone ls remote:directory
    79  
    80  Sync `/home/local/directory` to the remote path, deleting any
    81  excess files in the path.
    82  
    83      rclone sync /home/local/directory remote:directory
    84  
    85  Yandex paths may be as deep as required, eg `remote:directory/subdirectory`.
    86  
    87  ### Modified time ###
    88  
    89  Modified times are supported and are stored accurate to 1 ns in custom
    90  metadata called `rclone_modified` in RFC3339 with nanoseconds format.
    91  
    92  ### MD5 checksums ###
    93  
    94  MD5 checksums are natively supported by Yandex Disk.
    95  
    96  ### Emptying Trash ###
    97  
    98  If you wish to empty your trash you can use the `rclone cleanup remote:`
    99  command which will permanently delete all your trashed files. This command
   100  does not take any path arguments.
   101  
   102  ### Quota information ###
   103  
   104  To view your current quota you can use the `rclone about remote:`
   105  command which will display your usage limit (quota) and the current usage.
   106  
   107  #### Restricted filename characters
   108  
   109  The [default restricted characters set](/overview/#restricted-characters)
   110  are replaced.
   111  
   112  Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8),
   113  as they can't be used in JSON strings.
   114  
   115  ### Limitations ###
   116  
   117  When uploading very large files (bigger than about 5GB) you will need
   118  to increase the `--timeout` parameter.  This is because Yandex pauses
   119  (perhaps to calculate the MD5SUM for the entire file) before returning
   120  confirmation that the file has been uploaded.  The default handling of
   121  timeouts in rclone is to assume a 5 minute pause is an error and close
   122  the connection - you'll see `net/http: timeout awaiting response
   123  headers` errors in the logs if this is happening.  Setting the timeout
   124  to twice the max size of file in GB should be enough, so if you want
   125  to upload a 30GB file set a timeout of `2 * 30 = 60m`, that is
   126  `--timeout 60m`.
   127  
   128  {{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/yandex/yandex.go then run make backenddocs" >}}
   129  ### Standard Options
   130  
   131  Here are the standard options specific to yandex (Yandex Disk).
   132  
   133  #### --yandex-client-id
   134  
   135  Yandex Client Id
   136  Leave blank normally.
   137  
   138  - Config:      client_id
   139  - Env Var:     RCLONE_YANDEX_CLIENT_ID
   140  - Type:        string
   141  - Default:     ""
   142  
   143  #### --yandex-client-secret
   144  
   145  Yandex Client Secret
   146  Leave blank normally.
   147  
   148  - Config:      client_secret
   149  - Env Var:     RCLONE_YANDEX_CLIENT_SECRET
   150  - Type:        string
   151  - Default:     ""
   152  
   153  ### Advanced Options
   154  
   155  Here are the advanced options specific to yandex (Yandex Disk).
   156  
   157  #### --yandex-unlink
   158  
   159  Remove existing public link to file/folder with link command rather than creating.
   160  Default is false, meaning link command will create or retrieve public link.
   161  
   162  - Config:      unlink
   163  - Env Var:     RCLONE_YANDEX_UNLINK
   164  - Type:        bool
   165  - Default:     false
   166  
   167  #### --yandex-encoding
   168  
   169  This sets the encoding for the backend.
   170  
   171  See: the [encoding section in the overview](/overview/#encoding) for more info.
   172  
   173  - Config:      encoding
   174  - Env Var:     RCLONE_YANDEX_ENCODING
   175  - Type:        MultiEncoder
   176  - Default:     Slash,Del,Ctl,InvalidUtf8,Dot
   177  
   178  {{< rem autogenerated options stop >}}