README.md: add more information

Signed-off-by: Giuseppe Scrivano <gscrivan@redhat.com>
This commit is contained in:
Giuseppe Scrivano 2018-06-30 12:45:11 +02:00
parent 54d1c2157f
commit b49ce8e958
No known key found for this signature in database
GPG Key ID: E4730F97F60286ED

View File

@ -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
```