aboutsummaryrefslogtreecommitdiff
path: root/system/fuse-overlayfs/README
diff options
context:
space:
mode:
Diffstat (limited to 'system/fuse-overlayfs/README')
-rw-r--r--system/fuse-overlayfs/README19
1 files changed, 19 insertions, 0 deletions
diff --git a/system/fuse-overlayfs/README b/system/fuse-overlayfs/README
new file mode 100644
index 0000000000000..a9c9a2dc3854a
--- /dev/null
+++ b/system/fuse-overlayfs/README
@@ -0,0 +1,19 @@
+fuse-overlayfs
+
+An implementation of overlay+shiftfs in FUSE for rootless containers.
+
+# Limitations:
+Read-only mode is not supported, so it is always required to specify an
+upperdir and a workingdir.
+
+# Usage:
+
+```shell
+$ fuse-overlayfs -o lowerdir=lowerdir/a:lowerdir/b,upperdir=up,workdir=workdir merged
+```
+
+Specify a different UID/GID mapping:
+
+```shell
+$ fuse-overlayfs -o uidmapping=0:10:100:100:10000:2000,gidmapping=0:10:100:100:10000:2000,lowerdir=lowerdir/a:lowerdir/b,upperdir=up,workdir=workdir merged
+```