Browse Source

Add container image details (#1569)

master 2.41.0
trapexit 2 days ago
committed by GitHub
parent
commit
47bd4259b8
No known key found for this signature in database GPG Key ID: B5690EEEBB952194
  1. 32
      mkdocs/docs/setup/installation.md
  2. 8
      mkdocs/docs/sponsorship_and_donations.md

32
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/<ver>/mergerfs-static-linux_<arch>.tar.gz
sudo tar xvf mergerfs-static-linux_<arch>.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.

8
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).
Loading…
Cancel
Save