From b49ce8e95843ac1f7ea23d9dac037597fdbcb49f Mon Sep 17 00:00:00 2001 From: Giuseppe Scrivano Date: Sat, 30 Jun 2018 12:45:11 +0200 Subject: [PATCH] README.md: add more information Signed-off-by: Giuseppe Scrivano --- README.md | 27 ++++++++++++++++++++++++--- 1 file changed, 24 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 1043ebb..65d1657 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,32 @@ containerfs -========== +=========== -An over complex implementation of overlay in FUSE. +An implementation of overlay+shiftfs in FUSE for rootless containers. + +Known issues: +======================================================= + +A known issue is that containerfs reports a different inode even +if the inode on disk is the same, as with hard links. + +The current implementation keeps in memory the entire tree of the +lower directories. A side effect is that modifications to the +lower layers is never propagated to the merged directory. Overlayfs +doesn't allow changes to the layers as well, altough since there is +not such caching done, changes are usually propagated. + +Read-only mode is not supported, so it is always required to specify +an upperdir and a workingdir. Usage: ======================================================= ``` -./containerfs -o lowerdir=lowerdir/a:lowerdir/b,upperdir=up,workdir=workdir merged +$ containerfs -o lowerdir=lowerdir/a:lowerdir/b,upperdir=up,workdir=workdir merged +``` + +Specify a different UID/GID mapping: + +``` +$ containerfs -o uid=0:10:100:100:10000:2000,gid=0:10:100:100:10000:2000,lowerdir=lowerdir/a:lowerdir/b,upperdir=up,workdir=workdir merged ```