fixing broken links in README. fixes ehough#29 and ehough#35

Author: ehough

CHANGELOG.md

@@ -6,6 +6,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [unreleased]
 
+### Fixed
+* Broken links in README, both on GitHub and Docker Hub ([#29](https://github.com/ehough/docker-nfs-server/issues/29), [#35](https://github.com/ehough/docker-nfs-server/issues/35))
+
 ### Changed
 * Use pure Bash for uppercasing strings ([#36](https://github.com/ehough/docker-nfs-server/issues/36))
 

README.md

@@ -11,11 +11,11 @@ This is the only containerized NFS server that offers **all** of the following f
 - clean teardown of services upon termination (no lingering `nfsd` processes on Docker host)
 - flexible construction of `/etc/exports`
 - extensive server configuration via environment variables
-- human-readable logging (with a helpful [debug mode](doc/feature/logging.md))
+- human-readable logging (with a helpful [debug mode](https://github.com/ehough/docker-nfs-server/blob/develop/doc/feature/logging.md))
 - *optional* bonus features
-  - [Kerberos security](doc/feature/kerberos.md)
-  - [NFSv4 user ID mapping](doc/feature/nfs4-user-id-mapping.md) via [`idmapd`](http://man7.org/linux/man-pages/man8/idmapd.8.html)
-  - [AppArmor](doc/feature/apparmor.md) compatibility
+  - [Kerberos security](https://github.com/ehough/docker-nfs-server/blob/develop/doc/feature/kerberos.md)
+  - [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
 
 ## Table of Contents
 
@@ -24,15 +24,15 @@ This is the only containerized NFS server that offers **all** of the following f
   * [Starting the server](#starting-the-server)
   * [Mounting filesystems from a client](#mounting-filesystems-from-a-client)
 * Optional features
-  * [Debug logging](doc/feature/logging.md)
-  * [Kerberos security](doc/feature/kerberos.md)
-  * [NFSv4 user ID mapping](doc/feature/nfs4-user-id-mapping.md)
-  * [AppArmor integration](doc/feature/apparmor.md)
+  * [Debug logging](https://github.com/ehough/docker-nfs-server/blob/develop/doc/feature/logging.md)
+  * [Kerberos security](https://github.com/ehough/docker-nfs-server/blob/develop/doc/feature/kerberos.md)
+  * [NFSv4 user ID mapping](https://github.com/ehough/docker-nfs-server/blob/develop/doc/feature/nfs4-user-id-mapping.md)
+  * [AppArmor integration](https://github.com/ehough/docker-nfs-server/blob/develop/doc/feature/apparmor.md)
 * Advanced
-  * [automatically load required kernel modules](doc/feature/auto-load-kernel-modules.md)
-  * [custom server ports](doc/advanced/ports.md)
-  * [custom NFS versions offered](doc/advanced/nfs-versions.md)
-  * [performance tuning](doc/advanced/performance-tuning.md)
+  * [automatically load required kernel modules](https://github.com/ehough/docker-nfs-server/blob/develop/doc/feature/auto-load-kernel-modules.md)
+  * [custom server ports](https://github.com/ehough/docker-nfs-server/blob/develop/doc/advanced/ports.md)
+  * [custom NFS versions offered](https://github.com/ehough/docker-nfs-server/blob/develop/doc/advanced/nfs-versions.md)
+  * [performance tuning](https://github.com/ehough/docker-nfs-server/blob/develop/doc/advanced/performance-tuning.md)
 * [Help!](#help)
 * [Remaining tasks](#remaining-tasks)
 * [Acknowledgements](#acknowledgements)
@@ -48,7 +48,7 @@ This is the only containerized NFS server that offers **all** of the following f
 
    `modprobe {nfs,nfsd,rpcsec_gss_krb5}`
 
-   or you can just allow the container to [load them automatically](doc/feature/auto-load-kernel-modules.md).
+   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).
 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.
 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.
 
@@ -121,7 +121,7 @@ Let's break that command down into its individual pieces to see what's required
 
 1. **Expose the server ports**
 
-   You'll need to open up at least one server port for your client connections. The ports listed in the examples below are the defaults used by this image and most can be [customized](doc/ports.md).
+   You'll need to open up at least one server port for your client connections. The ports listed in the examples below are the defaults used by this image and most can be [customized](https://github.com/ehough/docker-nfs-server/blob/develop/doc/advanced/ports.md).
 
    * If your clients connect via **NFSv4 only**, you can get by with just TCP port `2049`:
 
@@ -145,17 +145,17 @@ If you pay close attention to each of the items in this section, the server shou
 
 ## Optional Features
 
-  * [Debug logging](doc/feature/logging.md)
-  * [Kerberos security](doc/feature/kerberos.md)
-  * [NFSv4 user ID mapping](doc/feature/nfs4-user-id-mapping.md)
-  * [AppArmor integration](doc/feature/apparmor.md)
+  * [Debug logging](https://github.com/ehough/docker-nfs-server/blob/develop/doc/feature/logging.md)
+  * [Kerberos security](https://github.com/ehough/docker-nfs-server/blob/develop/doc/feature/kerberos.md)
+  * [NFSv4 user ID mapping](https://github.com/ehough/docker-nfs-server/blob/develop/doc/feature/nfs4-user-id-mapping.md)
+  * [AppArmor integration](https://github.com/ehough/docker-nfs-server/blob/develop/doc/feature/apparmor.md)
 
 ## Advanced
 
-  * [automatically load required kernel modules](doc/feature/auto-load-kernel-modules.md)
-  * [customizing which ports are used](doc/advanced/ports.md)
-  * [customizing NFS versions offered](doc/advanced/nfs-versions.md)
-  * [performance tuning](doc/advanced/performance-tuning.md)
+  * [automatically load required kernel modules](https://github.com/ehough/docker-nfs-server/blob/develop/doc/feature/auto-load-kernel-modules.md)
+  * [customizing which ports are used](https://github.com/ehough/docker-nfs-server/blob/develop/doc/advanced/ports.md)
+  * [customizing NFS versions offered](https://github.com/ehough/docker-nfs-server/blob/develop/doc/advanced/nfs-versions.md)
+  * [performance tuning](https://github.com/ehough/docker-nfs-server/blob/develop/doc/advanced/performance-tuning.md)
 
 ## Help!