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

     1  ---
     2  title: "premiumize.me"
     3  description: "Rclone docs for premiumize.me"
     4  versionIntroduced: "v1.49"
     5  ---
     6  
     7  # {{< icon "fa fa-user" >}} premiumize.me
     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 [premiumize.me](https://premiumize.me/) involves getting a token from premiumize.me 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  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 / premiumize.me
    36     \ "premiumizeme"
    37  [snip]
    38  Storage> premiumizeme
    39  ** See help for premiumizeme backend at: https://rclone.org/premiumizeme/ **
    40  
    41  Remote config
    42  Use web browser to automatically authenticate rclone with remote?
    43   * Say Y if the machine running rclone has a web browser you can use
    44   * Say N if running rclone on a (remote) machine without web browser access
    45  If not sure try Y. If Y failed, try N.
    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  [remote]
    55  type = premiumizeme
    56  token = {"access_token":"XXX","token_type":"Bearer","refresh_token":"XXX","expiry":"2029-08-07T18:44:15.548915378+01:00"}
    57  --------------------
    58  y) Yes this is OK
    59  e) Edit this remote
    60  d) Delete this remote
    61  y/e/d> 
    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 premiumize.me. 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 premiumize.me
    76  
    77      rclone lsd remote:
    78  
    79  List all the files in your premiumize.me
    80  
    81      rclone ls remote:
    82  
    83  To copy a local directory to an premiumize.me directory called backup
    84  
    85      rclone copy /home/source remote:backup
    86  
    87  ### Modification times and hashes
    88  
    89  premiumize.me does not support modification times or hashes, therefore
    90  syncing will default to `--size-only` checking.  Note that using
    91  `--update` will work.
    92  
    93  ### Restricted filename characters
    94  
    95  In addition to the [default restricted characters set](/overview/#restricted-characters)
    96  the following characters are also replaced:
    97  
    98  | Character | Value | Replacement |
    99  | --------- |:-----:|:-----------:|
   100  | \         | 0x5C  | ＼           |
   101  | "         | 0x22  | ＂           |
   102  
   103  Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8),
   104  as they can't be used in JSON strings.
   105  
   106  {{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/premiumizeme/premiumizeme.go then run make backenddocs" >}}
   107  ### Standard options
   108  
   109  Here are the Standard options specific to premiumizeme (premiumize.me).
   110  
   111  #### --premiumizeme-client-id
   112  
   113  OAuth Client Id.
   114  
   115  Leave blank normally.
   116  
   117  Properties:
   118  
   119  - Config:      client_id
   120  - Env Var:     RCLONE_PREMIUMIZEME_CLIENT_ID
   121  - Type:        string
   122  - Required:    false
   123  
   124  #### --premiumizeme-client-secret
   125  
   126  OAuth Client Secret.
   127  
   128  Leave blank normally.
   129  
   130  Properties:
   131  
   132  - Config:      client_secret
   133  - Env Var:     RCLONE_PREMIUMIZEME_CLIENT_SECRET
   134  - Type:        string
   135  - Required:    false
   136  
   137  #### --premiumizeme-api-key
   138  
   139  API Key.
   140  
   141  This is not normally used - use oauth instead.
   142  
   143  
   144  Properties:
   145  
   146  - Config:      api_key
   147  - Env Var:     RCLONE_PREMIUMIZEME_API_KEY
   148  - Type:        string
   149  - Required:    false
   150  
   151  ### Advanced options
   152  
   153  Here are the Advanced options specific to premiumizeme (premiumize.me).
   154  
   155  #### --premiumizeme-token
   156  
   157  OAuth Access Token as a JSON blob.
   158  
   159  Properties:
   160  
   161  - Config:      token
   162  - Env Var:     RCLONE_PREMIUMIZEME_TOKEN
   163  - Type:        string
   164  - Required:    false
   165  
   166  #### --premiumizeme-auth-url
   167  
   168  Auth server URL.
   169  
   170  Leave blank to use the provider defaults.
   171  
   172  Properties:
   173  
   174  - Config:      auth_url
   175  - Env Var:     RCLONE_PREMIUMIZEME_AUTH_URL
   176  - Type:        string
   177  - Required:    false
   178  
   179  #### --premiumizeme-token-url
   180  
   181  Token server url.
   182  
   183  Leave blank to use the provider defaults.
   184  
   185  Properties:
   186  
   187  - Config:      token_url
   188  - Env Var:     RCLONE_PREMIUMIZEME_TOKEN_URL
   189  - Type:        string
   190  - Required:    false
   191  
   192  #### --premiumizeme-encoding
   193  
   194  The encoding for the backend.
   195  
   196  See the [encoding section in the overview](/overview/#encoding) for more info.
   197  
   198  Properties:
   199  
   200  - Config:      encoding
   201  - Env Var:     RCLONE_PREMIUMIZEME_ENCODING
   202  - Type:        Encoding
   203  - Default:     Slash,DoubleQuote,BackSlash,Del,Ctl,InvalidUtf8,Dot
   204  
   205  #### --premiumizeme-description
   206  
   207  Description of the remote
   208  
   209  Properties:
   210  
   211  - Config:      description
   212  - Env Var:     RCLONE_PREMIUMIZEME_DESCRIPTION
   213  - Type:        string
   214  - Required:    false
   215  
   216  {{< rem autogenerated options stop >}}
   217  
   218  ## Limitations
   219  
   220  Note that premiumize.me is case insensitive so you can't have a file called
   221  "Hello.doc" and one called "hello.doc".
   222  
   223  premiumize.me file names can't have the `\` or `"` characters in.
   224  rclone maps these to and from an identical looking unicode equivalents
   225  `＼` and `＂`
   226  
   227  premiumize.me only supports filenames up to 255 characters in length.