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

     1  ---
     2  title: "pCloud"
     3  description: "Rclone docs for pCloud"
     4  ---
     5  
     6  {{< icon "fa fa-cloud" >}} pCloud
     7  -----------------------------------------
     8  
     9  Paths are specified as `remote:path`
    10  
    11  Paths may be as deep as required, eg `remote:directory/subdirectory`.
    12  
    13  The initial setup for pCloud involves getting a token from pCloud which you
    14  need to do in your browser.  `rclone config` walks you through it.
    15  
    16  Here is an example of how to make a remote called `remote`.  First run:
    17  
    18       rclone config
    19  
    20  This will guide you through an interactive setup process:
    21  
    22  ```
    23  No remotes found - make a new one
    24  n) New remote
    25  s) Set configuration password
    26  q) Quit config
    27  n/s/q> n
    28  name> remote
    29  Type of storage to configure.
    30  Choose a number from below, or type in your own value
    31  [snip]
    32  XX / Pcloud
    33     \ "pcloud"
    34  [snip]
    35  Storage> pcloud
    36  Pcloud App Client Id - leave blank normally.
    37  client_id> 
    38  Pcloud App Client Secret - leave blank normally.
    39  client_secret> 
    40  Remote config
    41  Use auto config?
    42   * Say Y if not sure
    43   * Say N if you are working on a remote or headless machine
    44  y) Yes
    45  n) No
    46  y/n> y
    47  If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth
    48  Log in and authorize rclone for access
    49  Waiting for code...
    50  Got code
    51  --------------------
    52  [remote]
    53  client_id = 
    54  client_secret = 
    55  token = {"access_token":"XXX","token_type":"bearer","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  ```
    62  
    63  See the [remote setup docs](/remote_setup/) for how to set it up on a
    64  machine with no Internet browser available.
    65  
    66  Note that rclone runs a webserver on your local machine to collect the
    67  token as returned from pCloud. This only runs from the moment it opens
    68  your browser to the moment you get back the verification code.  This
    69  is on `http://127.0.0.1:53682/` and this it may require you to unblock
    70  it temporarily if you are running a host firewall.
    71  
    72  Once configured you can then use `rclone` like this,
    73  
    74  List directories in top level of your pCloud
    75  
    76      rclone lsd remote:
    77  
    78  List all the files in your pCloud
    79  
    80      rclone ls remote:
    81  
    82  To copy a local directory to an pCloud directory called backup
    83  
    84      rclone copy /home/source remote:backup
    85  
    86  ### Modified time and hashes ###
    87  
    88  pCloud allows modification times to be set on objects accurate to 1
    89  second.  These will be used to detect whether objects need syncing or
    90  not.  In order to set a Modification time pCloud requires the object
    91  be re-uploaded.
    92  
    93  pCloud supports MD5 and SHA1 type hashes, so you can use the
    94  `--checksum` flag.
    95  
    96  #### Restricted filename characters
    97  
    98  In addition to the [default restricted characters set](/overview/#restricted-characters)
    99  the following characters are also replaced:
   100  
   101  | Character | Value | Replacement |
   102  | --------- |:-----:|:-----------:|
   103  | \         | 0x5C  | ＼          |
   104  
   105  Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8),
   106  as they can't be used in JSON strings.
   107  
   108  ### Deleting files ###
   109  
   110  Deleted files will be moved to the trash.  Your subscription level
   111  will determine how long items stay in the trash.  `rclone cleanup` can
   112  be used to empty the trash.
   113  
   114  ### Root folder ID ###
   115  
   116  You can set the `root_folder_id` for rclone.  This is the directory
   117  (identified by its `Folder ID`) that rclone considers to be the root
   118  of your pCloud drive.
   119  
   120  Normally you will leave this blank and rclone will determine the
   121  correct root to use itself.
   122  
   123  However you can set this to restrict rclone to a specific folder
   124  hierarchy.
   125  
   126  In order to do this you will have to find the `Folder ID` of the
   127  directory you wish rclone to display.  This will be the `folder` field
   128  of the URL when you open the relevant folder in the pCloud web
   129  interface.
   130  
   131  So if the folder you want rclone to use has a URL which looks like
   132  `https://my.pcloud.com/#page=filemanager&folder=5xxxxxxxx8&tpl=foldergrid`
   133  in the browser, then you use `5xxxxxxxx8` as
   134  the `root_folder_id` in the config.
   135  
   136  {{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/pcloud/pcloud.go then run make backenddocs" >}}
   137  ### Standard Options
   138  
   139  Here are the standard options specific to pcloud (Pcloud).
   140  
   141  #### --pcloud-client-id
   142  
   143  Pcloud App Client Id
   144  Leave blank normally.
   145  
   146  - Config:      client_id
   147  - Env Var:     RCLONE_PCLOUD_CLIENT_ID
   148  - Type:        string
   149  - Default:     ""
   150  
   151  #### --pcloud-client-secret
   152  
   153  Pcloud App Client Secret
   154  Leave blank normally.
   155  
   156  - Config:      client_secret
   157  - Env Var:     RCLONE_PCLOUD_CLIENT_SECRET
   158  - Type:        string
   159  - Default:     ""
   160  
   161  ### Advanced Options
   162  
   163  Here are the advanced options specific to pcloud (Pcloud).
   164  
   165  #### --pcloud-encoding
   166  
   167  This sets the encoding for the backend.
   168  
   169  See: the [encoding section in the overview](/overview/#encoding) for more info.
   170  
   171  - Config:      encoding
   172  - Env Var:     RCLONE_PCLOUD_ENCODING
   173  - Type:        MultiEncoder
   174  - Default:     Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot
   175  
   176  #### --pcloud-root-folder-id
   177  
   178  Fill in for rclone to use a non root folder as its starting point.
   179  
   180  - Config:      root_folder_id
   181  - Env Var:     RCLONE_PCLOUD_ROOT_FOLDER_ID
   182  - Type:        string
   183  - Default:     "d0"
   184  
   185  {{< rem autogenerated options stop >}}