Unionfs is a filesystem service for Linux, FreeBSD and NetBSD which implements a union mount for other file systems. It allows files and directories of separate file systems, known as branches, to be transparently overlaid, forming a single coherent file system. Contents of directories which have the same path within the merged branches will be seen together in a single merged directory, within the new, virtual filesystem.
|Developer(s)||Open Source Community|
|Full name||Unification File System|
|File system permissions||POSIX|
|Transparent encryption||No (but can be provided at the block device level)|
|Supported operating systems||Linux, FreeBSD and NetBSD|
When mounting branches, the priority of one branch over the other is specified. So when both branches contain a file with the same name, one gets priority over the other.
The different branches may be either read-only or read-write file systems, so that writes to the virtual, merged copy are directed to a specific real file system. This allows a file system to appear as writable, but without actually allowing writes to change the file system, also known as copy-on-write. This may be desirable when the media is physically read-only, such as in the case of Live CDs.
Unionfs was originally developed by Professor Erez Zadok and his team at Stony Brook University.
In Knoppix, a union between the file system on the CD-ROM or DVD and a file system contained in an image file called knoppix.img (knoppix-data.img for Knoppix 7) on a writable drive (such as a USB memory stick) can be made, where the writable drive has priority over the read-only filesystem. This allows the user to change any of the files on the system, with the new file stored in the image and transparently used instead of the one on the CD.
Unionfs can also be used to create a single common template for a number of file systems, or for security reasons. It is sometimes used as an ad hoc snapshotting system.
Docker uses Unionfs to layer Docker images. As actions are done to a base image, layers are created and documented, such that each layer fully describes how to recreate an action. This strategy enables Docker's lightweight images, as only layer updates need to be propagated (compared to full VMs, for example).
Unionfs for Linux has two versions. Version 1.x is a standalone one that can be built as a module. Version 2.x is a newer, redesigned, and reimplemented one.
aufs is an alternative version of unionfs.
overlayfs written by Miklos Szeredi has been used in OpenWRT and considered by Ubuntu and has been merged into the mainline Linux kernel on 26 October 2014 after many years of development and discussion for version 3.18 of the kernel.
unionfs-fuse is an independent project, implemented as a user space filesystem program, instead of a kernel module or patch. Like Unionfs, it supports copy-on-write and read-only or read-write branches.
Union mounts have also been available in BSD since at least 1995.
The GNU Hurd has an implementation of Unionfs. As of January 2008, it works, but results in a read-only mount-point.
mhddfs works like Unionfs but permits balancing files over drives with the most free space available. It is implemented as a user space filesystem.
Sun Microsystems introduced the first implementation of a stacked, layered file system with copy-on-write, whiteouts (hiding files in lower layers from higher layers), etc. as the Translucent File Service in SunOS 3, circa 1986.
- Wright, Charles P.; Zadok, Erez (December 2004). "Kernel Korner: Unionfs: Bringing Filesystems Together". Linux Journal. 2004 (128): 8. ISSN 1075-3583.
- "Git server of File systems and Storage Lab". Stony Brook University. Archived from the original on 17 June 2016. Retrieved 17 July 2017.
Project: unionfs-3.9.y.git; Owner: Erez Zadok
- "File systems and Storage Lab: CS Department". Stony Brook University.
Lab Coordinator and Principal Investigator: Prof. Erez Zadok
- Schulz, Werner P. (15 December 2016). "Hard drive Installation: UNIONFS". Knoppix. Retrieved 17 July 2017.
- "Docker overview: Union file systems". Docker, Inc. 13 July 2017. Retrieved 17 July 2017.
- Georgopoulos, Alkis (24 December 2010). "UbuntuLTSP/LTSPWithoutNFS". Retrieved 17 July 2017.
- "aufs Homepage". 2 July 2017. Retrieved 17 July 2017.
- Torvalds, Linus (26 October 2014). "overlayfs merge + leak fix for d_splice_alias() failure exits". Retrieved 17 July 2017.
- Corbet, Jonathan (15 June 2011). "Debating overlayfs". Retrieved 17 July 2017.
- Podgorny, Radek (21 November 2016). "unionfs-fuse - A userspace unionfs implementation". Retrieved 17 July 2017.
- Pendry, Jan-Simon; McKusick, Marshall Kirk (January 1995). "Union Mounts in 4.4BSD-Lite". USENIX 1995 Technical Conference Proceedings. Retrieved 17 July 2017.
- Schwinge, Thomas (26 February 2014). "unionfs". GNU Hurd. Retrieved 17 July 2017.
- "trapexit/mergerfs". GitHub. Retrieved 21 October 2018.
- Sun/Release 3.0. vol. 1. Interleaf Technical Publishing. 1988. pp. 15‑1–18, 16‑1–19.
- Imran, Awais (19 June 2011). "Comex Working On Faster Jailbreaking Process for JailbreakMe 3.0; iPad 2 Jailbreak Coming Soon!". Redmond Pie. Retrieved 17 July 2017.
- Official website
- Charles P. Wright, Jay Dave, Puja Gupta, Harikesavan Krishnan, Erez Zadok and Mohammad Nayyer Zubair (2004). "Versatility and Unix Semantics in a Fan-Out Unification File System" (PDF). Technical Report FSL-04-01b. Stony Brook University.CS1 maint: uses authors parameter (link)
- unionfs-fuse on GitHub - A FUSE-based alternative implementation of Unionfs
- FunionFS - Another FUSE-based implementation of Unionfs
- The new unionfs implementation for FreeBSD and status of merging (2007-10-23)
- On Incremental File System Development
- LUFS-based unionfs for Linux (based on LUFS)
- DENX U-Boot and Linux Guide: Overlay File Systems