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

     1  ---
     2  title: "1Fichier"
     3  description: "Rclone docs for 1Fichier"
     4  date: "2015-10-14"
     5  ---
     6  
     7  <i class="fa fa-archive"></i> 1Fichier
     8  -----------------------------------------
     9  
    10  This is a backend for the [1ficher](https://1fichier.com) cloud
    11  storage service. Note that a Premium subscription is required to use
    12  the API.
    13  
    14  Paths are specified as `remote:path`
    15  
    16  Paths may be as deep as required, eg `remote:directory/subdirectory`.
    17  
    18  The initial setup for 1Fichier involves getting the API key from the website which you
    19  need to do in your browser.
    20  
    21  Here is an example of how to make a remote called `remote`.  First run:
    22  
    23       rclone config
    24  
    25  This will guide you through an interactive setup process:
    26  
    27  ```
    28  No remotes found - make a new one
    29  n) New remote
    30  s) Set configuration password
    31  q) Quit config
    32  n/s/q> n
    33  name> remote
    34  Type of storage to configure.
    35  Enter a string value. Press Enter for the default ("").
    36  Choose a number from below, or type in your own value
    37  [snip]
    38  XX / 1Fichier
    39     \ "fichier"
    40  [snip]
    41  Storage> fichier
    42  ** See help for fichier backend at: https://rclone.org/fichier/ **
    43  
    44  Your API Key, get it from https://1fichier.com/console/params.pl
    45  Enter a string value. Press Enter for the default ("").
    46  api_key> example_key
    47  
    48  Edit advanced config? (y/n)
    49  y) Yes
    50  n) No
    51  y/n> 
    52  Remote config
    53  --------------------
    54  [remote]
    55  type = fichier
    56  api_key = example_key
    57  --------------------
    58  y) Yes this is OK
    59  e) Edit this remote
    60  d) Delete this remote
    61  y/e/d> y
    62  ```
    63  
    64  Once configured you can then use `rclone` like this,
    65  
    66  List directories in top level of your 1Fichier account
    67  
    68      rclone lsd remote:
    69  
    70  List all the files in your 1Fichier account
    71  
    72      rclone ls remote:
    73  
    74  To copy a local directory to a 1Fichier directory called backup
    75  
    76      rclone copy /home/source remote:backup
    77  
    78  ### Modified time and hashes ###
    79  
    80  1Fichier does not support modification times. It supports the Whirlpool hash algorithm.
    81  
    82  ### Duplicated files ###
    83  
    84  1Fichier can have two files with exactly the same name and path (unlike a
    85  normal file system).
    86  
    87  Duplicated files cause problems with the syncing and you will see
    88  messages in the log about duplicates.
    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  | <         | 0x3C  | ＜           |
    99  | >         | 0x3E  | ＞           |
   100  | "         | 0x22  | ＂           |
   101  | $         | 0x24  | ＄           |
   102  | `         | 0x60  | ｀           |
   103  | '         | 0x27  | ＇           |
   104  
   105  File names can also not start or end with the following characters.
   106  These only get replaced if they are first or last character in the
   107  name:
   108  
   109  | Character | Value | Replacement |
   110  | --------- |:-----:|:-----------:|
   111  | SP        | 0x20  | ␠           |
   112  
   113  Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8),
   114  as they can't be used in JSON strings.
   115  
   116  <!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/fichier/fichier.go then run make backenddocs -->
   117  ### Standard Options
   118  
   119  Here are the standard options specific to fichier (1Fichier).
   120  
   121  #### --fichier-api-key
   122  
   123  Your API Key, get it from https://1fichier.com/console/params.pl
   124  
   125  - Config:      api_key
   126  - Env Var:     RCLONE_FICHIER_API_KEY
   127  - Type:        string
   128  - Default:     ""
   129  
   130  ### Advanced Options
   131  
   132  Here are the advanced options specific to fichier (1Fichier).
   133  
   134  #### --fichier-shared-folder
   135  
   136  If you want to download a shared folder, add this parameter
   137  
   138  - Config:      shared_folder
   139  - Env Var:     RCLONE_FICHIER_SHARED_FOLDER
   140  - Type:        string
   141  - Default:     ""
   142  
   143  #### --fichier-encoding
   144  
   145  This sets the encoding for the backend.
   146  
   147  See: the [encoding section in the overview](/overview/#encoding) for more info.
   148  
   149  - Config:      encoding
   150  - Env Var:     RCLONE_FICHIER_ENCODING
   151  - Type:        MultiEncoder
   152  - Default:     Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot
   153  
   154  <!--- autogenerated options stop -->