github.com/artpar/rclone@v1.67.3/docs/content/putio.md (about)

     1  ---
     2  title: "put.io"
     3  description: "Rclone docs for put.io"
     4  versionIntroduced: "v1.49"
     5  ---
     6  
     7  # {{< icon "fas fa-parking" >}} put.io
     8  
     9  Paths are specified as `remote:path`
    10  
    11  put.io paths may be as deep as required, e.g.
    12  `remote:directory/subdirectory`.
    13  
    14  ## Configuration
    15  
    16  The initial setup for put.io involves getting a token from put.io
    17  which you need to do in your browser.  `rclone config` walks you
    18  through it.
    19  
    20  Here is an example of how to make a remote called `remote`.  First run:
    21  
    22       rclone config
    23  
    24  This will guide you through an interactive setup process:
    25  
    26  ```
    27  No remotes found, make a new one?
    28  n) New remote
    29  s) Set configuration password
    30  q) Quit config
    31  n/s/q> n
    32  name> putio
    33  Type of storage to configure.
    34  Enter a string value. Press Enter for the default ("").
    35  Choose a number from below, or type in your own value
    36  [snip]
    37  XX / Put.io
    38     \ "putio"
    39  [snip]
    40  Storage> putio
    41  ** See help for putio backend at: https://rclone.org/putio/ **
    42  
    43  Remote config
    44  Use web browser to automatically authenticate rclone with remote?
    45   * Say Y if the machine running rclone has a web browser you can use
    46   * Say N if running rclone on a (remote) machine without web browser access
    47  If not sure try Y. If Y failed, try N.
    48  y) Yes
    49  n) No
    50  y/n> y
    51  If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth
    52  Log in and authorize rclone for access
    53  Waiting for code...
    54  Got code
    55  --------------------
    56  [putio]
    57  type = putio
    58  token = {"access_token":"XXXXXXXX","expiry":"0001-01-01T00:00:00Z"}
    59  --------------------
    60  y) Yes this is OK
    61  e) Edit this remote
    62  d) Delete this remote
    63  y/e/d> y
    64  Current remotes:
    65  
    66  Name                 Type
    67  ====                 ====
    68  putio                putio
    69  
    70  e) Edit existing remote
    71  n) New remote
    72  d) Delete remote
    73  r) Rename remote
    74  c) Copy remote
    75  s) Set configuration password
    76  q) Quit config
    77  e/n/d/r/c/s/q> q
    78  ```
    79  
    80  See the [remote setup docs](/remote_setup/) for how to set it up on a
    81  machine with no Internet browser available.
    82  
    83  Note that rclone runs a webserver on your local machine to collect the
    84  token as returned from put.io  if using web browser to automatically 
    85  authenticate. This only
    86  runs from the moment it opens your browser to the moment you get back
    87  the verification code.  This is on `http://127.0.0.1:53682/` and this
    88  it may require you to unblock it temporarily if you are running a host
    89  firewall, or use manual mode.
    90  
    91  You can then use it like this,
    92  
    93  List directories in top level of your put.io
    94  
    95      rclone lsd remote:
    96  
    97  List all the files in your put.io
    98  
    99      rclone ls remote:
   100  
   101  To copy a local directory to a put.io directory called backup
   102  
   103      rclone copy /home/source remote:backup
   104  
   105  ### Restricted filename characters
   106  
   107  In addition to the [default restricted characters set](/overview/#restricted-characters)
   108  the following characters are also replaced:
   109  
   110  | Character | Value | Replacement |
   111  | --------- |:-----:|:-----------:|
   112  | \         | 0x5C  | ＼           |
   113  
   114  Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8),
   115  as they can't be used in JSON strings.
   116  
   117  {{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/putio/putio.go then run make backenddocs" >}}
   118  ### Standard options
   119  
   120  Here are the Standard options specific to putio (Put.io).
   121  
   122  #### --putio-client-id
   123  
   124  OAuth Client Id.
   125  
   126  Leave blank normally.
   127  
   128  Properties:
   129  
   130  - Config:      client_id
   131  - Env Var:     RCLONE_PUTIO_CLIENT_ID
   132  - Type:        string
   133  - Required:    false
   134  
   135  #### --putio-client-secret
   136  
   137  OAuth Client Secret.
   138  
   139  Leave blank normally.
   140  
   141  Properties:
   142  
   143  - Config:      client_secret
   144  - Env Var:     RCLONE_PUTIO_CLIENT_SECRET
   145  - Type:        string
   146  - Required:    false
   147  
   148  ### Advanced options
   149  
   150  Here are the Advanced options specific to putio (Put.io).
   151  
   152  #### --putio-token
   153  
   154  OAuth Access Token as a JSON blob.
   155  
   156  Properties:
   157  
   158  - Config:      token
   159  - Env Var:     RCLONE_PUTIO_TOKEN
   160  - Type:        string
   161  - Required:    false
   162  
   163  #### --putio-auth-url
   164  
   165  Auth server URL.
   166  
   167  Leave blank to use the provider defaults.
   168  
   169  Properties:
   170  
   171  - Config:      auth_url
   172  - Env Var:     RCLONE_PUTIO_AUTH_URL
   173  - Type:        string
   174  - Required:    false
   175  
   176  #### --putio-token-url
   177  
   178  Token server url.
   179  
   180  Leave blank to use the provider defaults.
   181  
   182  Properties:
   183  
   184  - Config:      token_url
   185  - Env Var:     RCLONE_PUTIO_TOKEN_URL
   186  - Type:        string
   187  - Required:    false
   188  
   189  #### --putio-encoding
   190  
   191  The encoding for the backend.
   192  
   193  See the [encoding section in the overview](/overview/#encoding) for more info.
   194  
   195  Properties:
   196  
   197  - Config:      encoding
   198  - Env Var:     RCLONE_PUTIO_ENCODING
   199  - Type:        Encoding
   200  - Default:     Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot
   201  
   202  #### --putio-description
   203  
   204  Description of the remote
   205  
   206  Properties:
   207  
   208  - Config:      description
   209  - Env Var:     RCLONE_PUTIO_DESCRIPTION
   210  - Type:        string
   211  - Required:    false
   212  
   213  {{< rem autogenerated options stop >}}
   214  
   215  ## Limitations
   216  
   217  put.io has rate limiting. When you hit a limit, rclone automatically
   218  retries after waiting the amount of time requested by the server.
   219  
   220  If you want to avoid ever hitting these limits, you may use the
   221  `--tpslimit` flag with a low number. Note that the imposed limits
   222  may be different for different operations, and may change over time.