Updating documentation

Author: obeone

README.md

@@ -1,4 +1,4 @@
-# erichough/nfs-server
+# obeone/nfs-server (forked from erichough/nfs-server)
 
 A lightweight, robust, flexible, and containerized NFS server.
 
@@ -17,6 +17,11 @@ This is the only containerized NFS server that offers **all** of the following f
   - [NFSv4 user ID mapping](https://github.com/ehough/docker-nfs-server/blob/develop/doc/feature/nfs4-user-id-mapping.md) via [`idmapd`](http://man7.org/linux/man-pages/man8/idmapd.8.html)
   - [AppArmor](https://github.com/ehough/docker-nfs-server/blob/develop/doc/feature/apparmor.md) compatibility
 
+This forked version add the following features :
+
+- Support for arch : linux/amd64, linux/arm64, linux/i386, linux/armhf, linux/armel
+- Build everyday to stay up-to-date with upstream distribution (alpine)
+
 ## Table of Contents
 
 * [Requirements](#requirements)
@@ -56,14 +61,14 @@ This is the only containerized NFS server that offers **all** of the following f
 
 ### Starting the server
 
-Starting the `erichough/nfs-server` image will launch an NFS server. You'll need to supply some information upon container startup, which we'll cover below, but briefly speaking your `docker run` command might look something like this:
+Starting the `ghcr.io/obeone/nfs-server` image will launch an NFS server. You'll need to supply some information upon container startup, which we'll cover below, but briefly speaking your `docker run` command might look something like this:
 
     docker run                                            \
       -v /host/path/to/shared/files:/some/container/path  \
       -v /host/path/to/exports.txt:/etc/exports:ro        \
       --cap-add SYS_ADMIN                                 \
       -p 2049:2049                                        \
-      erichough/nfs-server
+      ghcr.io/obeone/nfs-server
 
 Let's break that command down into its individual pieces to see what's required for a successful server startup.
 
@@ -86,7 +91,7 @@ Let's break that command down into its individual pieces to see what's required
           docker run                                      \
             -v /host/path/to/exports.txt:/etc/exports:ro  \
             ...                                           \
-            erichough/nfs-server
+            ghcr.io/obeone/nfs-server
 
    1. provide each line of `/etc/exports` as an environment variable
 
@@ -96,26 +101,26 @@ Let's break that command down into its individual pieces to see what's required
             -e NFS_EXPORT_0='/container/path/foo                  *(ro,no_subtree_check)'  \
             -e NFS_EXPORT_1='/container/path/bar 123.123.123.123/32(rw,no_subtree_check)'  \
             ...                                                                            \
-            erichough/nfs-server
+            ghcr.io/obeone/nfs-server
 
    1. bake `/etc/exports` into a custom image
 
        e.g. in a `Dockerfile`:
 
        ```Dockerfile
-       FROM erichough/nfs-server
+       FROM ghcr.io/obeone/nfs-server
        ADD /host/path/to/exports.txt /etc/exports
        ```
 
 1. **Use `--cap-add SYS_ADMIN` or `--privileged`**
 
    As noted in the [requirements](#requirements), the container will need additional privileges. So your `run` command will need *either*:
 
-       docker run --cap-add SYS_ADMIN ... erichough/nfs-server
+       docker run --cap-add SYS_ADMIN ... ghcr.io/obeone/nfs-server
 
     or
 
-       docker run --privileged ... erichough/nfs-server
+       docker run --privileged ... ghcr.io/obeone/nfs-server
 
     Not sure which to use? Go for `--cap-add SYS_ADMIN` as it's the lesser of two evils.
 
@@ -125,7 +130,7 @@ Let's break that command down into its individual pieces to see what's required
 
    * If your clients connect via **NFSv4 only**, you can get by with just TCP port `2049`:
 
-         docker run -p 2049:2049 ... erichough/nfs-server
+         docker run -p 2049:2049 ... ghcr.io/obeone/nfs-server
 
    * If you'd like to support **NFSv3**, you'll need to expose a lot more ports:
 
@@ -135,7 +140,7 @@ Let's break that command down into its individual pieces to see what's required
            -p 32765:32765 -p 32765:32765/udp \
            -p 32767:32767 -p 32767:32767/udp \
            ...                               \
-           erichough/nfs-server
+           ghcr.io/obeone/nfs-server
 
 If you pay close attention to each of the items in this section, the server should start quickly and be ready to accept your NFS clients.
 

doc/feature/apparmor.md

@@ -27,15 +27,15 @@ If your Docker host has [AppArmor](https://wiki.ubuntu.com/AppArmor) activated,
          --cap-add SYS_ADMIN                     \
          -p 2049:2049                            \
          --security-opt apparmor=erichough-nfs   \
-         erichough/nfs-server
+         ghcr.io/obeone/nfs-server
          
    or in `docker-compose.yml`:
 
    ```YAML
    version: 3
    services:
      nfs:
-       image: erichough/nfs-server
+       image: ghcr.io/obeone/nfs-server
        volumes:
          - /path/to/share:/nfs
          - /path/to/exports.txt:/etc/exports:ro
@@ -45,4 +45,4 @@ If your Docker host has [AppArmor](https://wiki.ubuntu.com/AppArmor) activated,
          - 2049:2049
        security_opt:
          - apparmor=erichough-nfs
-   ```
+   ```

doc/feature/auto-load-kernel-modules.md

@@ -13,7 +13,7 @@ Here's an example `docker-compose.yml`:
    version: 3
    services:
      nfs:
-       image: erichough/nfs-server
+       image: ghcr.io/obeone/nfs-server
        volumes:
          - /path/to/share:/nfs
          - /path/to/exports.txt:/etc/exports:ro
@@ -23,4 +23,4 @@ Here's an example `docker-compose.yml`:
          - SYS_MODULE
        ports:
          - 2049:2049
-   ```
+   ```

doc/feature/kerberos.md

@@ -18,4 +18,4 @@ Here's an example:
       -v /host/path/to/server.krb5conf:/etc/krb5.conf:ro  \
       --cap-add SYS_ADMIN                                 \
       -p 2049:2049                                        \
-      erichough/nfs-server
+      ghcr.io/obeone/nfs-server

doc/feature/logging.md

@@ -6,14 +6,14 @@ You can adjust the logging level via the `NFS_LOG_LEVEL` environment variable. C
 
 In your `docker-run` command:
 ```
-docker run -e NFS_LOG_LEVEL=DEBUG ... erichough/nfs-server
+docker run -e NFS_LOG_LEVEL=DEBUG ... ghcr.io/obeone/nfs-server
 ```
 or in `docker-compose.yml`:
 ```YAML
 version: 3
 services:
   nfs:
-    image: erichough/nfs-server
+    image: ghcr.io/obeone/nfs-server
     ...
     environment:
       - NFS_LOG_LEVEL: DEBUG
@@ -159,4 +159,4 @@ writing message: \x \x6082024606092a864886f71201020201006e82023530820231a0030201
 finished handling null request
 entering poll
 ...
-```
+```

doc/feature/nfs4-user-id-mapping.md

@@ -8,5 +8,5 @@ If you'd like to run [`idmapd`](http://man7.org/linux/man-pages/man8/idmapd.8.ht
       -v /host/path/to/idmapd.conf:/etc/idmapd.conf:ro  \
       --cap-add SYS_ADMIN                               \
       -p 2049:2049                                      \
-      erichough/nfs-server
-         
+      ghcr.io/obeone/nfs-server
+         

entrypoint.sh

@@ -2,7 +2,11 @@
 #
 # ehough/docker-nfs-server: A lightweight, robust, flexible, and containerized NFS server.
 #
-# https://hub.docker.com/r/erichough/nfs-server
+# https://github.com/obeone/docker-nfs-server
+# https://github.com/obeone/docker-nfs-server/pkgs/container/docker-nfs-server
+#
+# Almost all the work is from @ehough, I just created workflow to keep the
+# docker image up-to-date and build for multiple architectures
 # https://github.com/ehough/docker-nfs-server
 #
 # Copyright (C) 2017-2020  Eric D. Hough