Browse Source

Misc documentation changes (#1489)

pull/1491/head
trapexit 3 months ago
committed by GitHub
parent
commit
71ddae8713
No known key found for this signature in database GPG Key ID: B5690EEEBB952194
  1. 7
      mkdocs/README.md
  2. 27
      mkdocs/docs/benchmarking.md
  3. 2
      mkdocs/docs/media_and_publicity.md
  4. 13
      mkdocs/docs/project_comparisons.md
  5. 13
      mkdocs/docs/remote_filesystems.md

7
mkdocs/README.md

@ -9,6 +9,13 @@ pip3 install --no-cache-dir mkdocs mkdocs-material pymdown-extensions mike
mike serve
```
## Deploy
```bash
mike deploy --push <version_name> --allow-empty
```
## References
* https://www.mkdocs.org/

27
mkdocs/docs/benchmarking.md

@ -61,15 +61,38 @@ author so it may be investigated further.
### write benchmark
```
$ dd if=/dev/zero of=/mnt/mergerfs/1GB.file bs=1M count=1024 oflag=nocache conv=fdatasync status=progress
$ dd if=/dev/zero of=/mnt/mergerfs/16GB.file bs=1M count=16384 oflag=nocache conv=fdatasync status=progress
```
### read benchmark
```
$ dd if=/mnt/mergerfs/1GB.file of=/dev/null bs=1M count=1024 iflag=nocache conv=fdatasync status=progress
$ dd if=/mnt/mergerfs/16GB.file of=/dev/null bs=1M iflag=nocache conv=fdatasync status=progress
```
### fio
`fio` is a popular and flexible benchmarking tool.
Below are some basic tests but also try setting `--direct=0`, changing
the `ioengine`, or playing with other options.
#### write
```
$ fio --name=writetest --filename=/mnt/mergerfs/16GB.file --size=16Gb --rw=write --bs=1M --direct=1 --numjobs=1 --iodepth=8 --group_reporting --runtime=60 --startdelay=0 --ioengine=psync
```
#### read
```
$ fio --name=readtest --filename=/mnt/mergerfs/16GB.file --size=16Gb --rw=read --bs=1M --direct=1 --numjobs=1 --iodepth=8 --group_reporting --runtime=60 --startdelay=0 --ioengine=psync
```
### other benchmarks
If you are attempting to benchmark other behaviors you must ensure you

2
mkdocs/docs/media_and_publicity.md

@ -64,6 +64,8 @@
* 2024-02-22 - [Setup and Install MergerFS and SnapRAID (Part 2)](https://noted.lol/mergerfs-and-snapraid-setup-part-2/)
* 2024-11-15 - [Meu servidor NAS - Parte 18: Recuperando um HD, recuperando o MergerFS e os próximos passos do NAS!](https://www.youtube.com/watch?v=5fy98kPzE3s)
* 2025-04-23 - [How to build the Perfect Media Server | Part 1 - The Tech Stack | mergerfs, SnapRAID, and docker.](https://www.youtube.com/watch?v=Yt67zz9p0FU)
* 2025-06-12 - [DIY Unraid-like functionality ](https://www.youtube.com/watch?v=fR0XhaWvR1E)
## Podcasts

13
mkdocs/docs/project_comparisons.md

@ -156,6 +156,19 @@ can introduce a number of costs and limitations as described
[here](https://utcc.utoronto.ca/~cks/space/blog/solaris/ZFSWhyNoRealReshaping).
## ZFS AnyRAID
[ZFS
AnyRAID](https://hexos.com/blog/introducing-zfs-anyraid-sponsored-by-eshtek)
is a feature being developed for ZFS which is intended to provide more
flexibility in ZFS pools. Allowing a mix of capacity disks to have
greater capacity than traditional RAID and would allow for partial
upgrades while keeping live redundency.
This ZFS feature, as of mid-2025, is extremely early in its development
and there are no timelines or estimates for when it may be released.
## StableBit's DrivePool
* [https://stablebit.com](https://stablebit.com)

13
mkdocs/docs/remote_filesystems.md

@ -61,6 +61,7 @@ but if you run into problems it may be worth trying Samba/SMB.
* `noforget`
* `inodecalc=path-hash`
* `lazy-umount-mountpoint=false`
`noforget` is needed because NFS uses the `name_to_handle_at` and
`open_by_handle_at` functions which allow a program to keep a
@ -81,6 +82,12 @@ branch and therefore the inode would change. This isn't an ideal
solution and others are being considered but it works for most
situations.
`lazy-umount-mountpoint=false` is needed (or left unset) as lazy
umount can cause problems with NFS. It won't impact the NFS export at
first but followup mounts of mergerfs to the same mount point will
lead to new remote mounts hanging till `exportfs` is run again.
**NFS export settings:**
* `fsid=UUID`
@ -128,6 +135,12 @@ not been extensively tested. If you use mergerfs with CIFSD or other
SMB servers please submit your experiences so these docs can be
updated.
NOTE: Some users have reported that when deleting files from certain
Android file managers they get errors from the app and Samba but the
file gets removed. This is due to a bug in Samba which has been fixed
in more recent releases such as 4.21. If using Debian you can enable
[backports repo](https://backports.debian.org/Instructions).
## SSHFS

Loading…
Cancel
Save