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

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