Add instructions for using FUSE OverlayFS for the runtime (closes #67, …

…closes #214)
filips123 · Sep 25, 2023 · f45b6ed · f45b6ed
1 parent 3b9d170
commit f45b6ed
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/docs/docs/help/faq.md b/docs/docs/help/faq.md
@@ -214,6 +214,19 @@ runtime](../user-guide/extension.md#patch-profiles-and-runtime) from the extensi
         4. Rename `Waterfox.app` directory in the runtime directory to `Firefox.app`.
         5. Open Terminal inside `Firefox.app/Contents/MacOS` and run: `ln waterfox firefox`.
 
+### How to use FUSE OverlayFS with the app browser?
+
+On compatible Linux distributions, it is possible to use FUSE OverlayFS to link your global
+Firefox installation with the PWAsForFirefox runtime. This removes the need to manage and
+store two separate Firefox installations, but requires an additional setup.
+
+Detailed instructions are available [in the GitHub gist](https://gist.github.com/filips123/29fb511a01ee8016a927a614f32979d3#file-readme-md).
+
+!!! warning
+
+    Using FUSE OverlayFS is not regularly tested and may not work with all Firefox versions
+    that distributions provide.
+
 ### How to make the web app titlebar look more native?
 
 The project aims to make installed web apps look native. However, due to a large number of

diff --git a/extension/src/setup/install.html b/extension/src/setup/install.html
@@ -133,6 +133,12 @@ <h1 class="text-center">Setup Progressive Web Apps for Firefox</h1>
                           <li>Inside that directory, symlink the main binary of your browser (for example, <kbd>librewolf.exe</kbd>/<kbd>librewolf-bin</kbd>) as <kbd>firefox.exe</kbd>/<kbd>firefox</kbd>.</li>
                         </ol>
                       </div>
+                      <div style="padding-left: 1rem;" class="pb-1">
+                        <strong>Linking the global Firefox installation with FUSE OverlayFS:</strong>
+                        <ol>
+                          <li>Instructions are available <a href="https://pwasforfirefox.filips.si/help/faq/#how-to-use-fuse-overlayfs-with-the-app-browser" target="_blank">on the documentation website</a>.</li>
+                        </ol>
+                      </div>
                       <div style="padding-left: 1rem;" class="pb-1">
                         <strong>Default runtime locations:</strong>
                         <ul>