github.com/ncw/rclone@v1.48.1-0.20190724201158-a35aa1360e3e/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    1 / 1Fichier
    38      \ "fichier"
    39  ...
    40  Storage> fichier
    41  ** See help for fichier backend at: https://rclone.org/fichier/ **
    42  
    43  Your API Key, get it from https://1fichier.com/console/params.pl
    44  Enter a string value. Press Enter for the default ("").
    45  api_key> example_key
    46  
    47  Edit advanced config? (y/n)
    48  y) Yes
    49  n) No
    50  y/n> 
    51  Remote config
    52  --------------------
    53  [remote]
    54  type = fichier
    55  api_key = example_key
    56  --------------------
    57  y) Yes this is OK
    58  e) Edit this remote
    59  d) Delete this remote
    60  y/e/d> y
    61  ```
    62  
    63  Once configured you can then use `rclone` like this,
    64  
    65  List directories in top level of your 1Fichier account
    66  
    67      rclone lsd remote:
    68  
    69  List all the files in your 1Fichier account
    70  
    71      rclone ls remote:
    72  
    73  To copy a local directory to a 1Fichier directory called backup
    74  
    75      rclone copy /home/source remote:backup
    76  
    77  ### Modified time and hashes ###
    78  
    79  1Fichier does not support modification times. It supports the Whirlpool hash algorithm.
    80  
    81  ### Duplicated files ###
    82  
    83  1Fichier can have two files with exactly the same name and path (unlike a
    84  normal file system).
    85  
    86  Duplicated files cause problems with the syncing and you will see
    87  messages in the log about duplicates.
    88  
    89  ### Forbidden characters ###
    90  
    91  1Fichier does not support the characters ``\ < > " ' ` $`` and spaces at the beginning of folder names.
    92  `rclone` automatically escapes these to a unicode equivalent. The exception is `/`, 
    93  which cannot be escaped and will therefore lead to errors.
    94  
    95  <!--- autogenerated options start - DO NOT EDIT, instead edit fs.RegInfo in backend/fichier/fichier.go then run make backenddocs -->
    96  ### Standard Options
    97  
    98  Here are the standard options specific to fichier (1Fichier).
    99  
   100  #### --fichier-api-key
   101  
   102  Your API Key, get it from https://1fichier.com/console/params.pl
   103  
   104  - Config:      api_key
   105  - Env Var:     RCLONE_FICHIER_API_KEY
   106  - Type:        string
   107  - Default:     ""
   108  
   109  ### Advanced Options
   110  
   111  Here are the advanced options specific to fichier (1Fichier).
   112  
   113  #### --fichier-shared-folder
   114  
   115  If you want to download a shared folder, add this parameter
   116  
   117  - Config:      shared_folder
   118  - Env Var:     RCLONE_FICHIER_SHARED_FOLDER
   119  - Type:        string
   120  - Default:     ""
   121  
   122  <!--- autogenerated options stop -->