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

     1  ---
     2  title: "premiumize.me"
     3  description: "Rclone docs for premiumize.me"
     4  ---
     5  
     6  {{< icon "fa fa-user" >}} premiumize.me
     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 [premiumize.me](https://premiumize.me/) involves getting a token from premiumize.me 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  Enter a string value. Press Enter for the default ("").
    31  Choose a number from below, or type in your own value
    32  [snip]
    33  XX / premiumize.me
    34     \ "premiumizeme"
    35  [snip]
    36  Storage> premiumizeme
    37  ** See help for premiumizeme backend at: https://rclone.org/premiumizeme/ **
    38  
    39  Remote config
    40  Use auto config?
    41   * Say Y if not sure
    42   * Say N if you are working on a remote or headless machine
    43  y) Yes
    44  n) No
    45  y/n> y
    46  If your browser doesn't open automatically go to the following link: http://127.0.0.1:53682/auth
    47  Log in and authorize rclone for access
    48  Waiting for code...
    49  Got code
    50  --------------------
    51  [remote]
    52  type = premiumizeme
    53  token = {"access_token":"XXX","token_type":"Bearer","refresh_token":"XXX","expiry":"2029-08-07T18:44:15.548915378+01:00"}
    54  --------------------
    55  y) Yes this is OK
    56  e) Edit this remote
    57  d) Delete this remote
    58  y/e/d> 
    59  ```
    60  
    61  See the [remote setup docs](/remote_setup/) for how to set it up on a
    62  machine with no Internet browser available.
    63  
    64  Note that rclone runs a webserver on your local machine to collect the
    65  token as returned from premiumize.me. This only runs from the moment it opens
    66  your browser to the moment you get back the verification code.  This
    67  is on `http://127.0.0.1:53682/` and this it may require you to unblock
    68  it temporarily if you are running a host firewall.
    69  
    70  Once configured you can then use `rclone` like this,
    71  
    72  List directories in top level of your premiumize.me
    73  
    74      rclone lsd remote:
    75  
    76  List all the files in your premiumize.me
    77  
    78      rclone ls remote:
    79  
    80  To copy a local directory to an premiumize.me directory called backup
    81  
    82      rclone copy /home/source remote:backup
    83  
    84  ### Modified time and hashes ###
    85  
    86  premiumize.me does not support modification times or hashes, therefore
    87  syncing will default to `--size-only` checking.  Note that using
    88  `--update` will work.
    89  
    90  #### Restricted filename characters
    91  
    92  In addition to the [default restricted characters set](/overview/#restricted-characters)
    93  the following characters are also replaced:
    94  
    95  | Character | Value | Replacement |
    96  | --------- |:-----:|:-----------:|
    97  | \         | 0x5C  | ＼           |
    98  | "         | 0x22  | ＂           |
    99  
   100  Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8),
   101  as they can't be used in JSON strings.
   102  
   103  {{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/premiumizeme/premiumizeme.go then run make backenddocs" >}}
   104  ### Standard Options
   105  
   106  Here are the standard options specific to premiumizeme (premiumize.me).
   107  
   108  #### --premiumizeme-api-key
   109  
   110  API Key.
   111  
   112  This is not normally used - use oauth instead.
   113  
   114  
   115  - Config:      api_key
   116  - Env Var:     RCLONE_PREMIUMIZEME_API_KEY
   117  - Type:        string
   118  - Default:     ""
   119  
   120  ### Advanced Options
   121  
   122  Here are the advanced options specific to premiumizeme (premiumize.me).
   123  
   124  #### --premiumizeme-encoding
   125  
   126  This sets the encoding for the backend.
   127  
   128  See: the [encoding section in the overview](/overview/#encoding) for more info.
   129  
   130  - Config:      encoding
   131  - Env Var:     RCLONE_PREMIUMIZEME_ENCODING
   132  - Type:        MultiEncoder
   133  - Default:     Slash,DoubleQuote,BackSlash,Del,Ctl,InvalidUtf8,Dot
   134  
   135  {{< rem autogenerated options stop >}}
   136  
   137  ### Limitations ###
   138  
   139  Note that premiumize.me is case insensitive so you can't have a file called
   140  "Hello.doc" and one called "hello.doc".
   141  
   142  premiumize.me file names can't have the `\` or `"` characters in.
   143  rclone maps these to and from an identical looking unicode equivalents
   144  `＼` and `＂`
   145  
   146  premiumize.me only supports filenames up to 255 characters in length.