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

     1  ---
     2  title: "put.io"
     3  description: "Rclone docs for put.io"
     4  ---
     5  
     6  {{< icon "fas fa-parking" >}} put.io
     7  ---------------------------------
     8  
     9  Paths are specified as `remote:path`
    10  
    11  put.io paths may be as deep as required, eg
    12  `remote:directory/subdirectory`.
    13  
    14  The initial setup for put.io involves getting a token from put.io
    15  which you need to do in your browser.  `rclone config` walks you
    16  through it.
    17  
    18  Here is an example of how to make a remote called `remote`.  First run:
    19  
    20       rclone config
    21  
    22  This will guide you through an interactive setup process:
    23  
    24  ```
    25  No remotes found - make a new one
    26  n) New remote
    27  s) Set configuration password
    28  q) Quit config
    29  n/s/q> n
    30  name> putio
    31  Type of storage to configure.
    32  Enter a string value. Press Enter for the default ("").
    33  Choose a number from below, or type in your own value
    34  [snip]
    35  XX / Put.io
    36     \ "putio"
    37  [snip]
    38  Storage> putio
    39  ** See help for putio backend at: https://rclone.org/putio/ **
    40  
    41  Remote config
    42  Use auto config?
    43   * Say Y if not sure
    44   * Say N if you are working on a remote or headless machine
    45  y) Yes
    46  n) No
    47  y/n> y
    48  If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth
    49  Log in and authorize rclone for access
    50  Waiting for code...
    51  Got code
    52  --------------------
    53  [putio]
    54  type = putio
    55  token = {"access_token":"XXXXXXXX","expiry":"0001-01-01T00:00:00Z"}
    56  --------------------
    57  y) Yes this is OK
    58  e) Edit this remote
    59  d) Delete this remote
    60  y/e/d> y
    61  Current remotes:
    62  
    63  Name                 Type
    64  ====                 ====
    65  putio                putio
    66  
    67  e) Edit existing remote
    68  n) New remote
    69  d) Delete remote
    70  r) Rename remote
    71  c) Copy remote
    72  s) Set configuration password
    73  q) Quit config
    74  e/n/d/r/c/s/q> q
    75  ```
    76  
    77  Note that rclone runs a webserver on your local machine to collect the
    78  token as returned from Google if you use auto config mode. This only
    79  runs from the moment it opens your browser to the moment you get back
    80  the verification code.  This is on `http://127.0.0.1:53682/` and this
    81  it may require you to unblock it temporarily if you are running a host
    82  firewall, or use manual mode.
    83  
    84  You can then use it like this,
    85  
    86  List directories in top level of your put.io
    87  
    88      rclone lsd remote:
    89  
    90  List all the files in your put.io
    91  
    92      rclone ls remote:
    93  
    94  To copy a local directory to a put.io directory called backup
    95  
    96      rclone copy /home/source remote:backup
    97  
    98  #### Restricted filename characters
    99  
   100  In addition to the [default restricted characters set](/overview/#restricted-characters)
   101  the following characters are also replaced:
   102  
   103  | Character | Value | Replacement |
   104  | --------- |:-----:|:-----------:|
   105  | \         | 0x5C  | ＼           |
   106  
   107  Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8),
   108  as they can't be used in JSON strings.
   109  
   110  {{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/putio/putio.go then run make backenddocs" >}}
   111  ### Advanced Options
   112  
   113  Here are the advanced options specific to putio (Put.io).
   114  
   115  #### --putio-encoding
   116  
   117  This sets the encoding for the backend.
   118  
   119  See: the [encoding section in the overview](/overview/#encoding) for more info.
   120  
   121  - Config:      encoding
   122  - Env Var:     RCLONE_PUTIO_ENCODING
   123  - Type:        MultiEncoder
   124  - Default:     Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot
   125  
   126  {{< rem autogenerated options stop >}}