github.com/artpar/rclone@v1.67.3/docs/content/filefabric.md (about) 1 --- 2 title: "Enterprise File Fabric" 3 description: "Rclone docs for the Enterprise File Fabric backend" 4 versionIntroduced: "v1.54" 5 --- 6 7 # {{< icon "fa fa-cloud" >}} Enterprise File Fabric 8 9 This backend supports [Storage Made Easy's Enterprise File 10 Fabricâ„¢](https://storagemadeeasy.com/about/) which provides a software 11 solution to integrate and unify File and Object Storage accessible 12 through a global file system. 13 14 ## Configuration 15 16 The initial setup for the Enterprise File Fabric backend involves 17 getting a token from the Enterprise File Fabric which you need to 18 do in your browser. `rclone config` walks you through it. 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 / Enterprise File Fabric 38 \ "filefabric" 39 [snip] 40 Storage> filefabric 41 ** See help for filefabric backend at: https://rclone.org/filefabric/ ** 42 43 URL of the Enterprise File Fabric to connect to 44 Enter a string value. Press Enter for the default (""). 45 Choose a number from below, or type in your own value 46 1 / Storage Made Easy US 47 \ "https://storagemadeeasy.com" 48 2 / Storage Made Easy EU 49 \ "https://eu.storagemadeeasy.com" 50 3 / Connect to your Enterprise File Fabric 51 \ "https://yourfabric.smestorage.com" 52 url> https://yourfabric.smestorage.com/ 53 ID of the root folder 54 Leave blank normally. 55 56 Fill in to make rclone start with directory of a given ID. 57 58 Enter a string value. Press Enter for the default (""). 59 root_folder_id> 60 Permanent Authentication Token 61 62 A Permanent Authentication Token can be created in the Enterprise File 63 Fabric, on the users Dashboard under Security, there is an entry 64 you'll see called "My Authentication Tokens". Click the Manage button 65 to create one. 66 67 These tokens are normally valid for several years. 68 69 For more info see: https://docs.storagemadeeasy.com/organisationcloud/api-tokens 70 71 Enter a string value. Press Enter for the default (""). 72 permanent_token> xxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxx 73 Edit advanced config? (y/n) 74 y) Yes 75 n) No (default) 76 y/n> n 77 Remote config 78 -------------------- 79 [remote] 80 type = filefabric 81 url = https://yourfabric.smestorage.com/ 82 permanent_token = xxxxxxxxxxxxxxx-xxxxxxxxxxxxxxxx 83 -------------------- 84 y) Yes this is OK (default) 85 e) Edit this remote 86 d) Delete this remote 87 y/e/d> y 88 ``` 89 90 Once configured you can then use `rclone` like this, 91 92 List directories in top level of your Enterprise File Fabric 93 94 rclone lsd remote: 95 96 List all the files in your Enterprise File Fabric 97 98 rclone ls remote: 99 100 To copy a local directory to an Enterprise File Fabric directory called backup 101 102 rclone copy /home/source remote:backup 103 104 ### Modification times and hashes 105 106 The Enterprise File Fabric allows modification times to be set on 107 files accurate to 1 second. These will be used to detect whether 108 objects need syncing or not. 109 110 The Enterprise File Fabric does not support any data hashes at this time. 111 112 ### Restricted filename characters 113 114 The [default restricted characters set](/overview/#restricted-characters) 115 will be replaced. 116 117 Invalid UTF-8 bytes will also be [replaced](/overview/#invalid-utf8), 118 as they can't be used in JSON strings. 119 120 ### Empty files 121 122 Empty files aren't supported by the Enterprise File Fabric. Rclone will therefore 123 upload an empty file as a single space with a mime type of 124 `application/vnd.rclone.empty.file` and files with that mime type are 125 treated as empty. 126 127 ### Root folder ID ### 128 129 You can set the `root_folder_id` for rclone. This is the directory 130 (identified by its `Folder ID`) that rclone considers to be the root 131 of your Enterprise File Fabric. 132 133 Normally you will leave this blank and rclone will determine the 134 correct root to use itself. 135 136 However you can set this to restrict rclone to a specific folder 137 hierarchy. 138 139 In order to do this you will have to find the `Folder ID` of the 140 directory you wish rclone to display. These aren't displayed in the 141 web interface, but you can use `rclone lsf` to find them, for example 142 143 ``` 144 $ rclone lsf --dirs-only -Fip --csv filefabric: 145 120673758,Burnt PDFs/ 146 120673759,My Quick Uploads/ 147 120673755,My Syncs/ 148 120673756,My backups/ 149 120673757,My contacts/ 150 120673761,S3 Storage/ 151 ``` 152 153 The ID for "S3 Storage" would be `120673761`. 154 155 {{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/filefabric/filefabric.go then run make backenddocs" >}} 156 ### Standard options 157 158 Here are the Standard options specific to filefabric (Enterprise File Fabric). 159 160 #### --filefabric-url 161 162 URL of the Enterprise File Fabric to connect to. 163 164 Properties: 165 166 - Config: url 167 - Env Var: RCLONE_FILEFABRIC_URL 168 - Type: string 169 - Required: true 170 - Examples: 171 - "https://storagemadeeasy.com" 172 - Storage Made Easy US 173 - "https://eu.storagemadeeasy.com" 174 - Storage Made Easy EU 175 - "https://yourfabric.smestorage.com" 176 - Connect to your Enterprise File Fabric 177 178 #### --filefabric-root-folder-id 179 180 ID of the root folder. 181 182 Leave blank normally. 183 184 Fill in to make rclone start with directory of a given ID. 185 186 187 Properties: 188 189 - Config: root_folder_id 190 - Env Var: RCLONE_FILEFABRIC_ROOT_FOLDER_ID 191 - Type: string 192 - Required: false 193 194 #### --filefabric-permanent-token 195 196 Permanent Authentication Token. 197 198 A Permanent Authentication Token can be created in the Enterprise File 199 Fabric, on the users Dashboard under Security, there is an entry 200 you'll see called "My Authentication Tokens". Click the Manage button 201 to create one. 202 203 These tokens are normally valid for several years. 204 205 For more info see: https://docs.storagemadeeasy.com/organisationcloud/api-tokens 206 207 208 Properties: 209 210 - Config: permanent_token 211 - Env Var: RCLONE_FILEFABRIC_PERMANENT_TOKEN 212 - Type: string 213 - Required: false 214 215 ### Advanced options 216 217 Here are the Advanced options specific to filefabric (Enterprise File Fabric). 218 219 #### --filefabric-token 220 221 Session Token. 222 223 This is a session token which rclone caches in the config file. It is 224 usually valid for 1 hour. 225 226 Don't set this value - rclone will set it automatically. 227 228 229 Properties: 230 231 - Config: token 232 - Env Var: RCLONE_FILEFABRIC_TOKEN 233 - Type: string 234 - Required: false 235 236 #### --filefabric-token-expiry 237 238 Token expiry time. 239 240 Don't set this value - rclone will set it automatically. 241 242 243 Properties: 244 245 - Config: token_expiry 246 - Env Var: RCLONE_FILEFABRIC_TOKEN_EXPIRY 247 - Type: string 248 - Required: false 249 250 #### --filefabric-version 251 252 Version read from the file fabric. 253 254 Don't set this value - rclone will set it automatically. 255 256 257 Properties: 258 259 - Config: version 260 - Env Var: RCLONE_FILEFABRIC_VERSION 261 - Type: string 262 - Required: false 263 264 #### --filefabric-encoding 265 266 The encoding for the backend. 267 268 See the [encoding section in the overview](/overview/#encoding) for more info. 269 270 Properties: 271 272 - Config: encoding 273 - Env Var: RCLONE_FILEFABRIC_ENCODING 274 - Type: Encoding 275 - Default: Slash,Del,Ctl,InvalidUtf8,Dot 276 277 #### --filefabric-description 278 279 Description of the remote 280 281 Properties: 282 283 - Config: description 284 - Env Var: RCLONE_FILEFABRIC_DESCRIPTION 285 - Type: string 286 - Required: false 287 288 {{< rem autogenerated options stop >}}