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

     1  ---
     2  title: "pCloud"
     3  description: "Rclone docs for pCloud"
     4  versionIntroduced: "v1.39"
     5  ---
     6  
     7  # {{< icon "fa fa-cloud" >}} pCloud
     8  
     9  Paths are specified as `remote:path`
    10  
    11  Paths may be as deep as required, e.g. `remote:directory/subdirectory`.
    12  
    13  ## Configuration
    14  
    15  The initial setup for pCloud involves getting a token from pCloud which you
    16  need to do in your browser.  `rclone config` walks you 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> remote
    31  Type of storage to configure.
    32  Choose a number from below, or type in your own value
    33  [snip]
    34  XX / Pcloud
    35     \ "pcloud"
    36  [snip]
    37  Storage> pcloud
    38  Pcloud App Client Id - leave blank normally.
    39  client_id> 
    40  Pcloud App Client Secret - leave blank normally.
    41  client_secret> 
    42  Remote config
    43  Use web browser to automatically authenticate rclone with remote?
    44   * Say Y if the machine running rclone has a web browser you can use
    45   * Say N if running rclone on a (remote) machine without web browser access
    46  If not sure try Y. If Y failed, try N.
    47  y) Yes
    48  n) No
    49  y/n> y
    50  If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth
    51  Log in and authorize rclone for access
    52  Waiting for code...
    53  Got code
    54  --------------------
    55  [remote]
    56  client_id = 
    57  client_secret = 
    58  token = {"access_token":"XXX","token_type":"bearer","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  ```
    65  
    66  See the [remote setup docs](/remote_setup/) for how to set it up on a
    67  machine with no Internet browser available.
    68  
    69  Note that rclone runs a webserver on your local machine to collect the
    70  token as returned from pCloud. This only runs from the moment it opens
    71  your browser to the moment you get back the verification code.  This
    72  is on `http://127.0.0.1:53682/` and this it may require you to unblock
    73  it temporarily if you are running a host firewall.
    74  
    75  Once configured you can then use `rclone` like this,
    76  
    77  List directories in top level of your pCloud
    78  
    79      rclone lsd remote:
    80  
    81  List all the files in your pCloud
    82  
    83      rclone ls remote:
    84  
    85  To copy a local directory to a pCloud directory called backup
    86  
    87      rclone copy /home/source remote:backup
    88  
    89  ### Modification times and hashes
    90  
    91  pCloud allows modification times to be set on objects accurate to 1
    92  second.  These will be used to detect whether objects need syncing or
    93  not.  In order to set a Modification time pCloud requires the object
    94  be re-uploaded.
    95  
    96  pCloud supports MD5 and SHA1 hashes in the US region, and SHA1 and SHA256
    97  hashes in the EU region, so you can use the `--checksum` flag.
    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  ### Deleting files
   112  
   113  Deleted files will be moved to the trash.  Your subscription level
   114  will determine how long items stay in the trash.  `rclone cleanup` can
   115  be used to empty the trash.
   116  
   117  ### Emptying the trash
   118  
   119  Due to an API limitation, the `rclone cleanup` command will only work if you 
   120  set your username and password in the advanced options for this backend. 
   121  Since we generally want to avoid storing user passwords in the rclone config
   122  file, we advise you to only set this up if you need the `rclone cleanup` command to work.
   123  
   124  ### Root folder ID
   125  
   126  You can set the `root_folder_id` for rclone.  This is the directory
   127  (identified by its `Folder ID`) that rclone considers to be the root
   128  of your pCloud drive.
   129  
   130  Normally you will leave this blank and rclone will determine the
   131  correct root to use itself.
   132  
   133  However you can set this to restrict rclone to a specific folder
   134  hierarchy.
   135  
   136  In order to do this you will have to find the `Folder ID` of the
   137  directory you wish rclone to display.  This will be the `folder` field
   138  of the URL when you open the relevant folder in the pCloud web
   139  interface.
   140  
   141  So if the folder you want rclone to use has a URL which looks like
   142  `https://my.pcloud.com/#page=filemanager&folder=5xxxxxxxx8&tpl=foldergrid`
   143  in the browser, then you use `5xxxxxxxx8` as
   144  the `root_folder_id` in the config.
   145  
   146  {{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/pcloud/pcloud.go then run make backenddocs" >}}
   147  ### Standard options
   148  
   149  Here are the Standard options specific to pcloud (Pcloud).
   150  
   151  #### --pcloud-client-id
   152  
   153  OAuth Client Id.
   154  
   155  Leave blank normally.
   156  
   157  Properties:
   158  
   159  - Config:      client_id
   160  - Env Var:     RCLONE_PCLOUD_CLIENT_ID
   161  - Type:        string
   162  - Required:    false
   163  
   164  #### --pcloud-client-secret
   165  
   166  OAuth Client Secret.
   167  
   168  Leave blank normally.
   169  
   170  Properties:
   171  
   172  - Config:      client_secret
   173  - Env Var:     RCLONE_PCLOUD_CLIENT_SECRET
   174  - Type:        string
   175  - Required:    false
   176  
   177  ### Advanced options
   178  
   179  Here are the Advanced options specific to pcloud (Pcloud).
   180  
   181  #### --pcloud-token
   182  
   183  OAuth Access Token as a JSON blob.
   184  
   185  Properties:
   186  
   187  - Config:      token
   188  - Env Var:     RCLONE_PCLOUD_TOKEN
   189  - Type:        string
   190  - Required:    false
   191  
   192  #### --pcloud-auth-url
   193  
   194  Auth server URL.
   195  
   196  Leave blank to use the provider defaults.
   197  
   198  Properties:
   199  
   200  - Config:      auth_url
   201  - Env Var:     RCLONE_PCLOUD_AUTH_URL
   202  - Type:        string
   203  - Required:    false
   204  
   205  #### --pcloud-token-url
   206  
   207  Token server url.
   208  
   209  Leave blank to use the provider defaults.
   210  
   211  Properties:
   212  
   213  - Config:      token_url
   214  - Env Var:     RCLONE_PCLOUD_TOKEN_URL
   215  - Type:        string
   216  - Required:    false
   217  
   218  #### --pcloud-encoding
   219  
   220  The encoding for the backend.
   221  
   222  See the [encoding section in the overview](/overview/#encoding) for more info.
   223  
   224  Properties:
   225  
   226  - Config:      encoding
   227  - Env Var:     RCLONE_PCLOUD_ENCODING
   228  - Type:        Encoding
   229  - Default:     Slash,BackSlash,Del,Ctl,InvalidUtf8,Dot
   230  
   231  #### --pcloud-root-folder-id
   232  
   233  Fill in for rclone to use a non root folder as its starting point.
   234  
   235  Properties:
   236  
   237  - Config:      root_folder_id
   238  - Env Var:     RCLONE_PCLOUD_ROOT_FOLDER_ID
   239  - Type:        string
   240  - Default:     "d0"
   241  
   242  #### --pcloud-hostname
   243  
   244  Hostname to connect to.
   245  
   246  This is normally set when rclone initially does the oauth connection,
   247  however you will need to set it by hand if you are using remote config
   248  with rclone authorize.
   249  
   250  
   251  Properties:
   252  
   253  - Config:      hostname
   254  - Env Var:     RCLONE_PCLOUD_HOSTNAME
   255  - Type:        string
   256  - Default:     "api.pcloud.com"
   257  - Examples:
   258      - "api.pcloud.com"
   259          - Original/US region
   260      - "eapi.pcloud.com"
   261          - EU region
   262  
   263  #### --pcloud-username
   264  
   265  Your pcloud username.
   266  			
   267  This is only required when you want to use the cleanup command. Due to a bug
   268  in the pcloud API the required API does not support OAuth authentication so
   269  we have to rely on user password authentication for it.
   270  
   271  Properties:
   272  
   273  - Config:      username
   274  - Env Var:     RCLONE_PCLOUD_USERNAME
   275  - Type:        string
   276  - Required:    false
   277  
   278  #### --pcloud-password
   279  
   280  Your pcloud password.
   281  
   282  **NB** Input to this must be obscured - see [rclone obscure](/commands/rclone_obscure/).
   283  
   284  Properties:
   285  
   286  - Config:      password
   287  - Env Var:     RCLONE_PCLOUD_PASSWORD
   288  - Type:        string
   289  - Required:    false
   290  
   291  #### --pcloud-description
   292  
   293  Description of the remote
   294  
   295  Properties:
   296  
   297  - Config:      description
   298  - Env Var:     RCLONE_PCLOUD_DESCRIPTION
   299  - Type:        string
   300  - Required:    false
   301  
   302  {{< rem autogenerated options stop >}}