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

     1  ---
     2  title: "1Fichier"
     3  description: "Rclone docs for 1Fichier"
     4  ---
     5  
     6  {{< icon "fa fa-archive" >}} 1Fichier
     7  -----------------------------------------
     8  
     9  This is a backend for the [1fichier](https://1fichier.com) cloud
    10  storage service. Note that a Premium subscription is required to use
    11  the API.
    12  
    13  Paths are specified as `remote:path`
    14  
    15  Paths may be as deep as required, eg `remote:directory/subdirectory`.
    16  
    17  The initial setup for 1Fichier involves getting the API key from the website which you
    18  need to do in your browser.
    19  
    20  Here is an example of how to make a remote called `remote`.  First run:
    21  
    22       rclone config
    23  
    24  This will guide you through an interactive setup process:
    25  
    26  ```
    27  No remotes found - make a new one
    28  n) New remote
    29  s) Set configuration password
    30  q) Quit config
    31  n/s/q> n
    32  name> remote
    33  Type of storage to configure.
    34  Enter a string value. Press Enter for the default ("").
    35  Choose a number from below, or type in your own value
    36  [snip]
    37  XX / 1Fichier
    38     \ "fichier"
    39  [snip]
    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  #### Restricted filename characters
    90  
    91  In addition to the [default restricted characters set](/overview/#restricted-characters)
    92  the following characters are also replaced:
    93  
    94  | Character | Value | Replacement |
    95  | --------- |:-----:|:-----------:|
    96  | \         | 0x5C  | ＼           |
    97  | <         | 0x3C  | ＜           |
    98  | >         | 0x3E  | ＞           |
    99  | "         | 0x22  | ＂           |
   100  | $         | 0x24  | ＄           |
   101  | `         | 0x60  | ｀           |
   102  | '         | 0x27  | ＇           |
   103  
   104  File names can also not start or end with the following characters.
   105  These only get replaced if they are the first or last character in the
   106  name:
   107  
   108  | Character | Value | Replacement |
   109  | --------- |:-----:|:-----------:|
   110  | SP        | 0x20  | ␠           |
   111  
   112  Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8),
   113  as they can't be used in JSON strings.
   114  
   115  {{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/fichier/fichier.go then run make backenddocs" >}}
   116  ### Standard Options
   117  
   118  Here are the standard options specific to fichier (1Fichier).
   119  
   120  #### --fichier-api-key
   121  
   122  Your API Key, get it from https://1fichier.com/console/params.pl
   123  
   124  - Config:      api_key
   125  - Env Var:     RCLONE_FICHIER_API_KEY
   126  - Type:        string
   127  - Default:     ""
   128  
   129  ### Advanced Options
   130  
   131  Here are the advanced options specific to fichier (1Fichier).
   132  
   133  #### --fichier-shared-folder
   134  
   135  If you want to download a shared folder, add this parameter
   136  
   137  - Config:      shared_folder
   138  - Env Var:     RCLONE_FICHIER_SHARED_FOLDER
   139  - Type:        string
   140  - Default:     ""
   141  
   142  #### --fichier-encoding
   143  
   144  This sets the encoding for the backend.
   145  
   146  See: the [encoding section in the overview](/overview/#encoding) for more info.
   147  
   148  - Config:      encoding
   149  - Env Var:     RCLONE_FICHIER_ENCODING
   150  - Type:        MultiEncoder
   151  - Default:     Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot
   152  
   153  {{< rem autogenerated options stop >}}