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

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