mirror of
https://github.com/trapexit/mergerfs.git
synced 2026-11-21 15:36:31 -05:00
Update readme to match index of mkdocs (#1515)
This commit is contained in:
parent
d7549f8d53
commit
90b3585347
1 changed files with 36 additions and 26 deletions
62
README.md
62
README.md
|
|
@ -4,23 +4,30 @@
|
||||||
[FUSE](https://en.wikipedia.org/wiki/Filesystem_in_Userspace) based
|
[FUSE](https://en.wikipedia.org/wiki/Filesystem_in_Userspace) based
|
||||||
[union filesystem](https://en.wikipedia.org/wiki/Union_mount) geared
|
[union filesystem](https://en.wikipedia.org/wiki/Union_mount) geared
|
||||||
towards simplifying storage and management of files across numerous
|
towards simplifying storage and management of files across numerous
|
||||||
commodity storage devices. It is similar to **mhddfs**, **unionfs**,
|
commodity storage devices. It is similar to [**mhddfs**, **unionfs**,
|
||||||
and **aufs**.
|
**aufs**, **DrivePool**,
|
||||||
|
etc.](https://trapexit.github.io/mergerfs/latest/project_comparisons/)
|
||||||
|
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
* Logically combine numerous filesystems/paths into a single
|
* Logically combine numerous filesystems/paths into a single
|
||||||
mount point
|
mount point (JBOFS: Just a Bunch of FileSystems)
|
||||||
* Combine paths of the same or different filesystems
|
* Combine paths of the same or different filesystems
|
||||||
* Ability to add or remove filesystems/paths without impacting the
|
* Ability to add or remove filesystems/paths without impacting the
|
||||||
rest of the data
|
rest of the data
|
||||||
* Unaffected by individual filesystem failure
|
* Unaffected by individual filesystem failure
|
||||||
* Configurable file selection and creation placement
|
* Configurable file selection and creation placement
|
||||||
|
* File IO
|
||||||
|
[passthrough](https://trapexit.github.io/mergerfs/latest/config/passthrough/)
|
||||||
|
for near native IO performance (where supported)
|
||||||
* Works with filesystems of any size
|
* Works with filesystems of any size
|
||||||
* Works with filesystems of almost any type
|
* Works with filesystems of [almost any
|
||||||
|
type](https://trapexit.github.io/mergerfs/latest/faq/compatibility_and_integration/#what-filesystems-can-be-used-as-branches)
|
||||||
* Ignore read-only filesystems when creating files
|
* Ignore read-only filesystems when creating files
|
||||||
* Hard link copy-on-write / CoW
|
* Hard link [copy-on-write /
|
||||||
* Runtime configurable
|
CoW](https://trapexit.github.io/mergerfs/latest/config/link_cow/)
|
||||||
|
* [Runtime configurable](https://trapexit.github.io/mergerfs/latest/runtime_interface/)
|
||||||
* Support for extended attributes (xattrs)
|
* Support for extended attributes (xattrs)
|
||||||
* Support for file attributes (chattr)
|
* Support for file attributes (chattr)
|
||||||
* Support for POSIX ACLs
|
* Support for POSIX ACLs
|
||||||
|
|
@ -30,16 +37,17 @@ and **aufs**.
|
||||||
|
|
||||||
* Read/write overlay on top of read-only filesystem like OverlayFS
|
* Read/write overlay on top of read-only filesystem like OverlayFS
|
||||||
* File whiteout
|
* File whiteout
|
||||||
* RAID like parity calculation
|
* RAID like parity calculation (see [SnapRAID](https://www.snapraid.it))
|
||||||
* Redundancy
|
* Redundancy
|
||||||
* Splitting of files across branches
|
* Splitting of files across branches
|
||||||
|
|
||||||
|
|
||||||
## How it works
|
## How it works
|
||||||
|
|
||||||
mergerfs logically merges multiple filesystem paths together. It acts
|
mergerfs logically merges multiple filesystem paths together. Not
|
||||||
as a proxy to the underlying filesystem paths. Combining the behaviors
|
block devices, not filesystem mounts, just paths. It acts as a proxy
|
||||||
of some functions and being a selector for others.
|
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
|
When the contents of a directory are requested mergerfs combines the
|
||||||
list of files from each directory, deduplicating entries, and returns
|
list of files from each directory, deduplicating entries, and returns
|
||||||
|
|
@ -52,7 +60,7 @@ For functions which change attributes or remove the file the behavior
|
||||||
may be applied to all instances found.
|
may be applied to all instances found.
|
||||||
|
|
||||||
Read more about [policies
|
Read more about [policies
|
||||||
here](https://trapexit.github.io/mergerfs/config/functions_categories_policies/).
|
here](https://trapexit.github.io/mergerfs/latest/config/functions_categories_policies/).
|
||||||
|
|
||||||
|
|
||||||
### Visualization
|
### Visualization
|
||||||
|
|
@ -63,24 +71,26 @@ A + B = C
|
||||||
| | |
|
| | |
|
||||||
+-- /dir1 +-- /dir1 +-- /dir1
|
+-- /dir1 +-- /dir1 +-- /dir1
|
||||||
| | | | | |
|
| | | | | |
|
||||||
| +-- file1 | +-- file2 | +-- file1
|
| +-- file1 | | | +-- file1
|
||||||
| | +-- file3 | +-- file2
|
| | +-- file2 | +-- file2
|
||||||
+-- /dir2 | | +-- file3
|
| | +-- file3 | +-- file3
|
||||||
| | +-- /dir3 |
|
| | |
|
||||||
| +-- file4 | +-- /dir2
|
+-- /dir2 | +-- /dir2
|
||||||
| +-- file5 | |
|
| | | | |
|
||||||
+-- file6 | +-- file4
|
| *-- file4 | | +-- file4
|
||||||
|
|
| | |
|
||||||
+-- /dir3
|
| +-- /dir3 +-- /dir3
|
||||||
| |
|
| | | | |
|
||||||
| +-- file5
|
| | +-- file5 | +-- file5
|
||||||
|
|
| | |
|
||||||
+-- file6
|
+-- file6 | +-- file6
|
||||||
|
+-- file7 +-- file7 +-- file7
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
## QuickStart
|
## QuickStart
|
||||||
|
|
||||||
https://trapexit.github.io/mergerfs/quickstart/
|
https://trapexit.github.io/mergerfs/latest/quickstart/
|
||||||
|
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
|
|
@ -90,7 +100,7 @@ https://trapexit.github.io/mergerfs
|
||||||
|
|
||||||
## Support
|
## Support
|
||||||
|
|
||||||
https://trapexit.github.io/mergerfs/support/
|
https://trapexit.github.io/mergerfs/latest/support/
|
||||||
|
|
||||||
|
|
||||||
## Sponsorship and Donations
|
## Sponsorship and Donations
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue