fuse-overlayfs.1

.nh
.TH fuse\-overlayfs 1 "User Commands"

.SH NAME
.PP
fuse\-overlayfs \- overlayfs FUSE implementation


.SH SYNOPSIS
.PP
mounting
    fuse\-overlayfs [\-f] [\-\-debug] [\-o OPTS] MOUNT\_TARGET

.PP
unmounting
    fusermount \-u mountpoint


.SH DESCRIPTION
.PP
fuse\-overlayfs provides an overlayfs FUSE implementation so that it
can be used since Linux 4.18 by unprivileged users in an user
namespace.


.SH OPTIONS
.PP
\fB\-\-debug\fP
Enable debugging mode, can be very noisy.

.PP
\fB\-o lowerdir=low1[:low2...]\fP
A list of directories separated by \fB\fC:\fR\&.  Their content is merged.

.PP
\fB\-o upperdir=upperdir\fP
A directory merged on top of all the lowerdirs where all the changes
done to the file system will be written.

.PP
\fB\-o workdir=workdir\fP
A directory used internally by fuse\-overlays, must be on the same file
system as the upper dir.

.PP
\fB\-o uidmapping=UID:MAPPED\-UID:LEN[,UID2:MAPPED\-UID2:LEN2]\fP
\fB\-o gidmapping=GID:MAPPED\-GID:LEN[,GID2:MAPPED\-GID2:LEN2]\fP
Specifies the dynamic UID/GID mapping used by fuse\-overlayfs when
reading/writing files to the system.

.PP
The fuse\-overlayfs dynamic mapping is an alternative and cheaper way
to chown'ing the files on the host to accommodate the user namespace
settings.

.PP
It is useful to share the same storage among different user namespaces
and counter effect the mapping done by the user namespace itself, and
without requiring to chown the files.

.PP
For example, given on the host two files like:

.PP
$ stat \-c %u:%g lower/a lower/b
0:0
1:1

.PP
When we run in a user namespace with the following configuration:
$ cat /proc/self/uid\_map
         0       1000          1
         1     110000      65536

.PP
We would see:

.PP
$ stat \-c %u:%g merged/a merged/b
65534:65534
65534:65534

.PP
65534 is the overflow id used when the UID/GID is not known inside the
user namespace.  This happens because both users 0:0 and 1:1 are not
mapped.

.PP
In the above example, if we mount the fuse\-overlayfs file system using:
\fB\fC\-ouidmapping=0:1000:1:1:110000:65536,gidmapping=0:1000:1:1:110000:65536\fR,
which is the namespace configuration specified on a single line, we'd
see from the same user namespace:

.PP
$ stat \-c %u:%g merged/a merged/b
0:0
1:1

.PP
Those are the same IDs visible from outside the user namespace.

.PP
\fB\-o squash\_to\_root\fP
Every file and directory is owned by the root user (0:0).

.PP
\fB\-o squash\_to\_uid=uid\fP
\fB\-o squash\_to\_gid=gid\fP
Every file and directory is owned by the specified uid or gid.

.PP
It has higher precedence over \fBsquash\_to\_root\fP\&.

.PP
\fB\-o static\_nlink\fP
Set st\_nlink to the static value 1 for all directories.

.PP
This can be useful for higher latency file systems such as NFS, where
counting the number of hard links for a directory with many files can
be a slow operation. With this option enabled, the number of hard
links reported when running stat for any directory is 1.


.SH SEE ALSO
.PP
\fBfuse\fP(8), \fBmount\fP(8), \fBuser\_namespaces\fP(7)


.SH AVAILABILITY
.PP
The fuse\-overlayfs command is available from
\fBhttps://github.com/containers/fuse\-overlayfs\fP under GNU GENERAL PUBLIC LICENSE Version 3 or later.