mergerfs/mkdocs/docs/faq/why_isnt_it_working.md

266 lines
11 KiB
Markdown
Raw Permalink Normal View History

# "Why isn't it working?"
## I modified mergerfs' config but it still behaves the same.
mergerfs, like other filesystems, are given their options/arguments at
mount time. You can not simply modify the [source of the
configuration](../quickstart.md#usage) and have those settings applied
any more than you would for other filesystems. It is the user's
responsibility to [restart](../setup/upgrade.md) mergerfs to pick up
the changes or use the [runtime interface](../runtime_interface.md).
NOTE: the [runtime interface](../runtime_interface.md) is **just**
for runtime changes. It does **NOT** save those changed values
anywhere.
## Why are all my files ending up on 1 filesystem?!
Did you start with empty filesystems? Are you using an `existing path`
policy such as `epmfs`?
If starting with a set of empty filesystems such a policy will select
only 1 filesystem when the first directory is created. Anything
created in that directory will be placed on the same branch because
that is the point of such a policy. That is the expected behavior.
This may catch users off guard but the point of those `existing path`
policies is to preserve the directory layout and you need to consider
what that means one event at a time.
To "fix" this situation change the policy. Most users [have little
reason](configuration_and_policies.md#how-can-i-ensure-files-are-collocated-on-the-same-branch)
to use such a policy. See the [quick start guide](../quickstart.md)
and [FAQ](configuration_and_policies.md) for policy recommendations.
## Why do I get an "out of space" / "no space left on device" / ENOSPC error even though there appears to be lots of space available?
2025-09-21 15:25:24 -04:00
One or multiple of the below are likely causing branches to be
[filtered out](../config/functions_categories_policies.md#filtering).
* [minfreespace](../config/minfreespace.md) could be filtering out
branches
2025-09-21 15:25:24 -04:00
* using an `ep*` [policy](../config/functions_categories_policies.md)
and there may not be an available branch
* [branch modes](../config/branches.md#branch-mode) set to `NC` or
`RO` branches will be excluded from consideration
* if using `ext4` ensure you are not running into reserve limits (use
`tune2fs -m 0` to remove the reserve)
* it is possible that the filesystem selected by the policy has run
out of inodes (check with `df -i`)
mergerfs is presenting a union of the content within multiple
branches. The reported free space is an aggregate of space available
within the pool (behavior modified by [statfs](../config/statfs.md)
and [statfs_ignore](../config/statfs.md#statfs_ignore)). It does not
represent a contiguous space. In the same way that read-only
filesystems, those with quotas, or reserved space report the full
2025-09-21 15:25:24 -04:00
theoretical space available but not the practical usable space.
## Why isn't the create policy working?
It probably is. The policies rather straight forward and well tested.
First, confirm the policy is configured as expected by using the
[runtime interface](../runtime_interface.md).
```shell
$ sudo getfattr -n user.mergerfs.category.create /mnt/mergerfs/.mergerfs
# file: mnt/mergerfs/.mergerfs
user.mergerfs.category.create="mfs"
```
Second, as discussed in the [support](../support.md) section, test the
behavior using simple command line tools such as `touch` and then see
where it was created.
```shell
$ sudo touch /mnt/mergerfs/new-file
$ sudo getfattr -n user.mergerfs.allpaths /mnt/mergerfs/new-file
# file: mnt/mergerfs/new-file
user.mergerfs.allpaths="/mnt/hdd/drive1/new-file"
```
If the location of the file is where it should be according to the
state of the system at the time and the policy selected then the
"problem" lies elsewhere.
[Keep in
mind](technical_behavior_and_limitations.md/#how-does-mergerfs-handle-moving-and-copying-of-files)
that files, when created, have no size. If a number of files are
created at the same time, for example by a program downloading
numerous files like a BitTorrent client, then depending on the policy
the files could be created on the same branch. As the files are
written to, or resized immediately afterwards to the total size of the
file being downloaded, the files will take up more space but there is
no mechanism to move them as they grow. Nor would it be a good idea to
2025-03-11 23:30:13 -05:00
do so as it would be expensive to continuously calculate their size
and perform the move while the file is still being written to. As such
an imbalance will occur that wouldn't if the files had been created
and resized one at a time.
If you wish to reduce the likelihood of this happening a policy that
does not make decisions on available space alone such as `pfrd` or
`rand` should be used.
## Why can't I see my files / directories?
It's almost always a permissions issue. Unlike mhddfs and
unionfs-fuse, which accesses content as root, mergerfs always changes
its credentials to that of the caller. This is done as it is the only
properly secure way to manage permissions. This means that if the user
does not have access to a file or directory than neither will
mergerfs. However, because mergerfs is creating a union of paths it
may be able to read some files and directories on one filesystem but
not another resulting in an incomplete set. And if one of the branches
it can access is empty then it will return an empty list.
Try using [mergerfs.fsck](https://github.com/trapexit/mergerfs-tools)
tool to check for and fix inconsistencies in permissions. If you
aren't seeing anything at all be sure that the basic permissions are
correct. The user and group values are correct and that directories
have their executable bit set. A common mistake by users new to Linux
is to `chmod -R 644` when they should have `chmod -R u=rwX,go=rX`.
If using a [network filesystem](../remote_filesystems.md) such as NFS
or SMB (Samba) be sure to pay close attention to anything regarding
permissioning and users. Root squashing and user translation for
instance has bitten a few mergerfs users. Some of these also affect
the use of mergerfs from [container platforms such as
Docker.](compatibility_and_integration.md)
2025-03-11 23:30:13 -05:00
2025-09-19 20:25:31 -04:00
## Why are file moves, renames, links/hard links failing?
2025-03-11 23:30:13 -05:00
mergerfs fully supports rename and link functions to the degree that
is possible in a union filesystem. Problems related to rename and link
are almost exclusively due to incorrect setup of software or poorly
written software.
### Docker, Podman, and other container runtimes
Keep in mind that [rename and link](../config/rename_and_link.md) will
**NOT** work across devices. That includes between the original
filesystem and a mergerfs pool, between two separate pools of the same
underlying filesystems, or bind mounts of paths within the mergerfs
pool. The latter is common when using Docker, Podman, or other
container runtimes. Multiple volumes (bind mounts) to the same
underlying filesystem are considered different devices. There is no
way to link or rename between them despite them binding to the same
underlying filesystem. Neither mergerfs or any other filesystem has a
say in this behavior as the kernel is erroring out before the request
even gets to the filesystems in question.
To work around this situation the highest directory in the mergerfs
pool that includes all the paths you need is what should be bind'ed
into the container if you want links and rename to work between the
paths in question.
This is a common problem for users of Radarr, Sonarr, Lidarr,
etc. when they use the default volume mount options suggested by
projects like
[LinuxServer.io](https://docs.linuxserver.io/images/docker-radarr/?h=radarr#docker-compose-recommended-click-here-for-more-info). Do
not use separate "movies" and "downloads" volumes.
```
# NO
volumes:
- /mnt/pool/movies:/movies
- /mnt/pool/downloads:/downloads
# YES
volumes:
- /mnt/pool:/media
# Then use /media/movies and /media/downloads in your software.
```
### Path-Preserving Create Policies
As described in the [rename and link](../config/rename_and_link.md)
docs if a path-preserving create
[policy](../config/functions_categories_policies.md) is configured
2025-03-11 23:30:13 -05:00
then mergerfs, in order to follow that restrictive policy, must return
an error
([EXDEV](https://man7.org/linux/man-pages/man2/rename.2.html)) if the
target path of a rename or link is not found on the target branch.
```
EXDEV oldpath and newpath are not on the same mounted filesystem.
(Linux permits a filesystem to be mounted at multiple
points, but rename() does not work across different mount
points, even if the same filesystem is mounted on both.)
```
[Most
users](configuration_and_policies.md#how-can-i-ensure-files-are-collocated-on-the-same-branch)
do not have a need for path-preserving policies but if you intend on
using path-preserving policies you must accept that `EXDEV` errors are
more likely to occur. You could enable
[ignorepponrename](../config/options.md) however doing so would
contradict the intention of using a path restrictive policy.
### Poorly written software
There are some pieces of software that do not properly handle `EXDEV`
errors which `rename` and `link` may return even though they are
perfectly valid situations and do not indicate actual device,
filesystem, or OS problems. The error will rarely be returned by
mergerfs if using a non-path preserving
[policy](../config/functions_categories_policies.md) however there are
edge cases where it may (such as mounting another filesystem into the
mergerfs pool.) If you do not care about path preservation set the
2025-03-11 23:30:13 -05:00
mergerfs policy to the non-path preserving variant. For example: `-o
category.create=pfrd`. Ideally the offending software would be fixed
and it is recommended that if you run into this problem you contact
the software's author and request proper handling of `EXDEV` errors.
2025-03-11 23:30:13 -05:00
### Additional Reading
* [rename and link](../config/rename_and_link.md)
2025-09-19 20:25:31 -04:00
* [Do hard links work?](technical_behavior_and_limitations.md#do-hard-links-work)
2025-03-11 23:30:13 -05:00
* [How does mergerfs handle moving and copying of files?](technical_behavior_and_limitations.md#how-does-mergerfs-handle-moving-and-copying-of-files)
* [Moving files and directories fails with Samba](../known_issues_bugs.md#moving-files-and-directories-fails-with-samba)
2025-10-13 12:44:53 -04:00
## Why is software needing mmap failing?
2025-03-11 23:30:13 -05:00
2025-10-13 12:44:53 -04:00
See [Known Issues and Bugs#3rd Party
Software](../known_issues_bugs.md#3rd-party-software) and
[QuickStart](../quickstart.md).
## Why don't quick scans fail to pick up new media?
Media consumption software like Plex, Jellyfin, Emby, Airsonic,
Navidrome, etc. will use timestamps of directories to see if it should
be scanned. Be sure to set `func.getattr=newest` to catch that.
A full scan would still pick up all media and for those concerned
about device activity it is recommened to disable quick scans and
leave periodic full scans so the activity is managed. Or to configure
your software which manages downloads (such as *Arr family of
software) to trigger specific scans when files are added to the pool.
Additional reading:
* [Does inotify and fanotify
work?](compatibility_and_integration.md#does-inotify-and-fanotify-work)
2025-04-19 22:41:59 -05:00
## Why don't I see mergerfs options in mount command or /proc/mounts?
FUSE filesystems, such as mergerfs, are interpreting most of the
possible options rather than being given to the kernel where those
options in the `mount` command and /proc/mounts come from.
If you want to see the options of a running instance of mergerfs you
can use the [runtime interface](../runtime_interface.md).