You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

1425 lines
33 KiB

  1. <!doctype html>
  2. <html lang="en" class="no-js">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width,initial-scale=1">
  6. <meta name="description" content="mergerfs - a featureful union filesystem">
  7. <link rel="canonical" href="https://trapexit.github.io/mergerfs/">
  8. <link rel="next" href="quickstart/">
  9. <link rel="icon" href="assets/images/favicon.png">
  10. <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.49">
  11. <title>mergerfs</title>
  12. <link rel="stylesheet" href="assets/stylesheets/main.6f8fc17f.min.css">
  13. <link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
  14. <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
  15. <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
  16. <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
  17. <script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
  18. </head>
  19. <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo">
  20. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  21. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  22. <label class="md-overlay" for="__drawer"></label>
  23. <div data-md-component="skip">
  24. <a href="#mergerfs-a-featureful-union-filesystem" class="md-skip">
  25. Skip to content
  26. </a>
  27. </div>
  28. <div data-md-component="announce">
  29. </div>
  30. <header class="md-header md-header--shadow" data-md-component="header">
  31. <nav class="md-header__inner md-grid" aria-label="Header">
  32. <a href="." title="mergerfs" class="md-header__button md-logo" aria-label="mergerfs" data-md-component="logo">
  33. <img src="logo.jpeg" alt="logo">
  34. </a>
  35. <label class="md-header__button md-icon" for="__drawer">
  36. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
  37. </label>
  38. <div class="md-header__title" data-md-component="header-title">
  39. <div class="md-header__ellipsis">
  40. <div class="md-header__topic">
  41. <span class="md-ellipsis">
  42. mergerfs
  43. </span>
  44. </div>
  45. <div class="md-header__topic" data-md-component="header-topic">
  46. <span class="md-ellipsis">
  47. Home
  48. </span>
  49. </div>
  50. </div>
  51. </div>
  52. <form class="md-header__option" data-md-component="palette">
  53. <input class="md-option" data-md-color-media="(prefers-color-scheme)" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_0">
  54. <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
  55. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m14.3 16-.7-2h-3.2l-.7 2H7.8L11 7h2l3.2 9zM20 8.69V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12zm-9.15 3.96h2.3L12 9z"/></svg>
  56. </label>
  57. <input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">
  58. <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_2" hidden>
  59. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
  60. </label>
  61. <input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to system preference" type="radio" name="__palette" id="__palette_2">
  62. <label class="md-header__button md-icon" title="Switch to system preference" for="__palette_0" hidden>
  63. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12s-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
  64. </label>
  65. </form>
  66. <script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
  67. <label class="md-header__button md-icon" for="__search">
  68. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
  69. </label>
  70. <div class="md-search" data-md-component="search" role="dialog">
  71. <label class="md-search__overlay" for="__search"></label>
  72. <div class="md-search__inner" role="search">
  73. <form class="md-search__form" name="search">
  74. <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
  75. <label class="md-search__icon md-icon" for="__search">
  76. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
  77. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
  78. </label>
  79. <nav class="md-search__options" aria-label="Search">
  80. <a href="javascript:void(0)" class="md-search__icon md-icon" title="Share" aria-label="Share" data-clipboard data-clipboard-text="" data-md-component="search-share" tabindex="-1">
  81. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18 16.08c-.76 0-1.44.3-1.96.77L8.91 12.7c.05-.23.09-.46.09-.7s-.04-.47-.09-.7l7.05-4.11c.54.5 1.25.81 2.04.81a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3c0 .24.04.47.09.7L8.04 9.81C7.5 9.31 6.79 9 6 9a3 3 0 0 0-3 3 3 3 0 0 0 3 3c.79 0 1.5-.31 2.04-.81l7.12 4.15c-.05.21-.08.43-.08.66 0 1.61 1.31 2.91 2.92 2.91s2.92-1.3 2.92-2.91A2.92 2.92 0 0 0 18 16.08"/></svg>
  82. </a>
  83. <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
  84. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
  85. </button>
  86. </nav>
  87. </form>
  88. <div class="md-search__output">
  89. <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
  90. <div class="md-search-result" data-md-component="search-result">
  91. <div class="md-search-result__meta">
  92. Initializing search
  93. </div>
  94. <ol class="md-search-result__list" role="presentation"></ol>
  95. </div>
  96. </div>
  97. </div>
  98. </div>
  99. </div>
  100. <div class="md-header__source">
  101. <a href="https://github.com/trapexit/mergerfs" title="Go to repository" class="md-source" data-md-component="source">
  102. <div class="md-source__icon md-icon">
  103. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.7.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"/></svg>
  104. </div>
  105. <div class="md-source__repository">
  106. mergerfs
  107. </div>
  108. </a>
  109. </div>
  110. </nav>
  111. </header>
  112. <div class="md-container" data-md-component="container">
  113. <main class="md-main" data-md-component="main">
  114. <div class="md-main__inner md-grid">
  115. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  116. <div class="md-sidebar__scrollwrap">
  117. <div class="md-sidebar__inner">
  118. <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
  119. <label class="md-nav__title" for="__drawer">
  120. <a href="." title="mergerfs" class="md-nav__button md-logo" aria-label="mergerfs" data-md-component="logo">
  121. <img src="logo.jpeg" alt="logo">
  122. </a>
  123. mergerfs
  124. </label>
  125. <div class="md-nav__source">
  126. <a href="https://github.com/trapexit/mergerfs" title="Go to repository" class="md-source" data-md-component="source">
  127. <div class="md-source__icon md-icon">
  128. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.7.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"/></svg>
  129. </div>
  130. <div class="md-source__repository">
  131. mergerfs
  132. </div>
  133. </a>
  134. </div>
  135. <ul class="md-nav__list" data-md-scrollfix>
  136. <li class="md-nav__item md-nav__item--active">
  137. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  138. <label class="md-nav__link md-nav__link--active" for="__toc">
  139. <span class="md-ellipsis">
  140. Home
  141. </span>
  142. <span class="md-nav__icon md-icon"></span>
  143. </label>
  144. <a href="." class="md-nav__link md-nav__link--active">
  145. <span class="md-ellipsis">
  146. Home
  147. </span>
  148. </a>
  149. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  150. <label class="md-nav__title" for="__toc">
  151. <span class="md-nav__icon md-icon"></span>
  152. Table of contents
  153. </label>
  154. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  155. <li class="md-nav__item">
  156. <a href="#features" class="md-nav__link">
  157. <span class="md-ellipsis">
  158. Features
  159. </span>
  160. </a>
  161. </li>
  162. <li class="md-nav__item">
  163. <a href="#non-features" class="md-nav__link">
  164. <span class="md-ellipsis">
  165. Non-features
  166. </span>
  167. </a>
  168. </li>
  169. <li class="md-nav__item">
  170. <a href="#how-it-works" class="md-nav__link">
  171. <span class="md-ellipsis">
  172. How it works
  173. </span>
  174. </a>
  175. <nav class="md-nav" aria-label="How it works">
  176. <ul class="md-nav__list">
  177. <li class="md-nav__item">
  178. <a href="#visualization" class="md-nav__link">
  179. <span class="md-ellipsis">
  180. Visualization
  181. </span>
  182. </a>
  183. </li>
  184. </ul>
  185. </nav>
  186. </li>
  187. </ul>
  188. </nav>
  189. </li>
  190. <li class="md-nav__item">
  191. <a href="quickstart/" class="md-nav__link">
  192. <span class="md-ellipsis">
  193. QuickStart
  194. </span>
  195. </a>
  196. </li>
  197. <li class="md-nav__item md-nav__item--nested">
  198. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
  199. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
  200. <span class="md-ellipsis">
  201. Installation
  202. </span>
  203. <span class="md-nav__icon md-icon"></span>
  204. </label>
  205. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
  206. <label class="md-nav__title" for="__nav_3">
  207. <span class="md-nav__icon md-icon"></span>
  208. Installation
  209. </label>
  210. <ul class="md-nav__list" data-md-scrollfix>
  211. <li class="md-nav__item">
  212. <a href="setup/installation/" class="md-nav__link">
  213. <span class="md-ellipsis">
  214. Installation
  215. </span>
  216. </a>
  217. </li>
  218. <li class="md-nav__item">
  219. <a href="setup/upgrade/" class="md-nav__link">
  220. <span class="md-ellipsis">
  221. Upgrade
  222. </span>
  223. </a>
  224. </li>
  225. <li class="md-nav__item">
  226. <a href="setup/build/" class="md-nav__link">
  227. <span class="md-ellipsis">
  228. Build
  229. </span>
  230. </a>
  231. </li>
  232. </ul>
  233. </nav>
  234. </li>
  235. <li class="md-nav__item md-nav__item--nested">
  236. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
  237. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
  238. <span class="md-ellipsis">
  239. Config
  240. </span>
  241. <span class="md-nav__icon md-icon"></span>
  242. </label>
  243. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
  244. <label class="md-nav__title" for="__nav_4">
  245. <span class="md-nav__icon md-icon"></span>
  246. Config
  247. </label>
  248. <ul class="md-nav__list" data-md-scrollfix>
  249. <li class="md-nav__item">
  250. <a href="config/terminology/" class="md-nav__link">
  251. <span class="md-ellipsis">
  252. Terminology
  253. </span>
  254. </a>
  255. </li>
  256. <li class="md-nav__item">
  257. <a href="config/options/" class="md-nav__link">
  258. <span class="md-ellipsis">
  259. Options
  260. </span>
  261. </a>
  262. </li>
  263. <li class="md-nav__item">
  264. <a href="config/deprecated_options/" class="md-nav__link">
  265. <span class="md-ellipsis">
  266. Deprecated Options
  267. </span>
  268. </a>
  269. </li>
  270. <li class="md-nav__item">
  271. <a href="config/branches/" class="md-nav__link">
  272. <span class="md-ellipsis">
  273. branches
  274. </span>
  275. </a>
  276. </li>
  277. <li class="md-nav__item">
  278. <a href="config/functions_categories_and_policies/" class="md-nav__link">
  279. <span class="md-ellipsis">
  280. functions, categories and policies
  281. </span>
  282. </a>
  283. </li>
  284. <li class="md-nav__item">
  285. <a href="config/func_readdir/" class="md-nav__link">
  286. <span class="md-ellipsis">
  287. func.readdir
  288. </span>
  289. </a>
  290. </li>
  291. <li class="md-nav__item">
  292. <a href="config/cache/" class="md-nav__link">
  293. <span class="md-ellipsis">
  294. caching
  295. </span>
  296. </a>
  297. </li>
  298. <li class="md-nav__item">
  299. <a href="config/ioctl/" class="md-nav__link">
  300. <span class="md-ellipsis">
  301. ioctl
  302. </span>
  303. </a>
  304. </li>
  305. <li class="md-nav__item">
  306. <a href="config/rename_and_link/" class="md-nav__link">
  307. <span class="md-ellipsis">
  308. rename and link
  309. </span>
  310. </a>
  311. </li>
  312. <li class="md-nav__item">
  313. <a href="config/statfs/" class="md-nav__link">
  314. <span class="md-ellipsis">
  315. statfs / statvfs
  316. </span>
  317. </a>
  318. </li>
  319. <li class="md-nav__item">
  320. <a href="config/flush-on-close/" class="md-nav__link">
  321. <span class="md-ellipsis">
  322. flush-on-close
  323. </span>
  324. </a>
  325. </li>
  326. </ul>
  327. </nav>
  328. </li>
  329. <li class="md-nav__item">
  330. <a href="error_handling/" class="md-nav__link">
  331. <span class="md-ellipsis">
  332. Error Handling
  333. </span>
  334. </a>
  335. </li>
  336. <li class="md-nav__item">
  337. <a href="runtime_interfaces/" class="md-nav__link">
  338. <span class="md-ellipsis">
  339. Runtime Interfaces
  340. </span>
  341. </a>
  342. </li>
  343. <li class="md-nav__item">
  344. <a href="remote_filesystems/" class="md-nav__link">
  345. <span class="md-ellipsis">
  346. Remote Filesystems
  347. </span>
  348. </a>
  349. </li>
  350. <li class="md-nav__item">
  351. <a href="tips_notes/" class="md-nav__link">
  352. <span class="md-ellipsis">
  353. Tips and Notes
  354. </span>
  355. </a>
  356. </li>
  357. <li class="md-nav__item">
  358. <a href="known_issues_bugs/" class="md-nav__link">
  359. <span class="md-ellipsis">
  360. Known Issues and Bugs
  361. </span>
  362. </a>
  363. </li>
  364. <li class="md-nav__item">
  365. <a href="project_comparisons/" class="md-nav__link">
  366. <span class="md-ellipsis">
  367. Project Comparisons
  368. </span>
  369. </a>
  370. </li>
  371. <li class="md-nav__item">
  372. <a href="performance/" class="md-nav__link">
  373. <span class="md-ellipsis">
  374. Tweaking Performance
  375. </span>
  376. </a>
  377. </li>
  378. <li class="md-nav__item">
  379. <a href="benchmarking/" class="md-nav__link">
  380. <span class="md-ellipsis">
  381. Benchmarking
  382. </span>
  383. </a>
  384. </li>
  385. <li class="md-nav__item">
  386. <a href="tooling/" class="md-nav__link">
  387. <span class="md-ellipsis">
  388. Tooling
  389. </span>
  390. </a>
  391. </li>
  392. <li class="md-nav__item md-nav__item--nested">
  393. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_14" >
  394. <label class="md-nav__link" for="__nav_14" id="__nav_14_label" tabindex="0">
  395. <span class="md-ellipsis">
  396. FAQ
  397. </span>
  398. <span class="md-nav__icon md-icon"></span>
  399. </label>
  400. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_14_label" aria-expanded="false">
  401. <label class="md-nav__title" for="__nav_14">
  402. <span class="md-nav__icon md-icon"></span>
  403. FAQ
  404. </label>
  405. <ul class="md-nav__list" data-md-scrollfix>
  406. <li class="md-nav__item">
  407. <a href="faq/compatibility_and_integration/" class="md-nav__link">
  408. <span class="md-ellipsis">
  409. Compatibility and Integration
  410. </span>
  411. </a>
  412. </li>
  413. <li class="md-nav__item">
  414. <a href="faq/configuration_and_policies/" class="md-nav__link">
  415. <span class="md-ellipsis">
  416. Configuration and Policies
  417. </span>
  418. </a>
  419. </li>
  420. <li class="md-nav__item">
  421. <a href="faq/general_information_and_overview/" class="md-nav__link">
  422. <span class="md-ellipsis">
  423. General Information and Overview
  424. </span>
  425. </a>
  426. </li>
  427. <li class="md-nav__item">
  428. <a href="faq/recommendations_and_warnings/" class="md-nav__link">
  429. <span class="md-ellipsis">
  430. Recommendations and Warnings
  431. </span>
  432. </a>
  433. </li>
  434. <li class="md-nav__item">
  435. <a href="faq/technical_behavior_and_limitations/" class="md-nav__link">
  436. <span class="md-ellipsis">
  437. Technical Behavior and Limitations
  438. </span>
  439. </a>
  440. </li>
  441. <li class="md-nav__item">
  442. <a href="faq/usage_and_functionality/" class="md-nav__link">
  443. <span class="md-ellipsis">
  444. Usage and Functionality
  445. </span>
  446. </a>
  447. </li>
  448. <li class="md-nav__item">
  449. <a href="faq/limit_drive_spinup/" class="md-nav__link">
  450. <span class="md-ellipsis">
  451. Limit drive spinup
  452. </span>
  453. </a>
  454. </li>
  455. </ul>
  456. </nav>
  457. </li>
  458. <li class="md-nav__item">
  459. <a href="related_projects/" class="md-nav__link">
  460. <span class="md-ellipsis">
  461. Related Projects
  462. </span>
  463. </a>
  464. </li>
  465. <li class="md-nav__item">
  466. <a href="media_and_publicity/" class="md-nav__link">
  467. <span class="md-ellipsis">
  468. Media and Publicity
  469. </span>
  470. </a>
  471. </li>
  472. <li class="md-nav__item">
  473. <a href="support/" class="md-nav__link">
  474. <span class="md-ellipsis">
  475. Support
  476. </span>
  477. </a>
  478. </li>
  479. <li class="md-nav__item">
  480. <a href="donations/" class="md-nav__link">
  481. <span class="md-ellipsis">
  482. Donations
  483. </span>
  484. </a>
  485. </li>
  486. </ul>
  487. </nav>
  488. </div>
  489. </div>
  490. </div>
  491. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  492. <div class="md-sidebar__scrollwrap">
  493. <div class="md-sidebar__inner">
  494. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  495. <label class="md-nav__title" for="__toc">
  496. <span class="md-nav__icon md-icon"></span>
  497. Table of contents
  498. </label>
  499. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  500. <li class="md-nav__item">
  501. <a href="#features" class="md-nav__link">
  502. <span class="md-ellipsis">
  503. Features
  504. </span>
  505. </a>
  506. </li>
  507. <li class="md-nav__item">
  508. <a href="#non-features" class="md-nav__link">
  509. <span class="md-ellipsis">
  510. Non-features
  511. </span>
  512. </a>
  513. </li>
  514. <li class="md-nav__item">
  515. <a href="#how-it-works" class="md-nav__link">
  516. <span class="md-ellipsis">
  517. How it works
  518. </span>
  519. </a>
  520. <nav class="md-nav" aria-label="How it works">
  521. <ul class="md-nav__list">
  522. <li class="md-nav__item">
  523. <a href="#visualization" class="md-nav__link">
  524. <span class="md-ellipsis">
  525. Visualization
  526. </span>
  527. </a>
  528. </li>
  529. </ul>
  530. </nav>
  531. </li>
  532. </ul>
  533. </nav>
  534. </div>
  535. </div>
  536. </div>
  537. <div class="md-content" data-md-component="content">
  538. <article class="md-content__inner md-typeset">
  539. <a href="https://github.com/trapexit/mergerfs/tree/master/mkdocs/docs/index.md" title="Edit this page" class="md-content__button md-icon">
  540. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M10 20H6V4h7v5h5v3.1l2-2V8l-6-6H6c-1.1 0-2 .9-2 2v16c0 1.1.9 2 2 2h4zm10.2-7c.1 0 .3.1.4.2l1.3 1.3c.2.2.2.6 0 .8l-1 1-2.1-2.1 1-1c.1-.1.2-.2.4-.2m0 3.9L14.1 23H12v-2.1l6.1-6.1z"/></svg>
  541. </a>
  542. <h1 id="mergerfs-a-featureful-union-filesystem">mergerfs - a featureful union filesystem</h1>
  543. <p><strong>mergerfs</strong> is a
  544. <a href="https://en.wikipedia.org/wiki/Filesystem_in_Userspace">FUSE</a> based
  545. <a href="https://en.wikipedia.org/wiki/Union_mount">union filesystem</a> geared
  546. towards simplifying storage and management of files across numerous
  547. commodity storage devices. It is similar to <strong>mhddfs</strong>, <strong>unionfs</strong>,
  548. and <strong>aufs</strong>.</p>
  549. <h2 id="features">Features</h2>
  550. <ul>
  551. <li>Logicially combine numerous filesystems/paths into a single
  552. mount point</li>
  553. <li>Combine paths of the same or different filesystems</li>
  554. <li>Ability to add or remove filesystems/paths without impacting the
  555. rest of the data</li>
  556. <li>Unaffected by individual filesystem failure</li>
  557. <li>Configurable file selection and creation placement</li>
  558. <li>Works with filesystems of any size</li>
  559. <li>Works with filesystems of almost any type</li>
  560. <li>Ignore read-only filesystems when creating files</li>
  561. <li>Hard link copy-on-write / CoW</li>
  562. <li>Runtime configurable</li>
  563. <li>Support for extended attributes (xattrs)</li>
  564. <li>Support for file attributes (chattr)</li>
  565. <li>Support for POSIX ACLs</li>
  566. </ul>
  567. <h2 id="non-features">Non-features</h2>
  568. <ul>
  569. <li>Read/write overlay on top of readonly filesystem like OverlayFS</li>
  570. <li>File whiteout</li>
  571. <li>RAID like parity calculation</li>
  572. <li>Redundency</li>
  573. <li>Splitting of files across branches</li>
  574. </ul>
  575. <h2 id="how-it-works">How it works</h2>
  576. <p>mergerfs logically merges multiple filesystem paths together. It acts
  577. as a proxy to the underlying filesystem paths. Combining the
  578. behaviors of some functions and being a selector for others.</p>
  579. <p>When the contents of a directory are requested mergerfs combines the
  580. list of files from each directory, deduplicating entries, and returns
  581. that list.</p>
  582. <p>When a file or directory is created a policy is first run to determine
  583. which branch will be selected for the creation.</p>
  584. <p>For functions which chant attributes or remove the file the behavior
  585. may be applied to all instances found.</p>
  586. <p>Read more about <a href="config/functions_categories_and_policies/">policies here</a>.</p>
  587. <h3 id="visualization">Visualization</h3>
  588. <div class="language-text highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>A + B = C
  589. </span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a>/disk1 /disk2 /merged
  590. </span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a>| | |
  591. </span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a>+-- /dir1 +-- /dir1 +-- /dir1
  592. </span><span id="__span-0-5"><a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a>| | | | | |
  593. </span><span id="__span-0-6"><a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a>| +-- file1 | +-- file2 | +-- file1
  594. </span><span id="__span-0-7"><a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a>| | +-- file3 | +-- file2
  595. </span><span id="__span-0-8"><a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a>+-- /dir2 | | +-- file3
  596. </span><span id="__span-0-9"><a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a>| | +-- /dir3 |
  597. </span><span id="__span-0-10"><a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a>| +-- file4 | +-- /dir2
  598. </span><span id="__span-0-11"><a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a>| +-- file5 | |
  599. </span><span id="__span-0-12"><a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a>+-- file6 | +-- file4
  600. </span><span id="__span-0-13"><a id="__codelineno-0-13" name="__codelineno-0-13" href="#__codelineno-0-13"></a> |
  601. </span><span id="__span-0-14"><a id="__codelineno-0-14" name="__codelineno-0-14" href="#__codelineno-0-14"></a> +-- /dir3
  602. </span><span id="__span-0-15"><a id="__codelineno-0-15" name="__codelineno-0-15" href="#__codelineno-0-15"></a> | |
  603. </span><span id="__span-0-16"><a id="__codelineno-0-16" name="__codelineno-0-16" href="#__codelineno-0-16"></a> | +-- file5
  604. </span><span id="__span-0-17"><a id="__codelineno-0-17" name="__codelineno-0-17" href="#__codelineno-0-17"></a> |
  605. </span><span id="__span-0-18"><a id="__codelineno-0-18" name="__codelineno-0-18" href="#__codelineno-0-18"></a> +-- file6
  606. </span></code></pre></div>
  607. </article>
  608. </div>
  609. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
  610. </div>
  611. <button type="button" class="md-top md-icon" data-md-component="top" hidden>
  612. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
  613. Back to top
  614. </button>
  615. </main>
  616. <footer class="md-footer">
  617. <div class="md-footer-meta md-typeset">
  618. <div class="md-footer-meta__inner md-grid">
  619. <div class="md-copyright">
  620. Made with
  621. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  622. Material for MkDocs
  623. </a>
  624. </div>
  625. </div>
  626. </div>
  627. </footer>
  628. </div>
  629. <div class="md-dialog" data-md-component="dialog">
  630. <div class="md-dialog__inner md-typeset"></div>
  631. </div>
  632. <script id="__config" type="application/json">{"base": ".", "features": ["content.action.edit", "content.code.copy", "content.code.select", "navigation.instant", "navigation.instant.prefetch", "navigation.path", "navigation.top", "navigation.tracking", "optimize", "search.share", "toc.follow"], "search": "assets/javascripts/workers/search.6ce7567c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
  633. <script src="assets/javascripts/bundle.88dd0f4e.min.js"></script>
  634. </body>
  635. </html>