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

Commit f1b2e05

Browse files
committed
tweaks to README
1 parent a2179c3 commit f1b2e05

File tree

1 file changed

+22
-10
lines changed

1 file changed

+22
-10
lines changed

README.md

Lines changed: 22 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,9 @@ You will need to provide your desired [NFS exports](https://linux.die.net/man/5/
4141
-v /host/files:/nfs \
4242
--cap-add SYS_ADMIN \
4343
-p 2049:2049 \
44-
erichough/nfs-server:latest
44+
erichough/nfs-server
4545
46-
1. **Provide each line of `/etc/exports` as an environment variable**.
46+
1. **Provide each line of `/etc/exports` as an environment variable**
4747

4848
The container will look for environment variables that start with `NFS_EXPORT_` and end with an integer. e.g. `NFS_EXPORT_0`, `NFS_EXPORT_1`, etc.
4949

@@ -54,16 +54,16 @@ You will need to provide your desired [NFS exports](https://linux.die.net/man/5/
5454
-v /host/path/bar:/nfs/bar \
5555
--cap-add SYS_ADMIN \
5656
-p 2049:2049 \
57-
erichough/nfs-server:latest
57+
erichough/nfs-server
5858

5959
1. **Bake `/etc/exports` into a custom image**
6060

6161
e.g. in a `Dockerfile`:
6262

63-
FROM ehough/nfs-server:latest
63+
FROM ehough/nfs-server
6464
ADD /host/path/to/exports.txt /etc/exports
6565

66-
### (Optional) User ID Mapping
66+
### (Optional) NFSv4 User ID Mapping
6767

6868
If you'd like to run [`idmapd`](http://man7.org/linux/man-pages/man8/idmapd.8.html) to map between NFSv4 IDs (e.g. `[email protected]`) and local users, simply provide [`idmapd.conf`](https://linux.die.net/man/5/idmapd.conf) and `/etc/passwd` to the container. This step is required for Kerberos.
6969

@@ -74,7 +74,7 @@ If you'd like to run [`idmapd`](http://man7.org/linux/man-pages/man8/idmapd.8.ht
7474
-v /etc/passwd:/etc/passwd:ro \
7575
--cap-add SYS_ADMIN \
7676
-p 2049:2049 \
77-
erichough/nfs-server:latest
77+
erichough/nfs-server
7878
7979
### (Optional) Kerberos
8080

@@ -85,7 +85,7 @@ You can enable Kerberos security by performing the following additional actions:
8585
1. provide `/etc/krb5.keytab` which contains a principal of the form `nfs/<hostname>`, where `<hostname>` is the hostname you supplied in the previous step.
8686
1. provide [`/etc/krb5.conf`](https://web.mit.edu/kerberos/krb5-1.12/doc/admin/conf_files/krb5_conf.html)
8787
1. provide [`/etc/idmapd.conf`](https://linux.die.net/man/5/idmapd.conf)
88-
1. provide `/etc/passwd` that contains your NFS client users
88+
1. provide `/etc/passwd` containing your NFS client users
8989

9090
Here's an example:
9191

@@ -100,7 +100,7 @@ Here's an example:
100100
-v /etc/passwd:/etc/passwd:ro \
101101
--cap-add SYS_ADMIN \
102102
-p 2049:2049 \
103-
erichough/nfs-server:latest
103+
erichough/nfs-server
104104

105105
### Environment Variables
106106

@@ -136,7 +136,19 @@ The following optional environment variables allow you to adjust the server sett
136136

137137
- **`NFS_ENABLE_KERBEROS`** (*not set by default*)
138138

139-
Set to a non-empty value (e.g. `NFS_ENABLE_KERBEROS=1`) to enable Kerberos on this server. See "Kerberos" section above for further details.
139+
Set to a non-empty value (e.g. `NFS_ENABLE_KERBEROS=1`) to enable Kerberos on this server. See the [Kerberos](#kerberos) section above for further details.
140+
141+
### Which ports need to be exposed?
142+
143+
* NFSv4
144+
* `2049`
145+
* NFSv3
146+
* `111` & `111/udp`
147+
* `2049` & `2049/udp`
148+
* `32765` & `32765/udp`
149+
* `32767` & `32767/udp`
150+
151+
These ports can be exposed using the usual [Docker syntax](https://docs.docker.com/engine/reference/run/#expose-incoming-ports) (e.g. `-p 2049:2049`), and most can be customized via [environment variables](#environment-variables).
140152

141153
### Mounting filesystems from a client
142154

@@ -157,7 +169,7 @@ The following optional environment variables allow you to adjust the server sett
157169

158170
## Acknowledgements
159171

160-
This work was based heavily on prior projects:
172+
This work was based on prior projects:
161173

162174
- [f-u-z-z-l-e/docker-nfs-server](https://github.com/f-u-z-z-l-e/docker-nfs-server)
163175
- [sjiveson/nfs-server-alpine](https://github.com/sjiveson/nfs-server-alpine)

0 commit comments

Comments
 (0)