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.

1973 lines
42 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/setup/installation/">
  8. <link rel="prev" href="../../quickstart/">
  9. <link rel="next" href="../upgrade/">
  10. <link rel="icon" href="../../assets/images/favicon.png">
  11. <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.3">
  12. <title>Installation - mergerfs</title>
  13. <link rel="stylesheet" href="../../assets/stylesheets/main.d7758b05.min.css">
  14. <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
  15. <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
  16. <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">
  17. <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
  18. <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>
  19. </head>
  20. <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo">
  21. <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
  22. <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
  23. <label class="md-overlay" for="__drawer"></label>
  24. <div data-md-component="skip">
  25. <a href="#installation" class="md-skip">
  26. Skip to content
  27. </a>
  28. </div>
  29. <div data-md-component="announce">
  30. </div>
  31. <header class="md-header md-header--shadow" data-md-component="header">
  32. <nav class="md-header__inner md-grid" aria-label="Header">
  33. <a href="../.." title="mergerfs" class="md-header__button md-logo" aria-label="mergerfs" data-md-component="logo">
  34. <img src="../../logo.jpeg" alt="logo">
  35. </a>
  36. <label class="md-header__button md-icon" for="__drawer">
  37. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
  38. </label>
  39. <div class="md-header__title" data-md-component="header-title">
  40. <div class="md-header__ellipsis">
  41. <div class="md-header__topic">
  42. <span class="md-ellipsis">
  43. mergerfs
  44. </span>
  45. </div>
  46. <div class="md-header__topic" data-md-component="header-topic">
  47. <span class="md-ellipsis">
  48. Installation
  49. </span>
  50. </div>
  51. </div>
  52. </div>
  53. <form class="md-header__option" data-md-component="palette">
  54. <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">
  55. <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
  56. <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>
  57. </label>
  58. <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">
  59. <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_2" hidden>
  60. <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>
  61. </label>
  62. <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">
  63. <label class="md-header__button md-icon" title="Switch to system preference" for="__palette_0" hidden>
  64. <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>
  65. </label>
  66. </form>
  67. <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>
  68. <label class="md-header__button md-icon" for="__search">
  69. <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>
  70. </label>
  71. <div class="md-search" data-md-component="search" role="dialog">
  72. <label class="md-search__overlay" for="__search"></label>
  73. <div class="md-search__inner" role="search">
  74. <form class="md-search__form" name="search">
  75. <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>
  76. <label class="md-search__icon md-icon" for="__search">
  77. <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>
  78. <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>
  79. </label>
  80. <nav class="md-search__options" aria-label="Search">
  81. <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">
  82. <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>
  83. </a>
  84. <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
  85. <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>
  86. </button>
  87. </nav>
  88. </form>
  89. <div class="md-search__output">
  90. <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
  91. <div class="md-search-result" data-md-component="search-result">
  92. <div class="md-search-result__meta">
  93. Initializing search
  94. </div>
  95. <ol class="md-search-result__list" role="presentation"></ol>
  96. </div>
  97. </div>
  98. </div>
  99. </div>
  100. </div>
  101. <div class="md-header__source">
  102. <a href="https://github.com/trapexit/mergerfs" title="Go to repository" class="md-source" data-md-component="source">
  103. <div class="md-source__icon md-icon">
  104. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.7.2 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>
  105. </div>
  106. <div class="md-source__repository">
  107. mergerfs
  108. </div>
  109. </a>
  110. </div>
  111. </nav>
  112. </header>
  113. <div class="md-container" data-md-component="container">
  114. <main class="md-main" data-md-component="main">
  115. <div class="md-main__inner md-grid">
  116. <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
  117. <div class="md-sidebar__scrollwrap">
  118. <div class="md-sidebar__inner">
  119. <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
  120. <label class="md-nav__title" for="__drawer">
  121. <a href="../.." title="mergerfs" class="md-nav__button md-logo" aria-label="mergerfs" data-md-component="logo">
  122. <img src="../../logo.jpeg" alt="logo">
  123. </a>
  124. mergerfs
  125. </label>
  126. <div class="md-nav__source">
  127. <a href="https://github.com/trapexit/mergerfs" title="Go to repository" class="md-source" data-md-component="source">
  128. <div class="md-source__icon md-icon">
  129. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.7.2 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>
  130. </div>
  131. <div class="md-source__repository">
  132. mergerfs
  133. </div>
  134. </a>
  135. </div>
  136. <ul class="md-nav__list" data-md-scrollfix>
  137. <li class="md-nav__item">
  138. <a href="../.." class="md-nav__link">
  139. <span class="md-ellipsis">
  140. Home
  141. </span>
  142. </a>
  143. </li>
  144. <li class="md-nav__item">
  145. <a href="../../quickstart/" class="md-nav__link">
  146. <span class="md-ellipsis">
  147. QuickStart
  148. </span>
  149. </a>
  150. </li>
  151. <li class="md-nav__item md-nav__item--active md-nav__item--nested">
  152. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" checked>
  153. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
  154. <span class="md-ellipsis">
  155. Installation
  156. </span>
  157. <span class="md-nav__icon md-icon"></span>
  158. </label>
  159. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="true">
  160. <label class="md-nav__title" for="__nav_3">
  161. <span class="md-nav__icon md-icon"></span>
  162. Installation
  163. </label>
  164. <ul class="md-nav__list" data-md-scrollfix>
  165. <li class="md-nav__item md-nav__item--active">
  166. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  167. <label class="md-nav__link md-nav__link--active" for="__toc">
  168. <span class="md-ellipsis">
  169. Installation
  170. </span>
  171. <span class="md-nav__icon md-icon"></span>
  172. </label>
  173. <a href="./" class="md-nav__link md-nav__link--active">
  174. <span class="md-ellipsis">
  175. Installation
  176. </span>
  177. </a>
  178. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  179. <label class="md-nav__title" for="__toc">
  180. <span class="md-nav__icon md-icon"></span>
  181. Table of contents
  182. </label>
  183. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  184. <li class="md-nav__item">
  185. <a href="#archlinux" class="md-nav__link">
  186. <span class="md-ellipsis">
  187. ArchLinux
  188. </span>
  189. </a>
  190. </li>
  191. <li class="md-nav__item">
  192. <a href="#centos-rocky" class="md-nav__link">
  193. <span class="md-ellipsis">
  194. CentOS / Rocky
  195. </span>
  196. </a>
  197. </li>
  198. <li class="md-nav__item">
  199. <a href="#debian-based-os" class="md-nav__link">
  200. <span class="md-ellipsis">
  201. Debian based OS
  202. </span>
  203. </a>
  204. <nav class="md-nav" aria-label="Debian based OS">
  205. <ul class="md-nav__list">
  206. <li class="md-nav__item">
  207. <a href="#prebuilt-deb" class="md-nav__link">
  208. <span class="md-ellipsis">
  209. prebuilt deb
  210. </span>
  211. </a>
  212. <nav class="md-nav" aria-label="prebuilt deb">
  213. <ul class="md-nav__list">
  214. <li class="md-nav__item">
  215. <a href="#debian" class="md-nav__link">
  216. <span class="md-ellipsis">
  217. Debian
  218. </span>
  219. </a>
  220. </li>
  221. <li class="md-nav__item">
  222. <a href="#ubuntu" class="md-nav__link">
  223. <span class="md-ellipsis">
  224. Ubuntu
  225. </span>
  226. </a>
  227. </li>
  228. </ul>
  229. </nav>
  230. </li>
  231. <li class="md-nav__item">
  232. <a href="#apt" class="md-nav__link">
  233. <span class="md-ellipsis">
  234. apt
  235. </span>
  236. </a>
  237. </li>
  238. </ul>
  239. </nav>
  240. </li>
  241. <li class="md-nav__item">
  242. <a href="#fedora" class="md-nav__link">
  243. <span class="md-ellipsis">
  244. Fedora
  245. </span>
  246. </a>
  247. </li>
  248. <li class="md-nav__item">
  249. <a href="#freebsd" class="md-nav__link">
  250. <span class="md-ellipsis">
  251. FreeBSD
  252. </span>
  253. </a>
  254. </li>
  255. <li class="md-nav__item">
  256. <a href="#nixos" class="md-nav__link">
  257. <span class="md-ellipsis">
  258. NixOS
  259. </span>
  260. </a>
  261. </li>
  262. <li class="md-nav__item">
  263. <a href="#other-linux-distros" class="md-nav__link">
  264. <span class="md-ellipsis">
  265. Other Linux Distros
  266. </span>
  267. </a>
  268. </li>
  269. <li class="md-nav__item">
  270. <a href="#static-linux-binaries" class="md-nav__link">
  271. <span class="md-ellipsis">
  272. Static Linux Binaries
  273. </span>
  274. </a>
  275. </li>
  276. </ul>
  277. </nav>
  278. </li>
  279. <li class="md-nav__item">
  280. <a href="../upgrade/" class="md-nav__link">
  281. <span class="md-ellipsis">
  282. Upgrade
  283. </span>
  284. </a>
  285. </li>
  286. <li class="md-nav__item">
  287. <a href="../build/" class="md-nav__link">
  288. <span class="md-ellipsis">
  289. Build
  290. </span>
  291. </a>
  292. </li>
  293. </ul>
  294. </nav>
  295. </li>
  296. <li class="md-nav__item">
  297. <a href="../../terminology/" class="md-nav__link">
  298. <span class="md-ellipsis">
  299. Terminology
  300. </span>
  301. </a>
  302. </li>
  303. <li class="md-nav__item md-nav__item--nested">
  304. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
  305. <label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
  306. <span class="md-ellipsis">
  307. Config
  308. </span>
  309. <span class="md-nav__icon md-icon"></span>
  310. </label>
  311. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
  312. <label class="md-nav__title" for="__nav_5">
  313. <span class="md-nav__icon md-icon"></span>
  314. Config
  315. </label>
  316. <ul class="md-nav__list" data-md-scrollfix>
  317. <li class="md-nav__item">
  318. <a href="../../config/options/" class="md-nav__link">
  319. <span class="md-ellipsis">
  320. Options
  321. </span>
  322. </a>
  323. </li>
  324. <li class="md-nav__item">
  325. <a href="../../config/deprecated_options/" class="md-nav__link">
  326. <span class="md-ellipsis">
  327. Deprecated Options
  328. </span>
  329. </a>
  330. </li>
  331. <li class="md-nav__item">
  332. <a href="../../config/branches/" class="md-nav__link">
  333. <span class="md-ellipsis">
  334. branches
  335. </span>
  336. </a>
  337. </li>
  338. <li class="md-nav__item">
  339. <a href="../../config/functions_categories_and_policies/" class="md-nav__link">
  340. <span class="md-ellipsis">
  341. functions, categories and policies
  342. </span>
  343. </a>
  344. </li>
  345. <li class="md-nav__item">
  346. <a href="../../config/func_readdir/" class="md-nav__link">
  347. <span class="md-ellipsis">
  348. func.readdir
  349. </span>
  350. </a>
  351. </li>
  352. <li class="md-nav__item">
  353. <a href="../../config/rename_and_link/" class="md-nav__link">
  354. <span class="md-ellipsis">
  355. rename and link
  356. </span>
  357. </a>
  358. </li>
  359. <li class="md-nav__item">
  360. <a href="../../config/cache/" class="md-nav__link">
  361. <span class="md-ellipsis">
  362. caching
  363. </span>
  364. </a>
  365. </li>
  366. <li class="md-nav__item">
  367. <a href="../../config/readahead/" class="md-nav__link">
  368. <span class="md-ellipsis">
  369. readahead
  370. </span>
  371. </a>
  372. </li>
  373. <li class="md-nav__item">
  374. <a href="../../config/inodecalc/" class="md-nav__link">
  375. <span class="md-ellipsis">
  376. inodecalc
  377. </span>
  378. </a>
  379. </li>
  380. <li class="md-nav__item">
  381. <a href="../../config/threads/" class="md-nav__link">
  382. <span class="md-ellipsis">
  383. threads
  384. </span>
  385. </a>
  386. </li>
  387. <li class="md-nav__item">
  388. <a href="../../config/pin-threads/" class="md-nav__link">
  389. <span class="md-ellipsis">
  390. pin-threads
  391. </span>
  392. </a>
  393. </li>
  394. <li class="md-nav__item">
  395. <a href="../../config/link_cow/" class="md-nav__link">
  396. <span class="md-ellipsis">
  397. link_cow
  398. </span>
  399. </a>
  400. </li>
  401. <li class="md-nav__item">
  402. <a href="../../config/fuse_msg_size/" class="md-nav__link">
  403. <span class="md-ellipsis">
  404. fuse_msg_size
  405. </span>
  406. </a>
  407. </li>
  408. <li class="md-nav__item">
  409. <a href="../../config/follow-symlinks/" class="md-nav__link">
  410. <span class="md-ellipsis">
  411. follow-symlinks
  412. </span>
  413. </a>
  414. </li>
  415. <li class="md-nav__item">
  416. <a href="../../config/link-exdev/" class="md-nav__link">
  417. <span class="md-ellipsis">
  418. link-exdev
  419. </span>
  420. </a>
  421. </li>
  422. <li class="md-nav__item">
  423. <a href="../../config/rename-exdev/" class="md-nav__link">
  424. <span class="md-ellipsis">
  425. rename-exdev
  426. </span>
  427. </a>
  428. </li>
  429. <li class="md-nav__item">
  430. <a href="../../config/symlinkify/" class="md-nav__link">
  431. <span class="md-ellipsis">
  432. symlinkify
  433. </span>
  434. </a>
  435. </li>
  436. <li class="md-nav__item">
  437. <a href="../../config/nullrw/" class="md-nav__link">
  438. <span class="md-ellipsis">
  439. nullrw
  440. </span>
  441. </a>
  442. </li>
  443. <li class="md-nav__item">
  444. <a href="../../config/xattr/" class="md-nav__link">
  445. <span class="md-ellipsis">
  446. xattr
  447. </span>
  448. </a>
  449. </li>
  450. <li class="md-nav__item">
  451. <a href="../../config/nfsopenhack/" class="md-nav__link">
  452. <span class="md-ellipsis">
  453. nfsopenhack
  454. </span>
  455. </a>
  456. </li>
  457. <li class="md-nav__item">
  458. <a href="../../config/statfs/" class="md-nav__link">
  459. <span class="md-ellipsis">
  460. statfs / statvfs
  461. </span>
  462. </a>
  463. </li>
  464. <li class="md-nav__item">
  465. <a href="../../config/flush-on-close/" class="md-nav__link">
  466. <span class="md-ellipsis">
  467. flush-on-close
  468. </span>
  469. </a>
  470. </li>
  471. <li class="md-nav__item">
  472. <a href="../../config/export-support/" class="md-nav__link">
  473. <span class="md-ellipsis">
  474. export-support
  475. </span>
  476. </a>
  477. </li>
  478. </ul>
  479. </nav>
  480. </li>
  481. <li class="md-nav__item">
  482. <a href="../../error_handling_and_logging/" class="md-nav__link">
  483. <span class="md-ellipsis">
  484. Error Handling and Logging
  485. </span>
  486. </a>
  487. </li>
  488. <li class="md-nav__item">
  489. <a href="../../runtime_interfaces/" class="md-nav__link">
  490. <span class="md-ellipsis">
  491. Runtime Interfaces
  492. </span>
  493. </a>
  494. </li>
  495. <li class="md-nav__item">
  496. <a href="../../remote_filesystems/" class="md-nav__link">
  497. <span class="md-ellipsis">
  498. Remote Filesystems
  499. </span>
  500. </a>
  501. </li>
  502. <li class="md-nav__item">
  503. <a href="../../tips_notes/" class="md-nav__link">
  504. <span class="md-ellipsis">
  505. Tips and Notes
  506. </span>
  507. </a>
  508. </li>
  509. <li class="md-nav__item">
  510. <a href="../../known_issues_bugs/" class="md-nav__link">
  511. <span class="md-ellipsis">
  512. Known Issues and Bugs
  513. </span>
  514. </a>
  515. </li>
  516. <li class="md-nav__item">
  517. <a href="../../project_comparisons/" class="md-nav__link">
  518. <span class="md-ellipsis">
  519. Project Comparisons
  520. </span>
  521. </a>
  522. </li>
  523. <li class="md-nav__item">
  524. <a href="../../performance/" class="md-nav__link">
  525. <span class="md-ellipsis">
  526. Tweaking Performance
  527. </span>
  528. </a>
  529. </li>
  530. <li class="md-nav__item">
  531. <a href="../../benchmarking/" class="md-nav__link">
  532. <span class="md-ellipsis">
  533. Benchmarking
  534. </span>
  535. </a>
  536. </li>
  537. <li class="md-nav__item">
  538. <a href="../../tooling/" class="md-nav__link">
  539. <span class="md-ellipsis">
  540. Tooling
  541. </span>
  542. </a>
  543. </li>
  544. <li class="md-nav__item">
  545. <a href="../../usage_patterns/" class="md-nav__link">
  546. <span class="md-ellipsis">
  547. Usage Patterns
  548. </span>
  549. </a>
  550. </li>
  551. <li class="md-nav__item md-nav__item--nested">
  552. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_16" >
  553. <label class="md-nav__link" for="__nav_16" id="__nav_16_label" tabindex="0">
  554. <span class="md-ellipsis">
  555. FAQ
  556. </span>
  557. <span class="md-nav__icon md-icon"></span>
  558. </label>
  559. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_16_label" aria-expanded="false">
  560. <label class="md-nav__title" for="__nav_16">
  561. <span class="md-nav__icon md-icon"></span>
  562. FAQ
  563. </label>
  564. <ul class="md-nav__list" data-md-scrollfix>
  565. <li class="md-nav__item">
  566. <a href="../../faq/reliability_and_scalability/" class="md-nav__link">
  567. <span class="md-ellipsis">
  568. Reliability and Scalability
  569. </span>
  570. </a>
  571. </li>
  572. <li class="md-nav__item">
  573. <a href="../../faq/usage_and_functionality/" class="md-nav__link">
  574. <span class="md-ellipsis">
  575. Usage and Functionality
  576. </span>
  577. </a>
  578. </li>
  579. <li class="md-nav__item">
  580. <a href="../../faq/configuration_and_policies/" class="md-nav__link">
  581. <span class="md-ellipsis">
  582. Configuration and Policies
  583. </span>
  584. </a>
  585. </li>
  586. <li class="md-nav__item">
  587. <a href="../../faq/compatibility_and_integration/" class="md-nav__link">
  588. <span class="md-ellipsis">
  589. Compatibility and Integration
  590. </span>
  591. </a>
  592. </li>
  593. <li class="md-nav__item">
  594. <a href="../../faq/recommendations_and_warnings/" class="md-nav__link">
  595. <span class="md-ellipsis">
  596. Recommendations and Warnings
  597. </span>
  598. </a>
  599. </li>
  600. <li class="md-nav__item">
  601. <a href="../../faq/technical_behavior_and_limitations/" class="md-nav__link">
  602. <span class="md-ellipsis">
  603. Technical Behavior and Limitations
  604. </span>
  605. </a>
  606. </li>
  607. <li class="md-nav__item">
  608. <a href="../../faq/limit_drive_spinup/" class="md-nav__link">
  609. <span class="md-ellipsis">
  610. Limiting drive spinup
  611. </span>
  612. </a>
  613. </li>
  614. </ul>
  615. </nav>
  616. </li>
  617. <li class="md-nav__item">
  618. <a href="../../related_projects/" class="md-nav__link">
  619. <span class="md-ellipsis">
  620. Related Projects
  621. </span>
  622. </a>
  623. </li>
  624. <li class="md-nav__item">
  625. <a href="../../media_and_publicity/" class="md-nav__link">
  626. <span class="md-ellipsis">
  627. Media and Publicity
  628. </span>
  629. </a>
  630. </li>
  631. <li class="md-nav__item">
  632. <a href="../../support/" class="md-nav__link">
  633. <span class="md-ellipsis">
  634. Support
  635. </span>
  636. </a>
  637. </li>
  638. <li class="md-nav__item">
  639. <a href="../../sponsorship_and_donations/" class="md-nav__link">
  640. <span class="md-ellipsis">
  641. Sponsorship and Donations
  642. </span>
  643. </a>
  644. </li>
  645. </ul>
  646. </nav>
  647. </div>
  648. </div>
  649. </div>
  650. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  651. <div class="md-sidebar__scrollwrap">
  652. <div class="md-sidebar__inner">
  653. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  654. <label class="md-nav__title" for="__toc">
  655. <span class="md-nav__icon md-icon"></span>
  656. Table of contents
  657. </label>
  658. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  659. <li class="md-nav__item">
  660. <a href="#archlinux" class="md-nav__link">
  661. <span class="md-ellipsis">
  662. ArchLinux
  663. </span>
  664. </a>
  665. </li>
  666. <li class="md-nav__item">
  667. <a href="#centos-rocky" class="md-nav__link">
  668. <span class="md-ellipsis">
  669. CentOS / Rocky
  670. </span>
  671. </a>
  672. </li>
  673. <li class="md-nav__item">
  674. <a href="#debian-based-os" class="md-nav__link">
  675. <span class="md-ellipsis">
  676. Debian based OS
  677. </span>
  678. </a>
  679. <nav class="md-nav" aria-label="Debian based OS">
  680. <ul class="md-nav__list">
  681. <li class="md-nav__item">
  682. <a href="#prebuilt-deb" class="md-nav__link">
  683. <span class="md-ellipsis">
  684. prebuilt deb
  685. </span>
  686. </a>
  687. <nav class="md-nav" aria-label="prebuilt deb">
  688. <ul class="md-nav__list">
  689. <li class="md-nav__item">
  690. <a href="#debian" class="md-nav__link">
  691. <span class="md-ellipsis">
  692. Debian
  693. </span>
  694. </a>
  695. </li>
  696. <li class="md-nav__item">
  697. <a href="#ubuntu" class="md-nav__link">
  698. <span class="md-ellipsis">
  699. Ubuntu
  700. </span>
  701. </a>
  702. </li>
  703. </ul>
  704. </nav>
  705. </li>
  706. <li class="md-nav__item">
  707. <a href="#apt" class="md-nav__link">
  708. <span class="md-ellipsis">
  709. apt
  710. </span>
  711. </a>
  712. </li>
  713. </ul>
  714. </nav>
  715. </li>
  716. <li class="md-nav__item">
  717. <a href="#fedora" class="md-nav__link">
  718. <span class="md-ellipsis">
  719. Fedora
  720. </span>
  721. </a>
  722. </li>
  723. <li class="md-nav__item">
  724. <a href="#freebsd" class="md-nav__link">
  725. <span class="md-ellipsis">
  726. FreeBSD
  727. </span>
  728. </a>
  729. </li>
  730. <li class="md-nav__item">
  731. <a href="#nixos" class="md-nav__link">
  732. <span class="md-ellipsis">
  733. NixOS
  734. </span>
  735. </a>
  736. </li>
  737. <li class="md-nav__item">
  738. <a href="#other-linux-distros" class="md-nav__link">
  739. <span class="md-ellipsis">
  740. Other Linux Distros
  741. </span>
  742. </a>
  743. </li>
  744. <li class="md-nav__item">
  745. <a href="#static-linux-binaries" class="md-nav__link">
  746. <span class="md-ellipsis">
  747. Static Linux Binaries
  748. </span>
  749. </a>
  750. </li>
  751. </ul>
  752. </nav>
  753. </div>
  754. </div>
  755. </div>
  756. <div class="md-content" data-md-component="content">
  757. <article class="md-content__inner md-typeset">
  758. <a href="https://github.com/trapexit/mergerfs/edit/master/mkdocs/docs/setup/installation.md" title="Edit this page" class="md-content__button md-icon">
  759. <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>
  760. </a>
  761. <a href="https://github.com/trapexit/mergerfs/raw/master/mkdocs/docs/setup/installation.md" title="View source of this page" class="md-content__button md-icon">
  762. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M17 18c.56 0 1 .44 1 1s-.44 1-1 1-1-.44-1-1 .44-1 1-1m0-3c-2.73 0-5.06 1.66-6 4 .94 2.34 3.27 4 6 4s5.06-1.66 6-4c-.94-2.34-3.27-4-6-4m0 6.5a2.5 2.5 0 0 1-2.5-2.5 2.5 2.5 0 0 1 2.5-2.5 2.5 2.5 0 0 1 2.5 2.5 2.5 2.5 0 0 1-2.5 2.5M9.27 20H6V4h7v5h5v4.07c.7.08 1.36.25 2 .49V8l-6-6H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h4.5a8.2 8.2 0 0 1-1.23-2"/></svg>
  763. </a>
  764. <h1 id="installation">Installation</h1>
  765. <p>If you are using a non-rolling release Linux distro such as Debian or
  766. Ubuntu then you are almost certainly going to have an old version of
  767. mergerfs installed if you use the "official" package. For that reason
  768. we provide packages for major stable released distros.</p>
  769. <p>Before reporting issues or bugs please be sure to upgrade to the
  770. latest release to confirm they still exist.</p>
  771. <p>All provided packages can be found at <a href="https://github.com/trapexit/mergerfs/releases">https://github.com/trapexit/mergerfs/releases</a></p>
  772. <h2 id="archlinux">ArchLinux</h2>
  773. <ol>
  774. <li>Setup AUR</li>
  775. <li><code>pacman -S mergerfs</code></li>
  776. </ol>
  777. <h2 id="centos-rocky">CentOS / Rocky</h2>
  778. <p>Get the RPM from the <a href="https://github.com/trapexit/mergerfs/releases">releases page</a>.</p>
  779. <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>wget https://github.com/trapexit/mergerfs/releases/download/&lt;ver&gt;/mergerfs-&lt;ver&gt;.el&lt;rel&gt;.&lt;arch&gt;.rpm
  780. </span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a>sudo rpm -i mergerfs-&lt;ver&gt;.el&lt;rel&gt;.&lt;arch&gt;.rpm
  781. </span></code></pre></div>
  782. <h2 id="debian-based-os">Debian based OS</h2>
  783. <p>Debian/Ubuntu/Raspberry Pi</p>
  784. <p>Most Debian based OS installs are of a stable branch and therefore do not have
  785. the most up to date software. While mergerfs is available via <code>apt</code> it
  786. is suggested that users install the most recent version available from
  787. the <a href="https://github.com/trapexit/mergerfs/releases">releases page</a>.</p>
  788. <h3 id="prebuilt-deb">prebuilt deb</h3>
  789. <h4 id="debian">Debian</h4>
  790. <div class="language-text highlight"><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>wget https://github.com/trapexit/mergerfs/releases/download/&lt;ver&gt;/mergerfs_&lt;ver&gt;.debian-&lt;rel&gt;_&lt;arch&gt;.deb
  791. </span><span id="__span-1-2"><a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a>sudo dpkg -i mergerfs_&lt;ver&gt;.debian-&lt;rel&gt;_&lt;arch&gt;.deb
  792. </span></code></pre></div>
  793. <h4 id="ubuntu">Ubuntu</h4>
  794. <div class="language-text highlight"><pre><span></span><code><span id="__span-2-1"><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>wget https://github.com/trapexit/mergerfs/releases/download/&lt;version&gt;/mergerfs_&lt;ver&gt;.ubuntu-&lt;rel&gt;_&lt;arch&gt;.deb
  795. </span><span id="__span-2-2"><a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a>sudo dpkg -i mergerfs_&lt;ver&gt;.ubuntu-&lt;rel&gt;_&lt;arch&gt;.deb
  796. </span></code></pre></div>
  797. <h3 id="apt">apt</h3>
  798. <div class="language-text highlight"><pre><span></span><code><span id="__span-3-1"><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a>sudo apt install -y mergerfs
  799. </span></code></pre></div>
  800. <h2 id="fedora">Fedora</h2>
  801. <p>Get the RPM from the <a href="https://github.com/trapexit/mergerfs/releases">releases page</a>.</p>
  802. <div class="language-text highlight"><pre><span></span><code><span id="__span-4-1"><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a>wget https://github.com/trapexit/mergerfs/releases/download/&lt;ver&gt;/mergerfs-&lt;ver&gt;.fc&lt;rel&gt;.&lt;arch&gt;.rpm
  803. </span><span id="__span-4-2"><a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a>sudo rpm -i mergerfs-&lt;ver&gt;.fc&lt;rel&gt;.&lt;arch&gt;.rpm
  804. </span></code></pre></div>
  805. <h2 id="freebsd">FreeBSD</h2>
  806. <p><a href="https://www.freshports.org/filesystems/mergerfs">https://www.freshports.org/filesystems/mergerfs</a></p>
  807. <div class="language-text highlight"><pre><span></span><code><span id="__span-5-1"><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a>pkg install filesystems/mergerfs
  808. </span></code></pre></div>
  809. <h2 id="nixos">NixOS</h2>
  810. <p><a href="https://search.nixos.org/packages?channel=unstable&amp;show=mergerfs&amp;from=0&amp;size=50&amp;sort=relevance&amp;type=packages&amp;query=mergerfs">search.nixos.org</a></p>
  811. <div class="language-text highlight"><pre><span></span><code><span id="__span-6-1"><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a>nix-env -iA nixos.mergerfs
  812. </span></code></pre></div>
  813. <h2 id="other-linux-distros">Other Linux Distros</h2>
  814. <p><a href="../../related_projects/#distributions-including-mergerfs">Check your distro.</a></p>
  815. <h2 id="static-linux-binaries">Static Linux Binaries</h2>
  816. <p>If your distro does not package mergerfs there are static binaries
  817. provided.</p>
  818. <p>Get the tarball from the <a href="https://github.com/trapexit/mergerfs/releases">releases page</a>.</p>
  819. <div class="language-text highlight"><pre><span></span><code><span id="__span-7-1"><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a>wget https://github.com/trapexit/mergerfs/releases/download/&lt;ver&gt;/mergerfs-static-linux_&lt;arch&gt;.tar.gz
  820. </span><span id="__span-7-2"><a id="__codelineno-7-2" name="__codelineno-7-2" href="#__codelineno-7-2"></a>sudo tar xvf mergerfs-static-linux_&lt;arch&gt;.tar.gz -C /
  821. </span></code></pre></div>
  822. </article>
  823. </div>
  824. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
  825. </div>
  826. <button type="button" class="md-top md-icon" data-md-component="top" hidden>
  827. <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>
  828. Back to top
  829. </button>
  830. </main>
  831. <footer class="md-footer">
  832. <nav class="md-footer__inner md-grid" aria-label="Footer" >
  833. <a href="../../quickstart/" class="md-footer__link md-footer__link--prev" aria-label="Previous: QuickStart">
  834. <div class="md-footer__button md-icon">
  835. <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>
  836. </div>
  837. <div class="md-footer__title">
  838. <span class="md-footer__direction">
  839. Previous
  840. </span>
  841. <div class="md-ellipsis">
  842. QuickStart
  843. </div>
  844. </div>
  845. </a>
  846. <a href="../upgrade/" class="md-footer__link md-footer__link--next" aria-label="Next: Upgrade">
  847. <div class="md-footer__title">
  848. <span class="md-footer__direction">
  849. Next
  850. </span>
  851. <div class="md-ellipsis">
  852. Upgrade
  853. </div>
  854. </div>
  855. <div class="md-footer__button md-icon">
  856. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11z"/></svg>
  857. </div>
  858. </a>
  859. </nav>
  860. <div class="md-footer-meta md-typeset">
  861. <div class="md-footer-meta__inner md-grid">
  862. <div class="md-copyright">
  863. Made with
  864. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  865. Material for MkDocs
  866. </a>
  867. </div>
  868. </div>
  869. </div>
  870. </footer>
  871. </div>
  872. <div class="md-dialog" data-md-component="dialog">
  873. <div class="md-dialog__inner md-typeset"></div>
  874. </div>
  875. <script id="__config" type="application/json">{"base": "../..", "features": ["content.action.edit", "content.action.view", "content.code.copy", "content.code.select", "navigation.footer", "navigation.instant", "navigation.instant.prefetch", "navigation.path", "navigation.top", "navigation.tracking", "optimize", "search.share", "toc.follow"], "search": "../../assets/javascripts/workers/search.f8cc74c7.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>
  876. <script src="../../assets/javascripts/bundle.f1b6f286.min.js"></script>
  877. </body>
  878. </html>