Skip to content
This repository was archived by the owner on Oct 6, 2023. It is now read-only.

Commit 68d8c76

Browse files
committed
Enhanced documentation
1 parent ff13693 commit 68d8c76

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
11
# obeone/nfs-server (forked from erichough/nfs-server)
22

3+
[![Build and publish](https://github.com/obeone/docker-nfs-server/actions/workflows/build-and-push-v2.yaml/badge.svg?branch=main&event=push)](https://github.com/obeone/docker-nfs-server/actions/workflows/build-and-push-v2.yaml)
4+
35
A lightweight, robust, flexible, and containerized NFS server.
46

7+
[Nightly built containers are available for multiple arch](https://github.com/obeone/docker-nfs-server/pkgs/container/nfs-server), and now manifest are signed using cosign !
8+
9+
A [Helm chart is available](https://github.com/obeone/charts/tree/main/charts/nfs-server) to ease deploy on Kubernetes
10+
511
## Why?
612

713
This is the only containerized NFS server that offers **all** of the following features:
@@ -50,9 +56,9 @@ This forked version add the following features :
5056
- `rpcsec_gss_krb5` (*only if Kerberos is used*)
5157

5258
You can manually enable these modules on the Docker host with:
53-
59+
5460
`modprobe {nfs,nfsd,rpcsec_gss_krb5}`
55-
61+
5662
or you can just allow the container to [load them automatically](https://github.com/ehough/docker-nfs-server/blob/develop/doc/feature/auto-load-kernel-modules.md).
5763
1. The container will need to run with `CAP_SYS_ADMIN` (or `--privileged`). This is necessary as the server needs to mount several filesystems *inside* the container to support its operation, and performing mounts from inside a container is impossible without these capabilities.
5864
1. The container will need local access to the files you'd like to serve via NFS. You can use Docker volumes, bind mounts, files baked into a custom image, or virtually any other means of supplying files to a Docker container.
@@ -117,7 +123,7 @@ Let's break that command down into its individual pieces to see what's required
117123
As noted in the [requirements](#requirements), the container will need additional privileges. So your `run` command will need *either*:
118124

119125
docker run --cap-add SYS_ADMIN ... ghcr.io/obeone/nfs-server
120-
126+
121127
or
122128

123129
docker run --privileged ... ghcr.io/obeone/nfs-server

0 commit comments

Comments
 (0)