github.com/xhghs/rclone@v1.51.1-0.20200430155106-e186a28cced8/docs/content/yandex.md (about)

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