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

     1  ---
     2  title: "pCloud"
     3  description: "Rclone docs for pCloud"
     4  date: "2017-10-01"
     5  ---
     6  
     7  <i class="fa fa-cloud"></i> pCloud
     8  -----------------------------------------
     9  
    10  Paths are specified as `remote:path`
    11  
    12  Paths may be as deep as required, eg `remote:directory/subdirectory`.
    13  
    14  The initial setup for pCloud involves getting a token from pCloud which you
    15  need to do in your browser.  `rclone config` walks you through it.
    16  
    17  Here is an example of how to make a remote called `remote`.  First run:
    18  
    19       rclone config
    20  
    21  This will guide you through an interactive setup process:
    22  
    23  ```
    24  No remotes found - make a new one
    25  n) New remote
    26  s) Set configuration password
    27  q) Quit config
    28  n/s/q> n
    29  name> remote
    30  Type of storage to configure.
    31  Choose a number from below, or type in your own value
    32  [snip]
    33  XX / Pcloud
    34     \ "pcloud"
    35  [snip]
    36  Storage> pcloud
    37  Pcloud App Client Id - leave blank normally.
    38  client_id> 
    39  Pcloud App Client Secret - leave blank normally.
    40  client_secret> 
    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  [remote]
    54  client_id = 
    55  client_secret = 
    56  token = {"access_token":"XXX","token_type":"bearer","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  ```
    63  
    64  See the [remote setup docs](/remote_setup/) for how to set it up on a
    65  machine with no Internet browser available.
    66  
    67  Note that rclone runs a webserver on your local machine to collect the
    68  token as returned from pCloud. This only runs from the moment it opens
    69  your browser to the moment you get back the verification code.  This
    70  is on `http://127.0.0.1:53682/` and this it may require you to unblock
    71  it temporarily if you are running a host firewall.
    72  
    73  Once configured you can then use `rclone` like this,
    74  
    75  List directories in top level of your pCloud
    76  
    77      rclone lsd remote:
    78  
    79  List all the files in your pCloud
    80  
    81      rclone ls remote:
    82  
    83  To copy a local directory to an pCloud directory called backup
    84  
    85      rclone copy /home/source remote:backup
    86  
    87  ### Modified time and hashes ###
    88  
    89  pCloud allows modification times to be set on objects accurate to 1
    90  second.  These will be used to detect whether objects need syncing or
    91  not.  In order to set a Modification time pCloud requires the object
    92  be re-uploaded.
    93  
    94  pCloud supports MD5 and SHA1 type hashes, so you can use the
    95  `--checksum` flag.
    96  
    97  #### Restricted filename characters
    98  
    99  In addition to the [default restricted characters set](/overview/#restricted-characters)
   100  the following characters are also replaced:
   101  
   102  | Character | Value | Replacement |
   103  | --------- |:-----:|:-----------:|
   104  | \         | 0x5C  | \          |
   105  
   106  Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8),
   107  as they can't be used in JSON strings.
   108  
   109  ### Deleting files ###
   110  
   111  Deleted files will be moved to the trash.  Your subscription level
   112  will determine how long items stay in the trash.  `rclone cleanup` can
   113  be used to empty the trash.
   114  
   115  <!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/pcloud/pcloud.go then run make backenddocs -->
   116  ### Standard Options
   117  
   118  Here are the standard options specific to pcloud (Pcloud).
   119  
   120  #### --pcloud-client-id
   121  
   122  Pcloud App Client Id
   123  Leave blank normally.
   124  
   125  - Config:      client_id
   126  - Env Var:     RCLONE_PCLOUD_CLIENT_ID
   127  - Type:        string
   128  - Default:     ""
   129  
   130  #### --pcloud-client-secret
   131  
   132  Pcloud App Client Secret
   133  Leave blank normally.
   134  
   135  - Config:      client_secret
   136  - Env Var:     RCLONE_PCLOUD_CLIENT_SECRET
   137  - Type:        string
   138  - Default:     ""
   139  
   140  ### Advanced Options
   141  
   142  Here are the advanced options specific to pcloud (Pcloud).
   143  
   144  #### --pcloud-encoding
   145  
   146  This sets the encoding for the backend.
   147  
   148  See: the [encoding section in the overview](/overview/#encoding) for more info.
   149  
   150  - Config:      encoding
   151  - Env Var:     RCLONE_PCLOUD_ENCODING
   152  - Type:        MultiEncoder
   153  - Default:     Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot
   154  
   155  <!--- autogenerated options stop -->