github.com/rclone/rclone@v1.66.1-0.20240517100346-7b89735ae726/docs/content/fichier.md (about)

     1  ---
     2  title: "1Fichier"
     3  description: "Rclone docs for 1Fichier"
     4  versionIntroduced: "v1.49"
     5  ---
     6  
     7  # {{< icon "fa fa-archive" >}} 1Fichier
     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, e.g. `remote:directory/subdirectory`.
    16  
    17  ## Configuration
    18  
    19  The initial setup for 1Fichier involves getting the API key from the website which you
    20  need to do in your browser.
    21  
    22  Here is an example of how to make a remote called `remote`.  First run:
    23  
    24       rclone config
    25  
    26  This will guide you through an interactive setup process:
    27  
    28  ```
    29  No remotes found, make a new one?
    30  n) New remote
    31  s) Set configuration password
    32  q) Quit config
    33  n/s/q> n
    34  name> remote
    35  Type of storage to configure.
    36  Enter a string value. Press Enter for the default ("").
    37  Choose a number from below, or type in your own value
    38  [snip]
    39  XX / 1Fichier
    40     \ "fichier"
    41  [snip]
    42  Storage> fichier
    43  ** See help for fichier backend at: https://rclone.org/fichier/ **
    44  
    45  Your API Key, get it from https://1fichier.com/console/params.pl
    46  Enter a string value. Press Enter for the default ("").
    47  api_key> example_key
    48  
    49  Edit advanced config? (y/n)
    50  y) Yes
    51  n) No
    52  y/n> 
    53  Remote config
    54  --------------------
    55  [remote]
    56  type = fichier
    57  api_key = example_key
    58  --------------------
    59  y) Yes this is OK
    60  e) Edit this remote
    61  d) Delete this remote
    62  y/e/d> y
    63  ```
    64  
    65  Once configured you can then use `rclone` like this,
    66  
    67  List directories in top level of your 1Fichier account
    68  
    69      rclone lsd remote:
    70  
    71  List all the files in your 1Fichier account
    72  
    73      rclone ls remote:
    74  
    75  To copy a local directory to a 1Fichier directory called backup
    76  
    77      rclone copy /home/source remote:backup
    78  
    79  ### Modification times and hashes
    80  
    81  1Fichier does not support modification times. It supports the Whirlpool hash algorithm.
    82  
    83  ### Duplicated files
    84  
    85  1Fichier can have two files with exactly the same name and path (unlike a
    86  normal file system).
    87  
    88  Duplicated files cause problems with the syncing and you will see
    89  messages in the log about duplicates.
    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  | <         | 0x3C  | <           |
   100  | >         | 0x3E  | >           |
   101  | "         | 0x22  | "           |
   102  | $         | 0x24  | $           |
   103  | `         | 0x60  | `           |
   104  | '         | 0x27  | '           |
   105  
   106  File names can also not start or end with the following characters.
   107  These only get replaced if they are the first or last character in the
   108  name:
   109  
   110  | Character | Value | Replacement |
   111  | --------- |:-----:|:-----------:|
   112  | SP        | 0x20  | ␠           |
   113  
   114  Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8),
   115  as they can't be used in JSON strings.
   116  
   117  {{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/fichier/fichier.go then run make backenddocs" >}}
   118  ### Standard options
   119  
   120  Here are the Standard options specific to fichier (1Fichier).
   121  
   122  #### --fichier-api-key
   123  
   124  Your API Key, get it from https://1fichier.com/console/params.pl.
   125  
   126  Properties:
   127  
   128  - Config:      api_key
   129  - Env Var:     RCLONE_FICHIER_API_KEY
   130  - Type:        string
   131  - Required:    false
   132  
   133  ### Advanced options
   134  
   135  Here are the Advanced options specific to fichier (1Fichier).
   136  
   137  #### --fichier-shared-folder
   138  
   139  If you want to download a shared folder, add this parameter.
   140  
   141  Properties:
   142  
   143  - Config:      shared_folder
   144  - Env Var:     RCLONE_FICHIER_SHARED_FOLDER
   145  - Type:        string
   146  - Required:    false
   147  
   148  #### --fichier-file-password
   149  
   150  If you want to download a shared file that is password protected, add this parameter.
   151  
   152  **NB** Input to this must be obscured - see [rclone obscure](/commands/rclone_obscure/).
   153  
   154  Properties:
   155  
   156  - Config:      file_password
   157  - Env Var:     RCLONE_FICHIER_FILE_PASSWORD
   158  - Type:        string
   159  - Required:    false
   160  
   161  #### --fichier-folder-password
   162  
   163  If you want to list the files in a shared folder that is password protected, add this parameter.
   164  
   165  **NB** Input to this must be obscured - see [rclone obscure](/commands/rclone_obscure/).
   166  
   167  Properties:
   168  
   169  - Config:      folder_password
   170  - Env Var:     RCLONE_FICHIER_FOLDER_PASSWORD
   171  - Type:        string
   172  - Required:    false
   173  
   174  #### --fichier-cdn
   175  
   176  Set if you wish to use CDN download links.
   177  
   178  Properties:
   179  
   180  - Config:      cdn
   181  - Env Var:     RCLONE_FICHIER_CDN
   182  - Type:        bool
   183  - Default:     false
   184  
   185  #### --fichier-encoding
   186  
   187  The encoding for the backend.
   188  
   189  See the [encoding section in the overview](/overview/#encoding) for more info.
   190  
   191  Properties:
   192  
   193  - Config:      encoding
   194  - Env Var:     RCLONE_FICHIER_ENCODING
   195  - Type:        Encoding
   196  - Default:     Slash,LtGt,DoubleQuote,SingleQuote,BackQuote,Dollar,BackSlash,Del,Ctl,LeftSpace,RightSpace,InvalidUtf8,Dot
   197  
   198  #### --fichier-description
   199  
   200  Description of the remote
   201  
   202  Properties:
   203  
   204  - Config:      description
   205  - Env Var:     RCLONE_FICHIER_DESCRIPTION
   206  - Type:        string
   207  - Required:    false
   208  
   209  {{< rem autogenerated options stop >}}
   210  
   211  ## Limitations
   212  
   213  `rclone about` is not supported by the 1Fichier backend. Backends without
   214  this capability cannot determine free space for an rclone mount or
   215  use policy `mfs` (most free space) as a member of an rclone union
   216  remote.
   217  
   218  See [List of backends that do not support rclone about](https://rclone.org/overview/#optional-features) and [rclone about](https://rclone.org/commands/rclone_about/)
   219