From 47bd4259b8a70091d229083faa456aba15ac4c65 Mon Sep 17 00:00:00 2001 From: trapexit Date: Sat, 8 Nov 2025 20:28:10 -0600 Subject: [PATCH] Add container image details (#1569) --- mkdocs/docs/setup/installation.md | 32 ++++++++++++++++++++++++ mkdocs/docs/sponsorship_and_donations.md | 8 +++--- 2 files changed, 36 insertions(+), 4 deletions(-) diff --git a/mkdocs/docs/setup/installation.md b/mkdocs/docs/setup/installation.md index bc9b8f44..349677a5 100644 --- a/mkdocs/docs/setup/installation.md +++ b/mkdocs/docs/setup/installation.md @@ -106,6 +106,7 @@ nix-env -iA nixos.mergerfs [Check your distro.](../related_projects.md#distributions-including-mergerfs) + ## Static Linux Binaries If your distro does not package mergerfs there are static binaries @@ -117,3 +118,34 @@ Get the tarball from the [releases page](https://github.com/trapexit/mergerfs/re wget https://github.com/trapexit/mergerfs/releases/download//mergerfs-static-linux_.tar.gz sudo tar xvf mergerfs-static-linux_.tar.gz -C / ``` + +## Podman, Docker, OCI Containers + +https://github.com/trapexit/mergerfs/pkgs/container/mergerfs + +``` +podman pull ghcr.io/trapexit/mergerfs:TAG +# or +docker pull ghcr.io/trapexit/mergerfs:TAG +``` + +### rootful container runtimes + +``` +docker run --device=/dev/fuse --cap-add=SYS_ADMIN -v /mnt/to-merge:/mnt/to-merge:rshared -v /mnt/mergerfs:/mnt/mergerfs:z,shared ghcr.io/trapexit/mergerfs:TAG -f '/mnt/to-merge/*' '/mnt/mergerfs' +``` + +* `--device=/dev/fuse`: Pass in host FUSE device. +* `--cap-add=SYS_ADMIN`: Give proper permissions to mount. +* `-v /mnt/mergerfs:/mnt/mergerfs:z,shared`: `z` and `shared` will + allow the mount to be shared between the container and host and + therefore other containers. +* `-v /mnt/to-merge:/mnt/to-merge:rshared`: The mounts from the host + to merge within the container. + + +### rootless container runtimes + +Not possible? `:shared` is not rejected but won't work the same with +rootless. Podman doesn't allow the creation of pods with shared mount +namespace in rootless mode. diff --git a/mkdocs/docs/sponsorship_and_donations.md b/mkdocs/docs/sponsorship_and_donations.md index 2480827b..ae8dd9ca 100644 --- a/mkdocs/docs/sponsorship_and_donations.md +++ b/mkdocs/docs/sponsorship_and_donations.md @@ -1,4 +1,4 @@ -# Sponsorship and Donations +# Sponsorship, Donations, Support Contracts [https://github.com/trapexit/support](https://github.com/trapexit/support) @@ -12,6 +12,6 @@ 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:support@spawn.link). +project or purchasing a support contract to ensure it continues to be +maintained and receive updates. [Reach out for more +details](mailto:support@spawn.link?subject=mergerfs+support+contract+inquiry).