Updated documentation for clarity.

[arvados.git] / docker / config.yml.example

diff --git a/docker/config.yml.example b/docker/config.yml.example
index e27030aed053ebc1310cdc88648825e6589d21a9..6ada7f8520346e131b94f09e7988aa282903ea36 100644 (file)
--- a/docker/config.yml.example
+++ b/docker/config.yml.example
@@ -1,6 +1,12 @@
 # Configuration for the Rails databases (database names,
 # usernames and passwords).
 
+# Path to a public ssh key you would like to have installed in the
+# root account of the generated images. This is useful for debugging.
+# To enable the SSH server, set the ENABLE_SSH environment variable to
+# true when starting the container.
+PUBLIC_KEY_PATH:
+
 # ARVADOS_DOMAIN: the Internet domain of this installation.
 # ARVADOS_DNS_SERVER: the authoritative nameserver for ARVADOS_DOMAIN.
 ARVADOS_DOMAIN:         # e.g. arvados.internal
@@ -38,8 +44,15 @@ ARVADOS_PROD_PW:
 # If a _SECRET variable is set to an empty string, a password
 # will be chosen randomly at build time. This is the
 # recommended setting.
+
+# The value for the Rails config.secret_token setting.
 API_SECRET:
 
+# A "superuser" token with which servers can authenticate to
+# the API server, before an administrative user has been created.
+# Leave this blank to generate a secret randomly at build time (recommended).
+API_SUPERUSER_SECRET:
+
 # More than anything this should be auto-generated, but
 # we don't presently have a good place to store it. So just
 # change it and don't be dumb.