diff --git a/dir1/README.md b/dir1/README.md index c37575b..b11cd6b 100644 --- a/dir1/README.md +++ b/dir1/README.md @@ -223,38 +223,38 @@ --- -#Reference +# Reference ``` ./kdc start|stop|build|clean|config|shellinit ``` -##build +## build Builds the docker image. -##start +## start Starts the container in detached mode while also producing a Kerberos configuration file (`krb5.conf`) as well as a Kerberos keytab (`krb5.keytab`) locally. Note that the keytab is only readable/usable by the current user unless you change its access rights which is not recommended for production environments. -##stop +## stop Stops the container and deletes `krb5.conf` as well as `krb5.keytab`. -##clean +## clean Removes the docker image. -##config +## config Shows relevant configuration information. -##test +## test Checks if the KDC is reachable and accepting connections. -##shellinit +## shellinit Renders the environment variables needed for using the KDC. KRB5_CONFIG points towards the temporary configuration file. KRB5_KTNAME points towards the temporary keytab file. --- -#TODO +# TODO - strip down base image to squeeze out some space - refactor code into something less convoluted @@ -263,12 +263,12 @@ --- -#Credits +# Credits This script was inspired by some work of a co-worker of mine, Matthias Veit. Matthias did the hard work of finding out how to properly route docker ports on boot2docker hosts. --- -#Author +# Author * [Till Toenshoff](https://github.com/tillt) ([@ttoenshoff](https://twitter.com/ttoenshoff))