mirror of
https://github.com/trapexit/mergerfs.git
synced 2026-11-20 06:56:27 -05:00
Config options docs updates (#1551)
This commit is contained in:
parent
741128cb23
commit
4b4801add6
12 changed files with 26 additions and 22 deletions
|
|
@ -73,9 +73,9 @@ little risk in setting the value much higher. Especially if there are
|
||||||
no out-of-band changes.
|
no out-of-band changes.
|
||||||
|
|
||||||
|
|
||||||
## cache.negative_entry
|
## cache.negative-entry
|
||||||
|
|
||||||
* `cache.negative_entry=UINT`: Sets the number of seconds to cache
|
* `cache.negative-entry=UINT`: Sets the number of seconds to cache
|
||||||
negative entry queries. Defaults to `1`.
|
negative entry queries. Defaults to `1`.
|
||||||
|
|
||||||
This is a cache for negative entry query responses. Such as when a
|
This is a cache for negative entry query responses. Such as when a
|
||||||
|
|
|
||||||
|
|
@ -26,7 +26,7 @@ Until Linux v6.16, despite being able to change the size of FUSE
|
||||||
messages, `readdir` requests were limited to 1 page (4KiB) in size per
|
messages, `readdir` requests were limited to 1 page (4KiB) in size per
|
||||||
message. This limitation limited throughput and therefore performance
|
message. This limitation limited throughput and therefore performance
|
||||||
of the `readdir` call. In v6.16 that was changed to be able to grow to
|
of the `readdir` call. In v6.16 that was changed to be able to grow to
|
||||||
the [fuse_msg_size](fuse_msg_size.md) which allows a lot more data to
|
the [fuse-msg-size](fuse-msg-size.md) which allows a lot more data to
|
||||||
be sent per request and therefore much better performance in certain
|
be sent per request and therefore much better performance in certain
|
||||||
situations.
|
situations.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
# link_cow
|
# link-cow
|
||||||
|
|
||||||
* `link_cow=true|false`
|
* `link-cow=true|false`
|
||||||
* Defaults to `false`
|
* Defaults to `false`
|
||||||
|
|
||||||
This feature offers similar functionality to what
|
This feature offers similar functionality to what
|
||||||
|
|
@ -70,7 +70,7 @@ config file.
|
||||||
writable and its mtime or ctime is older than **symlinkify_timeout**
|
writable and its mtime or ctime is older than **symlinkify_timeout**
|
||||||
files will be reported as symlinks to the original files. Please
|
files will be reported as symlinks to the original files. Please
|
||||||
read more below before using. (default: false)
|
read more below before using. (default: false)
|
||||||
* **[symlinkify_timeout](symlinkify.md)=UINT**: Time to wait, in
|
* **[symlinkify-timeout](symlinkify.md)=UINT**: Time to wait, in
|
||||||
seconds, to activate the **symlinkify** behavior. (default: 3600)
|
seconds, to activate the **symlinkify** behavior. (default: 3600)
|
||||||
* **nullrw=BOOL**: Turns reads and writes into no-ops. The request
|
* **nullrw=BOOL**: Turns reads and writes into no-ops. The request
|
||||||
will succeed but do nothing. Useful for benchmarking
|
will succeed but do nothing. Useful for benchmarking
|
||||||
|
|
@ -91,13 +91,13 @@ config file.
|
||||||
* **[kernel-permissions-check](kernel-permissions-check.md)=BOOL**:
|
* **[kernel-permissions-check](kernel-permissions-check.md)=BOOL**:
|
||||||
Controls the FUSE `default_permissions` option. Primarily for
|
Controls the FUSE `default_permissions` option. Primarily for
|
||||||
debugging. (default: true)
|
debugging. (default: true)
|
||||||
* **security_capability=BOOL**: If false return ENOATTR when xattr
|
* **security-capability=BOOL**: If false return ENOATTR when xattr
|
||||||
security.capability is queried. (default: true)
|
security.capability is queried. (default: true)
|
||||||
* **[xattr](xattr.md)=passthrough|noattr|nosys**: Runtime control of
|
* **[xattr](xattr.md)=passthrough|noattr|nosys**: Runtime control of
|
||||||
xattrs. Default is to passthrough xattr requests. 'noattr' will
|
xattrs. Default is to passthrough xattr requests. 'noattr' will
|
||||||
short circuit as if nothing exists. 'nosys' will respond with ENOSYS
|
short circuit as if nothing exists. 'nosys' will respond with ENOSYS
|
||||||
as if xattrs are not supported or disabled. (default: passthrough)
|
as if xattrs are not supported or disabled. (default: passthrough)
|
||||||
* **[link-cow](link_cow.md)=BOOL**: When enabled if a regular file is
|
* **[link-cow](link-cow.md)=BOOL**: When enabled if a regular file is
|
||||||
opened which has a link count > 1 it will copy the file to a
|
opened which has a link count > 1 it will copy the file to a
|
||||||
temporary file and rename over the original. Breaking the link and
|
temporary file and rename over the original. Breaking the link and
|
||||||
providing a basic copy-on-write function similar to
|
providing a basic copy-on-write function similar to
|
||||||
|
|
@ -106,7 +106,7 @@ config file.
|
||||||
means it will always use all branches in statfs calculations. 'full'
|
means it will always use all branches in statfs calculations. 'full'
|
||||||
is in effect path preserving and only includes branches where the
|
is in effect path preserving and only includes branches where the
|
||||||
path exists. (default: base)
|
path exists. (default: base)
|
||||||
* **statfs_ignore=none|ro|nc**: 'ro' will cause statfs calculations to
|
* **statfs-ignore=none|ro|nc**: 'ro' will cause statfs calculations to
|
||||||
ignore available space for branches mounted or tagged as 'read-only'
|
ignore available space for branches mounted or tagged as 'read-only'
|
||||||
or 'no create'. 'nc' will ignore available space for branches tagged
|
or 'no create'. 'nc' will ignore available space for branches tagged
|
||||||
as 'no create'. (default: none)
|
as 'no create'. (default: none)
|
||||||
|
|
@ -123,13 +123,13 @@ config file.
|
||||||
directory and symlink to it.
|
directory and symlink to it.
|
||||||
* **[readahead](readahead.md)=UINT**: Set readahead (in kilobytes) for
|
* **[readahead](readahead.md)=UINT**: Set readahead (in kilobytes) for
|
||||||
mergerfs and branches if greater than 0. (default: 0)
|
mergerfs and branches if greater than 0. (default: 0)
|
||||||
* **posix_acl=BOOL**: Enable POSIX ACL support (if supported by kernel
|
* **posix-acl=BOOL**: Enable POSIX ACL support (if supported by kernel
|
||||||
and underlying filesystem). (default: false)
|
and underlying filesystem). (default: false)
|
||||||
* **async_read=BOOL**: Perform reads asynchronously. If disabled or
|
* **async-read=BOOL**: Perform reads asynchronously. If disabled or
|
||||||
unavailable the kernel will ensure there is at most one pending read
|
unavailable the kernel will ensure there is at most one pending read
|
||||||
request per file handle and will attempt to order requests by
|
request per file handle and will attempt to order requests by
|
||||||
offset. (default: true)
|
offset. (default: true)
|
||||||
* **[fuse_msg_size](fuse_msg_size.md)=PAGESIZE**: Set the max number of
|
* **[fuse-msg-size](fuse-msg-size.md)=PAGESIZE**: Set the max number of
|
||||||
pages per FUSE message. Only available on Linux >= 4.20 and ignored
|
pages per FUSE message. Only available on Linux >= 4.20 and ignored
|
||||||
otherwise. (min: 1; max: 65535; default: "1M")
|
otherwise. (min: 1; max: 65535; default: "1M")
|
||||||
* **[read-thread-count](threads.md)=INT**: Number of threads to
|
* **[read-thread-count](threads.md)=INT**: Number of threads to
|
||||||
|
|
@ -188,7 +188,7 @@ config file.
|
||||||
timeout in seconds. (default: 1)
|
timeout in seconds. (default: 1)
|
||||||
* **[cache.entry](cache.md#cacheentry)=UINT**: File name lookup cache
|
* **[cache.entry](cache.md#cacheentry)=UINT**: File name lookup cache
|
||||||
timeout in seconds. (default: 1)
|
timeout in seconds. (default: 1)
|
||||||
* **[cache.negative_entry](cache.md#cachenegative_entry)=UINT**:
|
* **[cache.negative-entry](cache.md#cachenegative-entry)=UINT**:
|
||||||
Negative file name lookup cache timeout in seconds. (default: 0)
|
Negative file name lookup cache timeout in seconds. (default: 0)
|
||||||
* **[cache.files](cache.md#cachefiles)=off|partial|full|auto-full|per-process**:
|
* **[cache.files](cache.md#cachefiles)=off|partial|full|auto-full|per-process**:
|
||||||
File page caching mode (default: off)
|
File page caching mode (default: off)
|
||||||
|
|
|
||||||
|
|
@ -31,7 +31,7 @@ features related to read/write are affected.
|
||||||
* [readahead](readahead.md): Still affects the `readahead` values of
|
* [readahead](readahead.md): Still affects the `readahead` values of
|
||||||
underlying filesystems and `mergerfs` itself but no longer relevant
|
underlying filesystems and `mergerfs` itself but no longer relevant
|
||||||
to `mergerfs` in that it is not servicing IO requests.
|
to `mergerfs` in that it is not servicing IO requests.
|
||||||
* [fuse_msg_size](fuse_msg_size.md): The primary reason to increase
|
* [fuse-msg-size](fuse-msg-size.md): The primary reason to increase
|
||||||
the FUSE message size is to allow transferring more data per request
|
the FUSE message size is to allow transferring more data per request
|
||||||
which helps improve read and write performance. Without read/write
|
which helps improve read and write performance. Without read/write
|
||||||
requests being sent to `mergerfs` there is little reason to have
|
requests being sent to `mergerfs` there is little reason to have
|
||||||
|
|
@ -103,7 +103,7 @@ Summary: passthrough is ~95% native speed. 200% faster than
|
||||||
|
|
||||||
* straight to tmpfs: 1.7 GB/s
|
* straight to tmpfs: 1.7 GB/s
|
||||||
* nullrw=true: 2.1 GB/s
|
* nullrw=true: 2.1 GB/s
|
||||||
* cache.files=off; passthrough=off: 800 MB/s
|
* cache.files=off; passthrough.io=off: 800 MB/s
|
||||||
* cache.files=auto-full; passthrough=rw: 1.6 GB/s
|
* cache.files=auto-full; passthrough.io=rw: 1.6 GB/s
|
||||||
* cache.files=auto-full; cache.writeback=false: 518 MB/s
|
* cache.files=auto-full; cache.writeback=false: 518 MB/s
|
||||||
* cache.files=auto-full; cache.writeback=true: 518 MB/s
|
* cache.files=auto-full; cache.writeback=true: 518 MB/s
|
||||||
|
|
|
||||||
|
|
@ -6,7 +6,7 @@ value unit is in kibibytes.
|
||||||
* `readahead=1024`
|
* `readahead=1024`
|
||||||
|
|
||||||
While the max size of messages sent between the kernel and mergerfs is
|
While the max size of messages sent between the kernel and mergerfs is
|
||||||
configurable via the [fuse_msg_size](fuse_msg_size.md) option that
|
configurable via the [fuse-msg-size](fuse-msg-size.md) option that
|
||||||
doesn't mean that is the size used by the kernel for read and
|
doesn't mean that is the size used by the kernel for read and
|
||||||
writes.
|
writes.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -27,7 +27,7 @@ technologies](project_comparisons.md).
|
||||||
type](faq/compatibility_and_integration.md#what-filesystems-can-be-used-as-branches)
|
type](faq/compatibility_and_integration.md#what-filesystems-can-be-used-as-branches)
|
||||||
* Ignore read-only filesystems when creating files
|
* Ignore read-only filesystems when creating files
|
||||||
* [Hard links](faq/technical_behavior_and_limitations.md#do-hard-links-work)
|
* [Hard links](faq/technical_behavior_and_limitations.md#do-hard-links-work)
|
||||||
* Hard link [copy-on-write / CoW](config/link_cow.md)
|
* Hard link [copy-on-write / CoW](config/link-cow.md)
|
||||||
* [Runtime configurable](runtime_interface.md)
|
* [Runtime configurable](runtime_interface.md)
|
||||||
* Support for extended attributes (xattrs)
|
* Support for extended attributes (xattrs)
|
||||||
* Support for file attributes (chattr)
|
* Support for file attributes (chattr)
|
||||||
|
|
|
||||||
|
|
@ -32,7 +32,7 @@ before changing them to understand how functionality will change.
|
||||||
* disable `security_capability` and/or [xattr](config/xattr.md)
|
* disable `security_capability` and/or [xattr](config/xattr.md)
|
||||||
* increase cache timeouts [cache.attr](config/cache.md#cacheattr),
|
* increase cache timeouts [cache.attr](config/cache.md#cacheattr),
|
||||||
[cache.entry](config/cache.md#cacheentry),
|
[cache.entry](config/cache.md#cacheentry),
|
||||||
[cache.negative_entry](config/cache.md#cachenegative_entry)
|
[cache.negative_entry](config/cache.md#cachenegative-entry)
|
||||||
* toggle [page caching](config/cache.md#cachefiles)
|
* toggle [page caching](config/cache.md#cachefiles)
|
||||||
* enable `parallel-direct-writes`
|
* enable `parallel-direct-writes`
|
||||||
* enable [cache.writeback](config/cache.md#cachewriteback)
|
* enable [cache.writeback](config/cache.md#cachewriteback)
|
||||||
|
|
|
||||||
|
|
@ -24,6 +24,10 @@
|
||||||
* [snapraid](https://www.snapraid.it/): a backup program designed for
|
* [snapraid](https://www.snapraid.it/): a backup program designed for
|
||||||
disk arrays, storing parity information for data recovery in the
|
disk arrays, storing parity information for data recovery in the
|
||||||
event of up to six disk failures.
|
event of up to six disk failures.
|
||||||
|
* [nonraid](https://github.com/qvr/nonraid): NonRAID is a fork of the
|
||||||
|
unRAID system's open-source md_unraid kernel driver enabling
|
||||||
|
UnRAID-style storage arrays with parity protection outside of the
|
||||||
|
commercial UnRAID system.
|
||||||
* [rclone](https://rclone.org/): a command-line program to manage
|
* [rclone](https://rclone.org/): a command-line program to manage
|
||||||
files on cloud storage. It is a feature-rich alternative to cloud
|
files on cloud storage. It is a feature-rich alternative to cloud
|
||||||
vendors' web storage interfaces. rclone's
|
vendors' web storage interfaces. rclone's
|
||||||
|
|
|
||||||
|
|
@ -9,7 +9,7 @@
|
||||||
* readdir concurrency
|
* readdir concurrency
|
||||||
* memory
|
* memory
|
||||||
* 1MB+ pre reader thread + inflight processing for messages
|
* 1MB+ pre reader thread + inflight processing for messages
|
||||||
depending on [fuse_msg_size](config/fuse_msg_size.md)
|
depending on [fuse-msg-size](config/fuse-msg-size.md)
|
||||||
* buffers allocated temporarily for reading directories
|
* buffers allocated temporarily for reading directories
|
||||||
* [gidcache](faq/technical_behavior_and_limitations.md#how-does-mergerfs-handle-credentials)
|
* [gidcache](faq/technical_behavior_and_limitations.md#how-does-mergerfs-handle-credentials)
|
||||||
* FUSE nodes
|
* FUSE nodes
|
||||||
|
|
|
||||||
|
|
@ -82,8 +82,8 @@ nav:
|
||||||
- config/threads.md
|
- config/threads.md
|
||||||
- config/pin-threads.md
|
- config/pin-threads.md
|
||||||
- config/proxy-ioprio.md
|
- config/proxy-ioprio.md
|
||||||
- config/link_cow.md
|
- config/link-cow.md
|
||||||
- config/fuse_msg_size.md
|
- config/fuse-msg-size.md
|
||||||
- config/follow-symlinks.md
|
- config/follow-symlinks.md
|
||||||
- config/link-exdev.md
|
- config/link-exdev.md
|
||||||
- config/rename-exdev.md
|
- config/rename-exdev.md
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue