improve description of some entries

Author: carueda

config/orront.conf

@@ -3,10 +3,8 @@
 ##############################################################################
 
 ## The ${...} substitution syntax (e.g., ${branding.instanceName}) allows to
-## refer # to the value assigned to a specific entry elsewhere in this file.
-## The ${?...} substitution syntax allows to override settings via environment
-## variables. See
-## https://github.com/typesafehub/config#optional-system-or-env-variable-overrides
+## refer to the value assigned to a specific entry elsewhere in this file.
+## See https://github.com/lightbend/config#uses-of-substitutions
 
 ## ---------------------------------------------------------------------------
 ## There will be an "admin" user automatically created upon initial start of
@@ -27,7 +25,7 @@ admin {
 ## User authentication
 auth {
   ## (required) A strong password to generate authentication tokens.
-  secret = "actual-strong-password"
+  secret = "replace-with-actual-strong-password"
 }
 
 ## ---------------------------------------------------------------------------
@@ -54,11 +52,11 @@ branding {
 
   ## (optional) URL of image to show in the page header.
   ## By default, this will be MMI ORR's logo.
-  #logo = "?"
+  #logo = "http://example.net/somelogo.png"
 
   ## (optional) URL for "Terms of Use" link.
   ## No default value (so no such link is shown).
-  #tou = "?"
+  #tou = "http://example.net/sometou"
 
   ## (optional) "Contact us" link.
   ## No default value (so no such link is shown).
@@ -96,24 +94,16 @@ mongo {
   port = 27017
 }
 
-## ---------------------------------------------------------------------------
-## files: managed file locations.
-files {
-  ## DO NOT change this.
-  baseDirectory = "/opt/orr-ont-base-directory"
-}
-
 ## ---------------------------------------------------------------------------
 ## AllegroGraph server (which supports the triple store and SPARQL endpoint)
 agraph {
-  ## (required) The AG username to access the triple store
+  ## (required) The desired AG username to access the ORR triple store
   userName = "test"
 
-  ## (required) The password for the AG username above:
-  password = "actual-pw"
+  ## (required) The desired password for the AG username above:
+  password = "replace-with-your-desired-pw"
 
-  ## (required) Name of the AG repository for the ORR.
-  ## Can be changed if desired.
+  ## (required) Desired name for the AG repository to be used for ORR purposes.
   repoName  = "mmiorr"
 
   ## (required) AGraph server host. Should be same value as indicated in
@@ -124,7 +114,7 @@ agraph {
   ## `docker-compose.yml` for the environment of the orr service.
   port = 10035
 
-  ## DO NOT change:
+  ## DO NOT change this:
   sparqlEndpoint = "http://"${agraph.host}":"${agraph.port}/repositories/${agraph.repoName}
 
   ## initDelay: (optional) Re-attempt triple store initialization after this delay.
@@ -135,15 +125,16 @@ agraph {
 ## (Required) email related information used for user account management and
 ## notifications.
 email {
-  ## (required) account used for sending emails
+  ## (required) account used for sending emails.
+  ## This account information must be valid in the server indicated below.
   account {
     username = "[email protected]"
     password = "actual-pw"
   }
 
   ## (required) corresponding email server for the account above.
   server {
-    host = "?"
+    host = "smtp.somewhere.example.net"
     port = 465
     prot = "smtps"
     debug = false
@@ -155,3 +146,10 @@ email {
   replyTo = ${admin.email}
   mailer  = ${branding.instanceName}
 }
+
+## ---------------------------------------------------------------------------
+## files: managed file locations.
+files {
+  ## DO NOT change this.
+  baseDirectory = "/opt/orr-ont-base-directory"
+}