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.

2119 lines
58 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/quickstart/">
  8. <link rel="prev" href="..">
  9. <link rel="next" href="../setup/installation/">
  10. <link rel="icon" href="../assets/images/favicon.png">
  11. <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.49">
  12. <title>QuickStart - mergerfs</title>
  13. <link rel="stylesheet" href="../assets/stylesheets/main.6f8fc17f.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="#quickstart" 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. QuickStart
  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.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>
  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.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>
  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 md-nav__item--active">
  145. <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
  146. <label class="md-nav__link md-nav__link--active" for="__toc">
  147. <span class="md-ellipsis">
  148. QuickStart
  149. </span>
  150. <span class="md-nav__icon md-icon"></span>
  151. </label>
  152. <a href="./" class="md-nav__link md-nav__link--active">
  153. <span class="md-ellipsis">
  154. QuickStart
  155. </span>
  156. </a>
  157. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  158. <label class="md-nav__title" for="__toc">
  159. <span class="md-nav__icon md-icon"></span>
  160. Table of contents
  161. </label>
  162. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  163. <li class="md-nav__item">
  164. <a href="#install" class="md-nav__link">
  165. <span class="md-ellipsis">
  166. Install
  167. </span>
  168. </a>
  169. </li>
  170. <li class="md-nav__item">
  171. <a href="#configuration" class="md-nav__link">
  172. <span class="md-ellipsis">
  173. Configuration
  174. </span>
  175. </a>
  176. <nav class="md-nav" aria-label="Configuration">
  177. <ul class="md-nav__list">
  178. <li class="md-nav__item">
  179. <a href="#you-use-linux-v66-or-above" class="md-nav__link">
  180. <span class="md-ellipsis">
  181. You use Linux v6.6 or above
  182. </span>
  183. </a>
  184. </li>
  185. <li class="md-nav__item">
  186. <a href="#you-use-linux-v65-or-below" class="md-nav__link">
  187. <span class="md-ellipsis">
  188. You use Linux v6.5 or below
  189. </span>
  190. </a>
  191. <nav class="md-nav" aria-label="You use Linux v6.5 or below">
  192. <ul class="md-nav__list">
  193. <li class="md-nav__item">
  194. <a href="#you-need-mmap-used-by-rtorrent-and-many-sqlite3-base-software" class="md-nav__link">
  195. <span class="md-ellipsis">
  196. You need mmap (used by rtorrent and many sqlite3 base software)
  197. </span>
  198. </a>
  199. </li>
  200. <li class="md-nav__item">
  201. <a href="#you-dont-need-mmap" class="md-nav__link">
  202. <span class="md-ellipsis">
  203. You don't need mmap
  204. </span>
  205. </a>
  206. </li>
  207. </ul>
  208. </nav>
  209. </li>
  210. </ul>
  211. </nav>
  212. </li>
  213. <li class="md-nav__item">
  214. <a href="#usage" class="md-nav__link">
  215. <span class="md-ellipsis">
  216. Usage
  217. </span>
  218. </a>
  219. <nav class="md-nav" aria-label="Usage">
  220. <ul class="md-nav__list">
  221. <li class="md-nav__item">
  222. <a href="#command-line" class="md-nav__link">
  223. <span class="md-ellipsis">
  224. Command Line
  225. </span>
  226. </a>
  227. </li>
  228. <li class="md-nav__item">
  229. <a href="#etcfstab" class="md-nav__link">
  230. <span class="md-ellipsis">
  231. /etc/fstab
  232. </span>
  233. </a>
  234. </li>
  235. <li class="md-nav__item">
  236. <a href="#etcfstab-w-config-file" class="md-nav__link">
  237. <span class="md-ellipsis">
  238. /etc/fstab w/ config file
  239. </span>
  240. </a>
  241. <nav class="md-nav" aria-label="/etc/fstab w/ config file">
  242. <ul class="md-nav__list">
  243. <li class="md-nav__item">
  244. <a href="#etcfstab_1" class="md-nav__link">
  245. <span class="md-ellipsis">
  246. /etc/fstab
  247. </span>
  248. </a>
  249. </li>
  250. <li class="md-nav__item">
  251. <a href="#etcmergerfsconfigmediaini" class="md-nav__link">
  252. <span class="md-ellipsis">
  253. /etc/mergerfs/config/media.ini
  254. </span>
  255. </a>
  256. </li>
  257. <li class="md-nav__item">
  258. <a href="#etcmergerfsbranchesmedia" class="md-nav__link">
  259. <span class="md-ellipsis">
  260. /etc/mergerfs/branches/media/
  261. </span>
  262. </a>
  263. </li>
  264. </ul>
  265. </nav>
  266. </li>
  267. <li class="md-nav__item">
  268. <a href="#systemd-simple" class="md-nav__link">
  269. <span class="md-ellipsis">
  270. systemd (simple)
  271. </span>
  272. </a>
  273. </li>
  274. <li class="md-nav__item">
  275. <a href="#systemd-w-setup-script" class="md-nav__link">
  276. <span class="md-ellipsis">
  277. systemd (w/ setup script)
  278. </span>
  279. </a>
  280. <nav class="md-nav" aria-label="systemd (w/ setup script)">
  281. <ul class="md-nav__list">
  282. <li class="md-nav__item">
  283. <a href="#setup-for-mergerfs" class="md-nav__link">
  284. <span class="md-ellipsis">
  285. setup-for-mergerfs
  286. </span>
  287. </a>
  288. </li>
  289. <li class="md-nav__item">
  290. <a href="#setup-for-mergerfsservice" class="md-nav__link">
  291. <span class="md-ellipsis">
  292. setup-for-mergerfs.service
  293. </span>
  294. </a>
  295. </li>
  296. <li class="md-nav__item">
  297. <a href="#mergerfs-mediaservice" class="md-nav__link">
  298. <span class="md-ellipsis">
  299. mergerfs-media.service
  300. </span>
  301. </a>
  302. </li>
  303. </ul>
  304. </nav>
  305. </li>
  306. </ul>
  307. </nav>
  308. </li>
  309. </ul>
  310. </nav>
  311. </li>
  312. <li class="md-nav__item md-nav__item--nested">
  313. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
  314. <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
  315. <span class="md-ellipsis">
  316. Installation
  317. </span>
  318. <span class="md-nav__icon md-icon"></span>
  319. </label>
  320. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
  321. <label class="md-nav__title" for="__nav_3">
  322. <span class="md-nav__icon md-icon"></span>
  323. Installation
  324. </label>
  325. <ul class="md-nav__list" data-md-scrollfix>
  326. <li class="md-nav__item">
  327. <a href="../setup/installation/" class="md-nav__link">
  328. <span class="md-ellipsis">
  329. Installation
  330. </span>
  331. </a>
  332. </li>
  333. <li class="md-nav__item">
  334. <a href="../setup/upgrade/" class="md-nav__link">
  335. <span class="md-ellipsis">
  336. Upgrade
  337. </span>
  338. </a>
  339. </li>
  340. <li class="md-nav__item">
  341. <a href="../setup/build/" class="md-nav__link">
  342. <span class="md-ellipsis">
  343. Build
  344. </span>
  345. </a>
  346. </li>
  347. </ul>
  348. </nav>
  349. </li>
  350. <li class="md-nav__item md-nav__item--nested">
  351. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
  352. <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
  353. <span class="md-ellipsis">
  354. Config
  355. </span>
  356. <span class="md-nav__icon md-icon"></span>
  357. </label>
  358. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
  359. <label class="md-nav__title" for="__nav_4">
  360. <span class="md-nav__icon md-icon"></span>
  361. Config
  362. </label>
  363. <ul class="md-nav__list" data-md-scrollfix>
  364. <li class="md-nav__item">
  365. <a href="../config/terminology/" class="md-nav__link">
  366. <span class="md-ellipsis">
  367. Terminology
  368. </span>
  369. </a>
  370. </li>
  371. <li class="md-nav__item">
  372. <a href="../config/options/" class="md-nav__link">
  373. <span class="md-ellipsis">
  374. Options
  375. </span>
  376. </a>
  377. </li>
  378. <li class="md-nav__item">
  379. <a href="../config/deprecated_options/" class="md-nav__link">
  380. <span class="md-ellipsis">
  381. Deprecated Options
  382. </span>
  383. </a>
  384. </li>
  385. <li class="md-nav__item">
  386. <a href="../config/branches/" class="md-nav__link">
  387. <span class="md-ellipsis">
  388. branches
  389. </span>
  390. </a>
  391. </li>
  392. <li class="md-nav__item">
  393. <a href="../config/functions_categories_and_policies/" class="md-nav__link">
  394. <span class="md-ellipsis">
  395. functions, categories and policies
  396. </span>
  397. </a>
  398. </li>
  399. <li class="md-nav__item">
  400. <a href="../config/func_readdir/" class="md-nav__link">
  401. <span class="md-ellipsis">
  402. func.readdir
  403. </span>
  404. </a>
  405. </li>
  406. <li class="md-nav__item">
  407. <a href="../config/rename_and_link/" class="md-nav__link">
  408. <span class="md-ellipsis">
  409. rename and link
  410. </span>
  411. </a>
  412. </li>
  413. <li class="md-nav__item">
  414. <a href="../config/cache/" class="md-nav__link">
  415. <span class="md-ellipsis">
  416. caching
  417. </span>
  418. </a>
  419. </li>
  420. <li class="md-nav__item">
  421. <a href="../config/readahead/" class="md-nav__link">
  422. <span class="md-ellipsis">
  423. readahead
  424. </span>
  425. </a>
  426. </li>
  427. <li class="md-nav__item">
  428. <a href="../config/inodecalc/" class="md-nav__link">
  429. <span class="md-ellipsis">
  430. inodecalc
  431. </span>
  432. </a>
  433. </li>
  434. <li class="md-nav__item">
  435. <a href="../config/threads/" class="md-nav__link">
  436. <span class="md-ellipsis">
  437. threads
  438. </span>
  439. </a>
  440. </li>
  441. <li class="md-nav__item">
  442. <a href="../config/pin-threads/" class="md-nav__link">
  443. <span class="md-ellipsis">
  444. pin-threads
  445. </span>
  446. </a>
  447. </li>
  448. <li class="md-nav__item">
  449. <a href="../config/link_cow/" class="md-nav__link">
  450. <span class="md-ellipsis">
  451. link_cow
  452. </span>
  453. </a>
  454. </li>
  455. <li class="md-nav__item">
  456. <a href="../config/fuse_msg_size/" class="md-nav__link">
  457. <span class="md-ellipsis">
  458. fuse_msg_size
  459. </span>
  460. </a>
  461. </li>
  462. <li class="md-nav__item">
  463. <a href="../config/follow-symlinks/" class="md-nav__link">
  464. <span class="md-ellipsis">
  465. follow-symlinks
  466. </span>
  467. </a>
  468. </li>
  469. <li class="md-nav__item">
  470. <a href="../config/link-exdev/" class="md-nav__link">
  471. <span class="md-ellipsis">
  472. link-exdev
  473. </span>
  474. </a>
  475. </li>
  476. <li class="md-nav__item">
  477. <a href="../config/rename-exdev/" class="md-nav__link">
  478. <span class="md-ellipsis">
  479. rename-exdev
  480. </span>
  481. </a>
  482. </li>
  483. <li class="md-nav__item">
  484. <a href="../config/symlinkify/" class="md-nav__link">
  485. <span class="md-ellipsis">
  486. symlinkify
  487. </span>
  488. </a>
  489. </li>
  490. <li class="md-nav__item">
  491. <a href="../config/nullrw/" class="md-nav__link">
  492. <span class="md-ellipsis">
  493. nullrw
  494. </span>
  495. </a>
  496. </li>
  497. <li class="md-nav__item">
  498. <a href="../config/xattr/" class="md-nav__link">
  499. <span class="md-ellipsis">
  500. xattr
  501. </span>
  502. </a>
  503. </li>
  504. <li class="md-nav__item">
  505. <a href="../config/nfsopenhack/" class="md-nav__link">
  506. <span class="md-ellipsis">
  507. nfsopenhack
  508. </span>
  509. </a>
  510. </li>
  511. <li class="md-nav__item">
  512. <a href="../config/statfs/" class="md-nav__link">
  513. <span class="md-ellipsis">
  514. statfs / statvfs
  515. </span>
  516. </a>
  517. </li>
  518. <li class="md-nav__item">
  519. <a href="../config/flush-on-close/" class="md-nav__link">
  520. <span class="md-ellipsis">
  521. flush-on-close
  522. </span>
  523. </a>
  524. </li>
  525. <li class="md-nav__item">
  526. <a href="../config/export-support/" class="md-nav__link">
  527. <span class="md-ellipsis">
  528. export-support
  529. </span>
  530. </a>
  531. </li>
  532. </ul>
  533. </nav>
  534. </li>
  535. <li class="md-nav__item">
  536. <a href="../error_handling/" class="md-nav__link">
  537. <span class="md-ellipsis">
  538. Error Handling
  539. </span>
  540. </a>
  541. </li>
  542. <li class="md-nav__item">
  543. <a href="../runtime_interfaces/" class="md-nav__link">
  544. <span class="md-ellipsis">
  545. Runtime Interfaces
  546. </span>
  547. </a>
  548. </li>
  549. <li class="md-nav__item">
  550. <a href="../remote_filesystems/" class="md-nav__link">
  551. <span class="md-ellipsis">
  552. Remote Filesystems
  553. </span>
  554. </a>
  555. </li>
  556. <li class="md-nav__item">
  557. <a href="../tips_notes/" class="md-nav__link">
  558. <span class="md-ellipsis">
  559. Tips and Notes
  560. </span>
  561. </a>
  562. </li>
  563. <li class="md-nav__item">
  564. <a href="../known_issues_bugs/" class="md-nav__link">
  565. <span class="md-ellipsis">
  566. Known Issues and Bugs
  567. </span>
  568. </a>
  569. </li>
  570. <li class="md-nav__item">
  571. <a href="../project_comparisons/" class="md-nav__link">
  572. <span class="md-ellipsis">
  573. Project Comparisons
  574. </span>
  575. </a>
  576. </li>
  577. <li class="md-nav__item">
  578. <a href="../performance/" class="md-nav__link">
  579. <span class="md-ellipsis">
  580. Tweaking Performance
  581. </span>
  582. </a>
  583. </li>
  584. <li class="md-nav__item">
  585. <a href="../benchmarking/" class="md-nav__link">
  586. <span class="md-ellipsis">
  587. Benchmarking
  588. </span>
  589. </a>
  590. </li>
  591. <li class="md-nav__item">
  592. <a href="../tooling/" class="md-nav__link">
  593. <span class="md-ellipsis">
  594. Tooling
  595. </span>
  596. </a>
  597. </li>
  598. <li class="md-nav__item md-nav__item--nested">
  599. <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_14" >
  600. <label class="md-nav__link" for="__nav_14" id="__nav_14_label" tabindex="0">
  601. <span class="md-ellipsis">
  602. FAQ
  603. </span>
  604. <span class="md-nav__icon md-icon"></span>
  605. </label>
  606. <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_14_label" aria-expanded="false">
  607. <label class="md-nav__title" for="__nav_14">
  608. <span class="md-nav__icon md-icon"></span>
  609. FAQ
  610. </label>
  611. <ul class="md-nav__list" data-md-scrollfix>
  612. <li class="md-nav__item">
  613. <a href="../faq/reliability_and_scalability/" class="md-nav__link">
  614. <span class="md-ellipsis">
  615. Reliability and Scalability
  616. </span>
  617. </a>
  618. </li>
  619. <li class="md-nav__item">
  620. <a href="../faq/usage_and_functionality/" class="md-nav__link">
  621. <span class="md-ellipsis">
  622. Usage and Functionality
  623. </span>
  624. </a>
  625. </li>
  626. <li class="md-nav__item">
  627. <a href="../faq/configuration_and_policies/" class="md-nav__link">
  628. <span class="md-ellipsis">
  629. Configuration and Policies
  630. </span>
  631. </a>
  632. </li>
  633. <li class="md-nav__item">
  634. <a href="../faq/compatibility_and_integration/" class="md-nav__link">
  635. <span class="md-ellipsis">
  636. Compatibility and Integration
  637. </span>
  638. </a>
  639. </li>
  640. <li class="md-nav__item">
  641. <a href="../faq/recommendations_and_warnings/" class="md-nav__link">
  642. <span class="md-ellipsis">
  643. Recommendations and Warnings
  644. </span>
  645. </a>
  646. </li>
  647. <li class="md-nav__item">
  648. <a href="../faq/technical_behavior_and_limitations/" class="md-nav__link">
  649. <span class="md-ellipsis">
  650. Technical Behavior and Limitations
  651. </span>
  652. </a>
  653. </li>
  654. <li class="md-nav__item">
  655. <a href="../faq/limit_drive_spinup/" class="md-nav__link">
  656. <span class="md-ellipsis">
  657. Limiting drive spinup
  658. </span>
  659. </a>
  660. </li>
  661. </ul>
  662. </nav>
  663. </li>
  664. <li class="md-nav__item">
  665. <a href="../related_projects/" class="md-nav__link">
  666. <span class="md-ellipsis">
  667. Related Projects
  668. </span>
  669. </a>
  670. </li>
  671. <li class="md-nav__item">
  672. <a href="../media_and_publicity/" class="md-nav__link">
  673. <span class="md-ellipsis">
  674. Media and Publicity
  675. </span>
  676. </a>
  677. </li>
  678. <li class="md-nav__item">
  679. <a href="../support/" class="md-nav__link">
  680. <span class="md-ellipsis">
  681. Support
  682. </span>
  683. </a>
  684. </li>
  685. <li class="md-nav__item">
  686. <a href="../sponsorship_and_donations/" class="md-nav__link">
  687. <span class="md-ellipsis">
  688. Sponsorship and Donations
  689. </span>
  690. </a>
  691. </li>
  692. </ul>
  693. </nav>
  694. </div>
  695. </div>
  696. </div>
  697. <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
  698. <div class="md-sidebar__scrollwrap">
  699. <div class="md-sidebar__inner">
  700. <nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  701. <label class="md-nav__title" for="__toc">
  702. <span class="md-nav__icon md-icon"></span>
  703. Table of contents
  704. </label>
  705. <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
  706. <li class="md-nav__item">
  707. <a href="#install" class="md-nav__link">
  708. <span class="md-ellipsis">
  709. Install
  710. </span>
  711. </a>
  712. </li>
  713. <li class="md-nav__item">
  714. <a href="#configuration" class="md-nav__link">
  715. <span class="md-ellipsis">
  716. Configuration
  717. </span>
  718. </a>
  719. <nav class="md-nav" aria-label="Configuration">
  720. <ul class="md-nav__list">
  721. <li class="md-nav__item">
  722. <a href="#you-use-linux-v66-or-above" class="md-nav__link">
  723. <span class="md-ellipsis">
  724. You use Linux v6.6 or above
  725. </span>
  726. </a>
  727. </li>
  728. <li class="md-nav__item">
  729. <a href="#you-use-linux-v65-or-below" class="md-nav__link">
  730. <span class="md-ellipsis">
  731. You use Linux v6.5 or below
  732. </span>
  733. </a>
  734. <nav class="md-nav" aria-label="You use Linux v6.5 or below">
  735. <ul class="md-nav__list">
  736. <li class="md-nav__item">
  737. <a href="#you-need-mmap-used-by-rtorrent-and-many-sqlite3-base-software" class="md-nav__link">
  738. <span class="md-ellipsis">
  739. You need mmap (used by rtorrent and many sqlite3 base software)
  740. </span>
  741. </a>
  742. </li>
  743. <li class="md-nav__item">
  744. <a href="#you-dont-need-mmap" class="md-nav__link">
  745. <span class="md-ellipsis">
  746. You don't need mmap
  747. </span>
  748. </a>
  749. </li>
  750. </ul>
  751. </nav>
  752. </li>
  753. </ul>
  754. </nav>
  755. </li>
  756. <li class="md-nav__item">
  757. <a href="#usage" class="md-nav__link">
  758. <span class="md-ellipsis">
  759. Usage
  760. </span>
  761. </a>
  762. <nav class="md-nav" aria-label="Usage">
  763. <ul class="md-nav__list">
  764. <li class="md-nav__item">
  765. <a href="#command-line" class="md-nav__link">
  766. <span class="md-ellipsis">
  767. Command Line
  768. </span>
  769. </a>
  770. </li>
  771. <li class="md-nav__item">
  772. <a href="#etcfstab" class="md-nav__link">
  773. <span class="md-ellipsis">
  774. /etc/fstab
  775. </span>
  776. </a>
  777. </li>
  778. <li class="md-nav__item">
  779. <a href="#etcfstab-w-config-file" class="md-nav__link">
  780. <span class="md-ellipsis">
  781. /etc/fstab w/ config file
  782. </span>
  783. </a>
  784. <nav class="md-nav" aria-label="/etc/fstab w/ config file">
  785. <ul class="md-nav__list">
  786. <li class="md-nav__item">
  787. <a href="#etcfstab_1" class="md-nav__link">
  788. <span class="md-ellipsis">
  789. /etc/fstab
  790. </span>
  791. </a>
  792. </li>
  793. <li class="md-nav__item">
  794. <a href="#etcmergerfsconfigmediaini" class="md-nav__link">
  795. <span class="md-ellipsis">
  796. /etc/mergerfs/config/media.ini
  797. </span>
  798. </a>
  799. </li>
  800. <li class="md-nav__item">
  801. <a href="#etcmergerfsbranchesmedia" class="md-nav__link">
  802. <span class="md-ellipsis">
  803. /etc/mergerfs/branches/media/
  804. </span>
  805. </a>
  806. </li>
  807. </ul>
  808. </nav>
  809. </li>
  810. <li class="md-nav__item">
  811. <a href="#systemd-simple" class="md-nav__link">
  812. <span class="md-ellipsis">
  813. systemd (simple)
  814. </span>
  815. </a>
  816. </li>
  817. <li class="md-nav__item">
  818. <a href="#systemd-w-setup-script" class="md-nav__link">
  819. <span class="md-ellipsis">
  820. systemd (w/ setup script)
  821. </span>
  822. </a>
  823. <nav class="md-nav" aria-label="systemd (w/ setup script)">
  824. <ul class="md-nav__list">
  825. <li class="md-nav__item">
  826. <a href="#setup-for-mergerfs" class="md-nav__link">
  827. <span class="md-ellipsis">
  828. setup-for-mergerfs
  829. </span>
  830. </a>
  831. </li>
  832. <li class="md-nav__item">
  833. <a href="#setup-for-mergerfsservice" class="md-nav__link">
  834. <span class="md-ellipsis">
  835. setup-for-mergerfs.service
  836. </span>
  837. </a>
  838. </li>
  839. <li class="md-nav__item">
  840. <a href="#mergerfs-mediaservice" class="md-nav__link">
  841. <span class="md-ellipsis">
  842. mergerfs-media.service
  843. </span>
  844. </a>
  845. </li>
  846. </ul>
  847. </nav>
  848. </li>
  849. </ul>
  850. </nav>
  851. </li>
  852. </ul>
  853. </nav>
  854. </div>
  855. </div>
  856. </div>
  857. <div class="md-content" data-md-component="content">
  858. <article class="md-content__inner md-typeset">
  859. <a href="https://github.com/trapexit/mergerfs/tree/master/mkdocs/docs/quickstart.md" title="Edit this page" class="md-content__button md-icon">
  860. <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>
  861. </a>
  862. <a href="https://github.com/trapexit/mergerfs/tree/master/mkdocs/docs/quickstart.md" title="View source of this page" class="md-content__button md-icon">
  863. <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>
  864. </a>
  865. <h1 id="quickstart">QuickStart</h1>
  866. <h2 id="install">Install</h2>
  867. <p>First ensure you have the <a href="../setup/installation/">latest version installed</a>.</p>
  868. <h2 id="configuration">Configuration</h2>
  869. <p>mergerfs has many options and effectively all of them are functional
  870. in nature. What that means is that there is no "best" or "fastest"
  871. configuration. No "make faster" options. Everything changes
  872. behavior. Sometimes those changes in behavior affect performance.</p>
  873. <p>That said: If you don't already know that you have a special use case
  874. then use one of the following option sets as it will cover most casual
  875. usecases.</p>
  876. <h3 id="you-use-linux-v66-or-above">You use Linux v6.6 or above</h3>
  877. <ul>
  878. <li>cache.files=off</li>
  879. <li>category.create=mfs</li>
  880. <li>dropecacheonclose=false</li>
  881. </ul>
  882. <p>In previous versions of Linux it was unable to support <code>mmap</code> if page
  883. caching was disabled (ie: <code>cache.files=off</code>). However, it now will
  884. enable page caching if needed for a particular file if mmap is
  885. requested.</p>
  886. <p><code>mmap</code> is needed by certain software to read and write to a
  887. file. However, many software could work without it and fail to have
  888. proper error handling. Many programs that use sqlite3 will require
  889. <code>mmap</code> despite sqlite3 working perfectly fine without it (and in some
  890. cases can be more performant with regular file IO.)</p>
  891. <h3 id="you-use-linux-v65-or-below">You use Linux v6.5 or below</h3>
  892. <h4 id="you-need-mmap-used-by-rtorrent-and-many-sqlite3-base-software">You need <code>mmap</code> (used by rtorrent and many sqlite3 base software)</h4>
  893. <ul>
  894. <li>cache.files=auto-full</li>
  895. <li>category.create=mfs</li>
  896. <li>dropcacheonclose=true</li>
  897. </ul>
  898. <h4 id="you-dont-need-mmap">You don't need <code>mmap</code></h4>
  899. <ul>
  900. <li>cache.files=off</li>
  901. <li>category.create=mfs</li>
  902. <li>dropcacheonclose=false</li>
  903. </ul>
  904. <h2 id="usage">Usage</h2>
  905. <h3 id="command-line">Command Line</h3>
  906. <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>mergerfs -o cache.files=off,dropcacheonclose=false,category.create=mfs /mnt/hdd0:/mnt/hdd1 /media
  907. </span></code></pre></div>
  908. <h3 id="etcfstab">/etc/fstab</h3>
  909. <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>/mnt/hdd0:/mnt/hdd1 /media mergerfs cache.files=off,dropcacheonclose=false,category.create=mfs 0 0
  910. </span></code></pre></div>
  911. <h3 id="etcfstab-w-config-file">/etc/fstab w/ config file</h3>
  912. <p>For more complex setups it can be useful to separate out the config.</p>
  913. <h4 id="etcfstab_1">/etc/fstab</h4>
  914. <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>/etc/mergerfs/branches/media/* /media mergerfs config=/etc/mergerfs/config/media.ini
  915. </span></code></pre></div>
  916. <h4 id="etcmergerfsconfigmediaini">/etc/mergerfs/config/media.ini</h4>
  917. <div class="language-ini highlight"><span class="filename">media.ini</span><pre><span></span><code><span id="__span-3-1"><a id="__codelineno-3-1" name="__codelineno-3-1"></a><a href="#__codelineno-3-1"><span class="linenos" data-linenos="1 "></span></a><span class="na">cache.files</span><span class="o">=</span><span class="s">off</span>
  918. </span><span id="__span-3-2"><a id="__codelineno-3-2" name="__codelineno-3-2"></a><a href="#__codelineno-3-2"><span class="linenos" data-linenos="2 "></span></a><span class="na">category.create</span><span class="o">=</span><span class="s">mfs</span>
  919. </span><span id="__span-3-3"><a id="__codelineno-3-3" name="__codelineno-3-3"></a><a href="#__codelineno-3-3"><span class="linenos" data-linenos="3 "></span></a><span class="na">dropcacheonclose</span><span class="o">=</span><span class="s">false</span>
  920. </span></code></pre></div>
  921. <h4 id="etcmergerfsbranchesmedia">/etc/mergerfs/branches/media/</h4>
  922. <p>Create a bunch of symlinks to point to the branch. mergerfs will
  923. resolve the symlinks and use the real path.</p>
  924. <p><code>ls -lh /etc/mergerfs/branches/media/*</code></p>
  925. <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>lrwxrwxrwx 1 root root 21 Aug 4 2023 hdd00 -&gt; /mnt/hdd/hdd00
  926. </span><span id="__span-4-2"><a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a>lrwxrwxrwx 1 root root 21 Aug 4 2023 hdd01 -&gt; /mnt/hdd/hdd01
  927. </span><span id="__span-4-3"><a id="__codelineno-4-3" name="__codelineno-4-3" href="#__codelineno-4-3"></a>lrwxrwxrwx 1 root root 21 Aug 4 2023 hdd02 -&gt; /mnt/hdd/hdd02
  928. </span><span id="__span-4-4"><a id="__codelineno-4-4" name="__codelineno-4-4" href="#__codelineno-4-4"></a>lrwxrwxrwx 1 root root 21 Aug 4 2023 hdd03 -&gt; /mnt/hdd/hdd03
  929. </span></code></pre></div>
  930. <h3 id="systemd-simple">systemd (simple)</h3>
  931. <p><code>/etc/systemd/system/mergerfs-media.service</code></p>
  932. <div class="language-systemd highlight"><span class="filename">mergerfs-media.service</span><pre><span></span><code><span id="__span-5-1"><a id="__codelineno-5-1" name="__codelineno-5-1"></a><a href="#__codelineno-5-1"><span class="linenos" data-linenos=" 1 "></span></a><span class="k">[Unit]</span>
  933. </span><span id="__span-5-2"><a id="__codelineno-5-2" name="__codelineno-5-2"></a><a href="#__codelineno-5-2"><span class="linenos" data-linenos=" 2 "></span></a><span class="na">Description</span><span class="o">=</span><span class="s">mergerfs /media service</span>
  934. </span><span id="__span-5-3"><a id="__codelineno-5-3" name="__codelineno-5-3"></a><a href="#__codelineno-5-3"><span class="linenos" data-linenos=" 3 "></span></a><span class="na">After</span><span class="o">=</span><span class="s">local-fs.target network.target</span>
  935. </span><span id="__span-5-4"><a id="__codelineno-5-4" name="__codelineno-5-4"></a><a href="#__codelineno-5-4"><span class="linenos" data-linenos=" 4 "></span></a>
  936. </span><span id="__span-5-5"><a id="__codelineno-5-5" name="__codelineno-5-5"></a><a href="#__codelineno-5-5"><span class="linenos" data-linenos=" 5 "></span></a><span class="k">[Service]</span>
  937. </span><span id="__span-5-6"><a id="__codelineno-5-6" name="__codelineno-5-6"></a><a href="#__codelineno-5-6"><span class="linenos" data-linenos=" 6 "></span></a><span class="na">Type</span><span class="o">=</span><span class="s">simple</span>
  938. </span><span id="__span-5-7"><a id="__codelineno-5-7" name="__codelineno-5-7"></a><a href="#__codelineno-5-7"><span class="linenos" data-linenos=" 7 "></span></a><span class="na">KillMode</span><span class="o">=</span><span class="s">none</span>
  939. </span><span id="__span-5-8"><a id="__codelineno-5-8" name="__codelineno-5-8"></a><a href="#__codelineno-5-8"><span class="linenos" data-linenos=" 8 "></span></a><span class="na">ExecStart</span><span class="o">=</span><span class="s">/usr/bin/mergerfs </span>\
  940. </span><span id="__span-5-9"><a id="__codelineno-5-9" name="__codelineno-5-9"></a><a href="#__codelineno-5-9"><span class="linenos" data-linenos=" 9 "></span></a><span class="w"> </span><span class="s">-f </span>\
  941. </span><span id="__span-5-10"><a id="__codelineno-5-10" name="__codelineno-5-10"></a><a href="#__codelineno-5-10"><span class="linenos" data-linenos="10 "></span></a><span class="w"> </span><span class="s">-o cache.files=off </span>\
  942. </span><span id="__span-5-11"><a id="__codelineno-5-11" name="__codelineno-5-11"></a><a href="#__codelineno-5-11"><span class="linenos" data-linenos="11 "></span></a><span class="w"> </span><span class="s">-o category.create=mfs </span>\
  943. </span><span id="__span-5-12"><a id="__codelineno-5-12" name="__codelineno-5-12"></a><a href="#__codelineno-5-12"><span class="linenos" data-linenos="12 "></span></a><span class="w"> </span><span class="s">-o dropcacheonclose=false </span>\
  944. </span><span id="__span-5-13"><a id="__codelineno-5-13" name="__codelineno-5-13"></a><a href="#__codelineno-5-13"><span class="linenos" data-linenos="13 "></span></a><span class="w"> </span><span class="s">/mnt/hdd0:/mnt/hdd1 </span>\
  945. </span><span id="__span-5-14"><a id="__codelineno-5-14" name="__codelineno-5-14"></a><a href="#__codelineno-5-14"><span class="linenos" data-linenos="14 "></span></a><span class="w"> </span><span class="s">/media</span>
  946. </span><span id="__span-5-15"><a id="__codelineno-5-15" name="__codelineno-5-15"></a><a href="#__codelineno-5-15"><span class="linenos" data-linenos="15 "></span></a><span class="na">ExecStop</span><span class="o">=</span><span class="s">/bin/fusermount -uz /media</span>
  947. </span><span id="__span-5-16"><a id="__codelineno-5-16" name="__codelineno-5-16"></a><a href="#__codelineno-5-16"><span class="linenos" data-linenos="16 "></span></a><span class="na">Restart</span><span class="o">=</span><span class="s">on-failure</span>
  948. </span><span id="__span-5-17"><a id="__codelineno-5-17" name="__codelineno-5-17"></a><a href="#__codelineno-5-17"><span class="linenos" data-linenos="17 "></span></a>
  949. </span><span id="__span-5-18"><a id="__codelineno-5-18" name="__codelineno-5-18"></a><a href="#__codelineno-5-18"><span class="linenos" data-linenos="18 "></span></a><span class="k">[Install]</span>
  950. </span><span id="__span-5-19"><a id="__codelineno-5-19" name="__codelineno-5-19"></a><a href="#__codelineno-5-19"><span class="linenos" data-linenos="19 "></span></a><span class="na">WantedBy</span><span class="o">=</span><span class="s">default.target</span>
  951. </span></code></pre></div>
  952. <h3 id="systemd-w-setup-script">systemd (w/ setup script)</h3>
  953. <p>Since it isn't well documented otherwise: if you wish to do some setup before
  954. you mount mergerfs follow this example.</p>
  955. <h4 id="setup-for-mergerfs">setup-for-mergerfs</h4>
  956. <p><code>/usr/local/bin/setup-for-mergerfs</code></p>
  957. <div class="language-shell highlight"><span class="filename">setup-for-mergerfs</span><pre><span></span><code><span id="__span-6-1"><a id="__codelineno-6-1" name="__codelineno-6-1"></a><a href="#__codelineno-6-1"><span class="linenos" data-linenos="1 "></span></a><span class="ch">#!/usr/bin/env sh</span>
  958. </span><span id="__span-6-2"><a id="__codelineno-6-2" name="__codelineno-6-2"></a><a href="#__codelineno-6-2"><span class="linenos" data-linenos="2 "></span></a>
  959. </span><span id="__span-6-3"><a id="__codelineno-6-3" name="__codelineno-6-3"></a><a href="#__codelineno-6-3"><span class="linenos" data-linenos="3 "></span></a><span class="c1"># Perform setup</span>
  960. </span><span id="__span-6-4"><a id="__codelineno-6-4" name="__codelineno-6-4"></a><a href="#__codelineno-6-4"><span class="linenos" data-linenos="4 "></span></a>/bin/sleep<span class="w"> </span><span class="m">10</span>
  961. </span><span id="__span-6-5"><a id="__codelineno-6-5" name="__codelineno-6-5"></a><a href="#__codelineno-6-5"><span class="linenos" data-linenos="5 "></span></a>
  962. </span><span id="__span-6-6"><a id="__codelineno-6-6" name="__codelineno-6-6"></a><a href="#__codelineno-6-6"><span class="linenos" data-linenos="6 "></span></a><span class="c1"># Report back to systemd that things are ready</span>
  963. </span><span id="__span-6-7"><a id="__codelineno-6-7" name="__codelineno-6-7"></a><a href="#__codelineno-6-7"><span class="linenos" data-linenos="7 "></span></a>/bin/systemd-notify<span class="w"> </span>--ready
  964. </span></code></pre></div>
  965. <h4 id="setup-for-mergerfsservice">setup-for-mergerfs.service</h4>
  966. <p><code>/etc/systemd/system/setup-for-mergerfs.service</code></p>
  967. <div class="language-systemd highlight"><span class="filename">setup-for-mergerfs.service</span><pre><span></span><code><span id="__span-7-1"><a id="__codelineno-7-1" name="__codelineno-7-1"></a><a href="#__codelineno-7-1"><span class="linenos" data-linenos=" 1 "></span></a><span class="k">[Unit]</span>
  968. </span><span id="__span-7-2"><a id="__codelineno-7-2" name="__codelineno-7-2"></a><a href="#__codelineno-7-2"><span class="linenos" data-linenos=" 2 "></span></a><span class="na">Description</span><span class="o">=</span><span class="s">mergerfs setup service</span>
  969. </span><span id="__span-7-3"><a id="__codelineno-7-3" name="__codelineno-7-3"></a><a href="#__codelineno-7-3"><span class="linenos" data-linenos=" 3 "></span></a>
  970. </span><span id="__span-7-4"><a id="__codelineno-7-4" name="__codelineno-7-4"></a><a href="#__codelineno-7-4"><span class="linenos" data-linenos=" 4 "></span></a><span class="k">[Service]</span>
  971. </span><span id="__span-7-5"><a id="__codelineno-7-5" name="__codelineno-7-5"></a><a href="#__codelineno-7-5"><span class="linenos" data-linenos=" 5 "></span></a><span class="na">Type</span><span class="o">=</span><span class="s">notify</span>
  972. </span><span id="__span-7-6"><a id="__codelineno-7-6" name="__codelineno-7-6"></a><a href="#__codelineno-7-6"><span class="linenos" data-linenos=" 6 "></span></a><span class="na">RemainAfterExit</span><span class="o">=</span><span class="s">yes</span>
  973. </span><span id="__span-7-7"><a id="__codelineno-7-7" name="__codelineno-7-7"></a><a href="#__codelineno-7-7"><span class="linenos" data-linenos=" 7 "></span></a><span class="na">ExecStart</span><span class="o">=</span><span class="s">/usr/local/bin/setup-for-mergerfs</span>
  974. </span><span id="__span-7-8"><a id="__codelineno-7-8" name="__codelineno-7-8"></a><a href="#__codelineno-7-8"><span class="linenos" data-linenos=" 8 "></span></a>
  975. </span><span id="__span-7-9"><a id="__codelineno-7-9" name="__codelineno-7-9"></a><a href="#__codelineno-7-9"><span class="linenos" data-linenos=" 9 "></span></a><span class="k">[Install]</span>
  976. </span><span id="__span-7-10"><a id="__codelineno-7-10" name="__codelineno-7-10"></a><a href="#__codelineno-7-10"><span class="linenos" data-linenos="10 "></span></a><span class="na">WantedBy</span><span class="o">=</span><span class="s">default.target</span>
  977. </span></code></pre></div>
  978. <h4 id="mergerfs-mediaservice">mergerfs-media.service</h4>
  979. <p><code>/etc/systemd/system/mergerfs-media.service</code></p>
  980. <div class="language-systemd highlight"><span class="filename">mergerfs-media.service</span><pre><span></span><code><span id="__span-8-1"><a id="__codelineno-8-1" name="__codelineno-8-1"></a><a href="#__codelineno-8-1"><span class="linenos" data-linenos=" 1 "></span></a><span class="k">[Unit]</span>
  981. </span><span id="__span-8-2"><a id="__codelineno-8-2" name="__codelineno-8-2"></a><a href="#__codelineno-8-2"><span class="linenos" data-linenos=" 2 "></span></a><span class="na">Description</span><span class="o">=</span><span class="s">mergerfs /media service</span>
  982. </span><span id="__span-8-3"><a id="__codelineno-8-3" name="__codelineno-8-3"></a><a href="#__codelineno-8-3"><span class="linenos" data-linenos=" 3 "></span></a><span class="na">Requires</span><span class="o">=</span><span class="s">setup-for-mergerfs.service</span>
  983. </span><span id="__span-8-4"><a id="__codelineno-8-4" name="__codelineno-8-4"></a><a href="#__codelineno-8-4"><span class="linenos" data-linenos=" 4 "></span></a><span class="na">After</span><span class="o">=</span><span class="s">local-fs.target network.target prepare-for-mergerfs.service</span>
  984. </span><span id="__span-8-5"><a id="__codelineno-8-5" name="__codelineno-8-5"></a><a href="#__codelineno-8-5"><span class="linenos" data-linenos=" 5 "></span></a>
  985. </span><span id="__span-8-6"><a id="__codelineno-8-6" name="__codelineno-8-6"></a><a href="#__codelineno-8-6"><span class="linenos" data-linenos=" 6 "></span></a><span class="k">[Service]</span>
  986. </span><span id="__span-8-7"><a id="__codelineno-8-7" name="__codelineno-8-7"></a><a href="#__codelineno-8-7"><span class="linenos" data-linenos=" 7 "></span></a><span class="na">Type</span><span class="o">=</span><span class="s">simple</span>
  987. </span><span id="__span-8-8"><a id="__codelineno-8-8" name="__codelineno-8-8"></a><a href="#__codelineno-8-8"><span class="linenos" data-linenos=" 8 "></span></a><span class="na">KillMode</span><span class="o">=</span><span class="s">none</span>
  988. </span><span id="__span-8-9"><a id="__codelineno-8-9" name="__codelineno-8-9"></a><a href="#__codelineno-8-9"><span class="linenos" data-linenos=" 9 "></span></a><span class="na">ExecStart</span><span class="o">=</span><span class="s">/usr/bin/mergerfs </span>\
  989. </span><span id="__span-8-10"><a id="__codelineno-8-10" name="__codelineno-8-10"></a><a href="#__codelineno-8-10"><span class="linenos" data-linenos="10 "></span></a><span class="w"> </span><span class="s">-f </span>\
  990. </span><span id="__span-8-11"><a id="__codelineno-8-11" name="__codelineno-8-11"></a><a href="#__codelineno-8-11"><span class="linenos" data-linenos="11 "></span></a><span class="w"> </span><span class="s">-o cache.files=off </span>\
  991. </span><span id="__span-8-12"><a id="__codelineno-8-12" name="__codelineno-8-12"></a><a href="#__codelineno-8-12"><span class="linenos" data-linenos="12 "></span></a><span class="w"> </span><span class="s">-o category.create=mfs </span>\
  992. </span><span id="__span-8-13"><a id="__codelineno-8-13" name="__codelineno-8-13"></a><a href="#__codelineno-8-13"><span class="linenos" data-linenos="13 "></span></a><span class="w"> </span><span class="s">-o dropcacheonclose=false </span>\
  993. </span><span id="__span-8-14"><a id="__codelineno-8-14" name="__codelineno-8-14"></a><a href="#__codelineno-8-14"><span class="linenos" data-linenos="14 "></span></a><span class="w"> </span><span class="s">/mnt/hdd0:/mnt/hdd1 </span>\
  994. </span><span id="__span-8-15"><a id="__codelineno-8-15" name="__codelineno-8-15"></a><a href="#__codelineno-8-15"><span class="linenos" data-linenos="15 "></span></a><span class="w"> </span><span class="s">/media</span>
  995. </span><span id="__span-8-16"><a id="__codelineno-8-16" name="__codelineno-8-16"></a><a href="#__codelineno-8-16"><span class="linenos" data-linenos="16 "></span></a><span class="na">ExecStop</span><span class="o">=</span><span class="s">/bin/fusermount -uz /media</span>
  996. </span><span id="__span-8-17"><a id="__codelineno-8-17" name="__codelineno-8-17"></a><a href="#__codelineno-8-17"><span class="linenos" data-linenos="17 "></span></a><span class="na">Restart</span><span class="o">=</span><span class="s">on-failure</span>
  997. </span><span id="__span-8-18"><a id="__codelineno-8-18" name="__codelineno-8-18"></a><a href="#__codelineno-8-18"><span class="linenos" data-linenos="18 "></span></a>
  998. </span><span id="__span-8-19"><a id="__codelineno-8-19" name="__codelineno-8-19"></a><a href="#__codelineno-8-19"><span class="linenos" data-linenos="19 "></span></a><span class="k">[Install]</span>
  999. </span><span id="__span-8-20"><a id="__codelineno-8-20" name="__codelineno-8-20"></a><a href="#__codelineno-8-20"><span class="linenos" data-linenos="20 "></span></a><span class="na">WantedBy</span><span class="o">=</span><span class="s">default.target</span>
  1000. </span></code></pre></div>
  1001. </article>
  1002. </div>
  1003. <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
  1004. </div>
  1005. <button type="button" class="md-top md-icon" data-md-component="top" hidden>
  1006. <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>
  1007. Back to top
  1008. </button>
  1009. </main>
  1010. <footer class="md-footer">
  1011. <nav class="md-footer__inner md-grid" aria-label="Footer" >
  1012. <a href=".." class="md-footer__link md-footer__link--prev" aria-label="Previous: Home">
  1013. <div class="md-footer__button md-icon">
  1014. <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>
  1015. </div>
  1016. <div class="md-footer__title">
  1017. <span class="md-footer__direction">
  1018. Previous
  1019. </span>
  1020. <div class="md-ellipsis">
  1021. Home
  1022. </div>
  1023. </div>
  1024. </a>
  1025. <a href="../setup/installation/" class="md-footer__link md-footer__link--next" aria-label="Next: Installation">
  1026. <div class="md-footer__title">
  1027. <span class="md-footer__direction">
  1028. Next
  1029. </span>
  1030. <div class="md-ellipsis">
  1031. Installation
  1032. </div>
  1033. </div>
  1034. <div class="md-footer__button md-icon">
  1035. <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>
  1036. </div>
  1037. </a>
  1038. </nav>
  1039. <div class="md-footer-meta md-typeset">
  1040. <div class="md-footer-meta__inner md-grid">
  1041. <div class="md-copyright">
  1042. Made with
  1043. <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
  1044. Material for MkDocs
  1045. </a>
  1046. </div>
  1047. </div>
  1048. </div>
  1049. </footer>
  1050. </div>
  1051. <div class="md-dialog" data-md-component="dialog">
  1052. <div class="md-dialog__inner md-typeset"></div>
  1053. </div>
  1054. <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.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>
  1055. <script src="../assets/javascripts/bundle.88dd0f4e.min.js"></script>
  1056. </body>
  1057. </html>