#43 Document the configuration options

README.md

@@ -43,6 +43,26 @@ cat ~/.ssh/authorized_keys
 
 ## Running / Installation
 
+### Configuration File
+
+Regardless of the method of deployment, the `keys` application requires a config
+yaml file containing the list of keys to be served. An example file can be found
+in `./examples/keys-config.yaml`.
+
+The config file contains two main sections:
+
+- `ssh-keys`: A list of public ssh keys with the following fields:
+  - name: The name of the key (this will be used as the `@host` in the
+    `authorized_keys` file)
+  - key: The public key itself
+  - user: The user that the key should be associated with (this will be used as
+    the `user@host` in the `authorized_keys` file)
+  - tags: Optionally a list of tags that can be used to filter the keys
+- `pgp-keys`: A list of public pgp keys with the following fields:
+  - name: The name of the key (this will be used in the route and as the
+    filename if you download the key)
+  - key: The public key itself
+
 ### Helm
 
 #### Secret Creation

helm/values.yaml

@@ -1,6 +1,11 @@
+# registry to pull the image from, can usually be left as-is unless you're running a fork
 registry: ghcr.io/danielemery/keys
+# image version - this is used to pull the image AND to report the version in headers
 version: REPLACED_BY_CI
+# k8s secrets name to use for any application secrets
 secretName: keys-secret
 configFile:
+  # config file to mount into the container
   name: config.yaml
+  # path to mount the config file to
   mountPath: /config.yaml