|
|
<!doctype html><html lang="en" class="no-js"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width,initial-scale=1"> <meta name="description" content="mergerfs - a featureful union filesystem"> <link rel="canonical" href="https://trapexit.github.io/mergerfs/pages/faq/compatibility_and_integration/"> <link rel="prev" href="../../documentation/links/"> <link rel="next" href="../configuration_and_policies/"> <link rel="icon" href="../../../assets/images/favicon.png"> <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.49"> <title>Compatibility and Integration - mergerfs</title> <link rel="stylesheet" href="../../../assets/stylesheets/main.6f8fc17f.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin> <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"> <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style> <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>
</head> <body dir="ltr"> <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off"> <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off"> <label class="md-overlay" for="__drawer"></label> <div data-md-component="skip"> <a href="#compatibility-and-integration" class="md-skip"> Skip to content </a> </div> <div data-md-component="announce"> </div>
<header class="md-header md-header--shadow" data-md-component="header"> <nav class="md-header__inner md-grid" aria-label="Header"> <a href="../../.." title="mergerfs" class="md-header__button md-logo" aria-label="mergerfs" data-md-component="logo"> <img src="../../../logo.jpeg" alt="logo">
</a> <label class="md-header__button md-icon" for="__drawer"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg> </label> <div class="md-header__title" data-md-component="header-title"> <div class="md-header__ellipsis"> <div class="md-header__topic"> <span class="md-ellipsis"> mergerfs </span> </div> <div class="md-header__topic" data-md-component="header-topic"> <span class="md-ellipsis"> Compatibility and Integration </span> </div> </div> </div> <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> <label class="md-header__button md-icon" for="__search"> <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> </label> <div class="md-search" data-md-component="search" role="dialog"> <label class="md-search__overlay" for="__search"></label> <div class="md-search__inner" role="search"> <form class="md-search__form" name="search"> <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> <label class="md-search__icon md-icon" for="__search"> <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> <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> </label> <nav class="md-search__options" aria-label="Search"> <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1"> <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> </button> </nav> </form> <div class="md-search__output"> <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix> <div class="md-search-result" data-md-component="search-result"> <div class="md-search-result__meta"> Initializing search </div> <ol class="md-search-result__list" role="presentation"></ol> </div> </div> </div> </div></div> <div class="md-header__source"> <a href="https://github.com/trapexit/mergerfs" title="Go to repository" class="md-source" data-md-component="source"> <div class="md-source__icon md-icon"> <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> </div> <div class="md-source__repository"> mergerfs </div></a> </div> </nav> </header> <div class="md-container" data-md-component="container"> <main class="md-main" data-md-component="main"> <div class="md-main__inner md-grid"> <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" > <div class="md-sidebar__scrollwrap"> <div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0"> <label class="md-nav__title" for="__drawer"> <a href="../../.." title="mergerfs" class="md-nav__button md-logo" aria-label="mergerfs" data-md-component="logo"> <img src="../../../logo.jpeg" alt="logo">
</a> mergerfs </label> <div class="md-nav__source"> <a href="https://github.com/trapexit/mergerfs" title="Go to repository" class="md-source" data-md-component="source"> <div class="md-source__icon md-icon"> <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> </div> <div class="md-source__repository"> mergerfs </div></a> </div> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../.." class="md-nav__link"> <span class="md-ellipsis"> About </span>
</a> </li>
<li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" > <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0"> <span class="md-ellipsis"> Documentation </span>
<span class="md-nav__icon md-icon"></span> </label> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_2"> <span class="md-nav__icon md-icon"></span> Documentation </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../documentation/how_it_works/" class="md-nav__link"> <span class="md-ellipsis"> HOW IT WORKS </span>
</a> </li>
<li class="md-nav__item"> <a href="../../documentation/terminology/" class="md-nav__link"> <span class="md-ellipsis"> TERMINOLOGY </span>
</a> </li>
<li class="md-nav__item"> <a href="../../documentation/basic_setup/" class="md-nav__link"> <span class="md-ellipsis"> BASIC SETUP </span>
</a> </li>
<li class="md-nav__item"> <a href="../../documentation/options/" class="md-nav__link"> <span class="md-ellipsis"> OPTIONS </span>
</a> </li>
<li class="md-nav__item"> <a href="../../documentation/functions_categories_and_policies/" class="md-nav__link"> <span class="md-ellipsis"> FUNCTIONS, CATEGORIES and POLICIES </span>
</a> </li>
<li class="md-nav__item"> <a href="../../documentation/error_handling/" class="md-nav__link"> <span class="md-ellipsis"> ERROR HANDLING </span>
</a> </li>
<li class="md-nav__item"> <a href="../../documentation/install/" class="md-nav__link"> <span class="md-ellipsis"> INSTALL </span>
</a> </li>
<li class="md-nav__item"> <a href="../../documentation/build/" class="md-nav__link"> <span class="md-ellipsis"> BUILD </span>
</a> </li>
<li class="md-nav__item"> <a href="../../documentation/upgrade/" class="md-nav__link"> <span class="md-ellipsis"> UPGRADE </span>
</a> </li>
<li class="md-nav__item"> <a href="../../documentation/runtime_interfaces/" class="md-nav__link"> <span class="md-ellipsis"> RUNTIME INTERFACES </span>
</a> </li>
<li class="md-nav__item"> <a href="../../documentation/tooling/" class="md-nav__link"> <span class="md-ellipsis"> TOOLING </span>
</a> </li>
<li class="md-nav__item"> <a href="../../documentation/caching/" class="md-nav__link"> <span class="md-ellipsis"> CACHING </span>
</a> </li>
<li class="md-nav__item"> <a href="../../documentation/performance/" class="md-nav__link"> <span class="md-ellipsis"> PERFORMANCE </span>
</a> </li>
<li class="md-nav__item"> <a href="../../documentation/benchmarking/" class="md-nav__link"> <span class="md-ellipsis"> BENCHMARKING </span>
</a> </li>
<li class="md-nav__item"> <a href="../../documentation/tips_notes/" class="md-nav__link"> <span class="md-ellipsis"> TIPS / NOTES </span>
</a> </li>
<li class="md-nav__item"> <a href="../../documentation/known_issues_bugs/" class="md-nav__link"> <span class="md-ellipsis"> KNOWN ISSUES / BUGS </span>
</a> </li>
<li class="md-nav__item"> <a href="../../documentation/remote_filesystems/" class="md-nav__link"> <span class="md-ellipsis"> Remote Filesystems </span>
</a> </li>
<li class="md-nav__item"> <a href="../../documentation/mergerfs_versus_x/" class="md-nav__link"> <span class="md-ellipsis"> mergerfs versus X </span>
</a> </li>
<li class="md-nav__item"> <a href="../../documentation/support/" class="md-nav__link"> <span class="md-ellipsis"> SUPPORT </span>
</a> </li>
<li class="md-nav__item"> <a href="../../documentation/links/" class="md-nav__link"> <span class="md-ellipsis"> LINKS </span>
</a> </li>
</ul> </nav> </li>
<li class="md-nav__item md-nav__item--active md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" checked> <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0"> <span class="md-ellipsis"> FAQ </span>
<span class="md-nav__icon md-icon"></span> </label> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="true"> <label class="md-nav__title" for="__nav_3"> <span class="md-nav__icon md-icon"></span> FAQ </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item md-nav__item--active"> <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc"> <label class="md-nav__link md-nav__link--active" for="__toc"> <span class="md-ellipsis"> Compatibility and Integration </span>
<span class="md-nav__icon md-icon"></span> </label> <a href="./" class="md-nav__link md-nav__link--active"> <span class="md-ellipsis"> Compatibility and Integration </span>
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents"> <label class="md-nav__title" for="__toc"> <span class="md-nav__icon md-icon"></span> Table of contents </label> <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix> <li class="md-nav__item"> <a href="#can-i-use-mergerfs-without-snapraid-snapraid-without-mergerfs" class="md-nav__link"> <span class="md-ellipsis"> Can I use mergerfs without SnapRAID? SnapRAID without mergerfs? </span> </a> </li> <li class="md-nav__item"> <a href="#can-mergerfs-run-via-docker-podman-kubernetes-etc" class="md-nav__link"> <span class="md-ellipsis"> Can mergerfs run via Docker, Podman, Kubernetes, etc. </span> </a> </li> <li class="md-nav__item"> <a href="#does-mergerfs-support-cow-copy-on-write-writes-to-read-only-filesystems" class="md-nav__link"> <span class="md-ellipsis"> Does mergerfs support CoW / copy-on-write / writes to read-only filesystems? </span> </a> </li> </ul> </nav> </li>
<li class="md-nav__item"> <a href="../configuration_and_policies/" class="md-nav__link"> <span class="md-ellipsis"> Configuration and Policies </span>
</a> </li>
<li class="md-nav__item"> <a href="../general_information_and_overview/" class="md-nav__link"> <span class="md-ellipsis"> General Information and Overview </span>
</a> </li>
<li class="md-nav__item"> <a href="../recommendations_and_warnings/" class="md-nav__link"> <span class="md-ellipsis"> Recommendations and Warnings </span>
</a> </li>
<li class="md-nav__item"> <a href="../technical_behavior_and_limitations/" class="md-nav__link"> <span class="md-ellipsis"> Technical Behavior and Limitations </span>
</a> </li>
<li class="md-nav__item"> <a href="../usage_and_functionality/" class="md-nav__link"> <span class="md-ellipsis"> Usage and Functionality </span>
</a> </li>
</ul> </nav> </li>
<li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" > <label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0"> <span class="md-ellipsis"> Wiki </span>
<span class="md-nav__icon md-icon"></span> </label> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false"> <label class="md-nav__title" for="__nav_4"> <span class="md-nav__icon md-icon"></span> Wiki </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../../wiki/projects_using_mergerfs/" class="md-nav__link"> <span class="md-ellipsis"> Projects incorporating mergerfs directly in some way </span>
</a> </li>
<li class="md-nav__item"> <a href="../../wiki/installing_mergerfs_on_a_synology_nas/" class="md-nav__link"> <span class="md-ellipsis"> Installing mergerfs on a synology nas </span>
</a> </li>
<li class="md-nav__item"> <a href="../../wiki/testimonials/" class="md-nav__link"> <span class="md-ellipsis"> Testimonials </span>
</a> </li>
<li class="md-nav__item"> <a href="../../wiki/real_world_deployments/" class="md-nav__link"> <span class="md-ellipsis"> trapexit's (mergerfs' author) </span>
</a> </li>
<li class="md-nav__item"> <a href="../../wiki/systemd/" class="md-nav__link"> <span class="md-ellipsis"> systemd </span>
</a> </li>
<li class="md-nav__item"> <a href="../../wiki/kernel_issues_and_bugs/" class="md-nav__link"> <span class="md-ellipsis"> Kernel issues and bugs </span>
</a> </li>
<li class="md-nav__item"> <a href="../../wiki/featured_media_and_publicity/" class="md-nav__link"> <span class="md-ellipsis"> Featured Media and Publicity </span>
</a> </li>
<li class="md-nav__item"> <a href="../../wiki/limit_drive_spinup/" class="md-nav__link"> <span class="md-ellipsis"> Limit drive spinup </span>
</a> </li>
<li class="md-nav__item"> <a href="../../wiki/links/" class="md-nav__link"> <span class="md-ellipsis"> Links </span>
</a> </li>
</ul> </nav> </li>
</ul></nav> </div> </div> </div> <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" > <div class="md-sidebar__scrollwrap"> <div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents"> <label class="md-nav__title" for="__toc"> <span class="md-nav__icon md-icon"></span> Table of contents </label> <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix> <li class="md-nav__item"> <a href="#can-i-use-mergerfs-without-snapraid-snapraid-without-mergerfs" class="md-nav__link"> <span class="md-ellipsis"> Can I use mergerfs without SnapRAID? SnapRAID without mergerfs? </span> </a> </li> <li class="md-nav__item"> <a href="#can-mergerfs-run-via-docker-podman-kubernetes-etc" class="md-nav__link"> <span class="md-ellipsis"> Can mergerfs run via Docker, Podman, Kubernetes, etc. </span> </a> </li> <li class="md-nav__item"> <a href="#does-mergerfs-support-cow-copy-on-write-writes-to-read-only-filesystems" class="md-nav__link"> <span class="md-ellipsis"> Does mergerfs support CoW / copy-on-write / writes to read-only filesystems? </span> </a> </li> </ul> </nav> </div> </div> </div> <div class="md-content" data-md-component="content"> <article class="md-content__inner md-typeset">
<a href="https://github.com/trapexit/mergerfs/tree/master/mkdocs/docs/pages/faq/compatibility_and_integration.md" title="Edit this page" class="md-content__button md-icon"> <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> </a>
<h1 id="compatibility-and-integration">Compatibility and Integration</h1><h2 id="can-i-use-mergerfs-without-snapraid-snapraid-without-mergerfs">Can I use mergerfs without SnapRAID? SnapRAID without mergerfs?</h2><p>Yes. They are completely unrelated pieces of software.</p><h2 id="can-mergerfs-run-via-docker-podman-kubernetes-etc">Can mergerfs run via Docker, Podman, Kubernetes, etc.</h2><p>Yes. With Docker you'll need to include <code>--cap-add=SYS_ADMIN--device=/dev/fuse --security-opt=apparmor:unconfined</code> or similar withother container runtimes. You should also be running it as root orgiven sufficient caps to change user and group identity as well ashave root like filesystem permissions.</p><p>Keep in mind that you <strong>MUST</strong> consider identity when usingcontainers. For example: supplemental groups will be picked up fromthe container unless you properly manage users and groups by sharingrelevant /etc files or by using some other means to share identityacross containers. Similarly, if you use "rootless" containers and usernamespaces to do uid/gid translations you <strong>MUST</strong> consider that whilemanaging shared files.</p><p>Also, as mentioned by <a href="https://hotio.dev/containers/mergerfs">hotio</a>,with Docker you should probably be mounting with <code>bind-propagation</code>set to <code>slave</code>.</p><h2 id="does-mergerfs-support-cow-copy-on-write-writes-to-read-only-filesystems">Does mergerfs support CoW / copy-on-write / writes to read-only filesystems?</h2><p>Not in the sense of a filesystem like BTRFS or ZFS nor in theoverlayfs or aufs sense. It does offer a<a href="http://manpages.ubuntu.com/manpages/bionic/man1/cow-shell.1.html">cow-shell</a>like hard link breaking (copy to temp file then rename over original)which can be useful when wanting to save space by hardlinkingduplicate files but wish to treat each name as if it were a unique andseparate file.</p><p>If you want to write to a read-only filesystem you should look atoverlayfs. You can always include the overlayfs mount into a mergerfspool.</p>
</article> </div> <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script> </div> </main> <footer class="md-footer"> <div class="md-footer-meta md-typeset"> <div class="md-footer-meta__inner md-grid"> <div class="md-copyright"> Made with <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener"> Material for MkDocs </a> </div> </div> </div></footer> </div> <div class="md-dialog" data-md-component="dialog"> <div class="md-dialog__inner md-typeset"></div> </div> <script id="__config" type="application/json">{"base": "../../..", "features": ["content.action.edit"], "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> <script src="../../../assets/javascripts/bundle.88dd0f4e.min.js"></script> </body></html>
|
