Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/trapexit/mergerfs
a featureful union filesystem
https://github.com/trapexit/mergerfs
aufs datahoarding filesystem fuse jbod kodi libfuse mergerfs mhddfs overlayfs plex subsonic unionfs xattr
Last synced: 4 days ago
JSON representation
a featureful union filesystem
- Host: GitHub
- URL: https://github.com/trapexit/mergerfs
- Owner: trapexit
- License: other
- Created: 2014-03-24T15:43:21.000Z (almost 11 years ago)
- Default Branch: latest-release
- Last Pushed: 2024-07-18T20:28:42.000Z (6 months ago)
- Last Synced: 2024-10-29T15:29:14.508Z (3 months ago)
- Topics: aufs, datahoarding, filesystem, fuse, jbod, kodi, libfuse, mergerfs, mhddfs, overlayfs, plex, subsonic, unionfs, xattr
- Language: C++
- Homepage: http://spawn.link
- Size: 24.3 MB
- Stars: 4,265
- Watchers: 77
- Forks: 173
- Open Issues: 52
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- project-awesome - trapexit/mergerfs - a featureful union filesystem (C++)
- awesome - trapexit/mergerfs - a featureful union filesystem (C++)
- awesome-repositories - trapexit/mergerfs - a featureful union filesystem (C++)
- awesome-datahoarding - mergerfs
- awesome-datahoarder - mergerfs
- awesome-starred - trapexit/mergerfs - a featureful union filesystem (others)
README
# mergerfs - a featureful union filesystem
**mergerfs** is a
[FUSE](https://en.wikipedia.org/wiki/Filesystem_in_Userspace) based
[union filesystem](https://en.wikipedia.org/wiki/Union_mount) geared
towards simplifying storage and management of files across numerous
commodity storage devices. It is similar to **mhddfs**, **unionfs**,
and **aufs**.
## Features
* Logically combine numerous filesystems/paths into a single
mount point
* Combine paths of the same or different filesystems
* Ability to add or remove filesystems/paths without impacting the
rest of the data
* Unaffected by individual filesystem failure
* Configurable file selection and creation placement
* Works with filesystems of any size
* Works with filesystems of almost any type
* Ignore read-only filesystems when creating files
* Hard link copy-on-write / CoW
* Runtime configurable
* Support for extended attributes (xattrs)
* Support for file attributes (chattr)
* Support for POSIX ACLs
## Non-features
* Read/write overlay on top of read-only filesystem like OverlayFS
* File whiteout
* RAID like parity calculation
* Redundancy
* Splitting of files across branches
## How it works
mergerfs logically merges multiple filesystem paths together. It acts
as a proxy to the underlying filesystem paths. Combining the behaviors
of some functions and being a selector for others.
When the contents of a directory are requested mergerfs combines the
list of files from each directory, deduplicating entries, and returns
that list.
When a file or directory is created a policy is first run to determine
which branch will be selected for the creation.
For functions which change attributes or remove the file the behavior
may be applied to all instances found.
Read more about [policies
here](https://trapexit.github.io/mergerfs/config/functions_categories_and_policies).
### Visualization
```
A + B = C
/disk1 /disk2 /merged
| | |
+-- /dir1 +-- /dir1 +-- /dir1
| | | | | |
| +-- file1 | +-- file2 | +-- file1
| | +-- file3 | +-- file2
+-- /dir2 | | +-- file3
| | +-- /dir3 |
| +-- file4 | +-- /dir2
| +-- file5 | |
+-- file6 | +-- file4
|
+-- /dir3
| |
| +-- file5
|
+-- file6
```
## QuickStart
https://trapexit.github.io/mergerfs/quickstart/
## Documentation
https://trapexit.github.io/mergerfs
## Support
https://trapexit.github.io/mergerfs/support/
## Sponsorship and Donations
[https://github.com/trapexit/support](https://github.com/trapexit/support)
Development and support of a project like mergerfs requires a
significant amount of time and effort. The software is released under
the very liberal [ISC](https://opensource.org/license/isc-license-txt)
license and is therefore free to use for personal or commercial uses.
If you are a non-commercial user and find mergerfs and its support valuable
and would like to support the project financially it would be very
much appreciated.
If you are using mergerfs commercially please consider sponsoring the
project to ensure it continues to be maintained and receive
updates. If custom features are needed feel free to [contact me
directly](mailto:[email protected]).