some adjustments

while testing things from scratch

Author: carueda

config/orront.conf

@@ -1,5 +1,5 @@
 ##############################################################################
-# This is the master ORR configuration file.
+# This is the master ORR configuration file (for a Docker-based installation)
 ##############################################################################
 
 ## The ${...} substitution syntax (e.g., ${branding.instanceName}) allows to
@@ -29,13 +29,19 @@ auth {
 }
 
 ## ---------------------------------------------------------------------------
-## Info about the deployment of this ORR instance.
+## Info about the deployment of this ORR instance in terms of associated
+## externally visible URLs
 deployment {
   ## (required) The (external) URL of this ORR instance. No trailing slash.
+  ## Initial value here corresponds to access on your localhost.
   url = "http://localhost:9090/ont"
 
   ## (required) The (external) URL of the SPARQL endpoint. No trailing slash.
-  sparqlEndpoint = "http://localhost:9090/sparql"
+  ## Initial value here corresponds to access to such endpoint on your localhost
+  ## according to how the corresponding AllegroGraph repository is exposed.
+  ## In general, this will have very limited use because it is not CORS enabled
+  ## (at least with the AllegroGraph version currently used).
+  sparqlEndpoint = "http://localhost:10035/repositories/mmiorr"
 }
 
 ## ---------------------------------------------------------------------------
@@ -65,39 +71,82 @@ branding {
 }
 
 ## ---------------------------------------------------------------------------
-## MongoDB
+## (Required) Settings for the ORR to be able to send out emails (when user
+## resets password; notifications about registrations, etc.)
+email {
+  ## (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 = "smtp.somewhere.example.net"
+    port = 465
+    prot = "smtps"
+    debug = false
+  }
+
+  ## Info used to compose emails:
+  from    = ${branding.instanceName}" <"${admin.email}">"
+  replyTo = ${admin.email}
+  mailer  = ${branding.instanceName}
+}
+
+## ---------------------------------------------------------------------------
+## Optional section.
+#googleAnalytics {
+#  propertyId = "?"
+#}
+
+## ---------------------------------------------------------------------------
+## Optional section.
+## See https://www.google.com/recaptcha/intro/.
+#recaptcha {
+#  privateKey = "?"
+#  siteKey    = "?"
+#}
+
+## ---------------------------------------------------------------------------
+## MongoDB.
+## Note: No changes are in general needed in this section (unless relevant
+## pieces in docker-compose.yml need to be changed for some reason).
 mongo {
   ## (required) Name of Mongo database to be used for ORR purposes.
   ## Can be changed if desired/needed.
   db = "orr-ont"
 
   ## (required) Mongo server host. Should be same value as indicated in
-  ## `docker-compose.yml` for the environment of the orr service.
+  ## `docker-compose.yml` for the 'MONGO_HOST' environment variable of the orr service.
   host = "mongo"
 
   ## (required) Mongo server port. Should be same value as indicated in
-  ## `docker-compose.yml` for the environment of the orr service.
+  ## `docker-compose.yml` for the 'MONGO_PORT' environment variable of the orr service.
   port = 27017
 }
 
 ## ---------------------------------------------------------------------------
 ## AllegroGraph server (which supports the triple store and SPARQL endpoint)
+## Note: No changes are in general needed in this section (unless relevant
+## pieces in docker-compose.yml need to be changed for some reason).
 agraph {
   ## (required) The desired AG username to access the ORR triple store
   userName = "test"
 
   ## (required) The desired password for the AG username above:
-  password = "replace-with-your-desired-pw"
+  password = "xyzzy"
 
   ## (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
-  ## `docker-compose.yml` for the environment of the orr service.
+  ## `docker-compose.yml` for the 'AGRAPH_HOST' environment variable of the orr service.
   host = "agraph"
 
   ## (required) AGraph server port. Should be same value as indicated in
-  ## `docker-compose.yml` for the environment of the orr service.
+  ## `docker-compose.yml` for the 'AGRAPH_PORT' environment variable of the orr service.
   port = 10035
 
   ## DO NOT change this:
@@ -107,49 +156,9 @@ agraph {
   initDelay = 20 seconds
 }
 
-## ---------------------------------------------------------------------------
-## (Required) email related information used for user account management and
-## notifications.
-email {
-  ## (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 = "smtp.somewhere.example.net"
-    port = 465
-    prot = "smtps"
-    debug = false
-  }
-
-  ## info used to compose emails (when user resets password; notifications
-  ## about registrations, etc.):
-  from    = ${branding.instanceName}" <"${admin.email}">"
-  replyTo = ${admin.email}
-  mailer  = ${branding.instanceName}
-}
-
-## ---------------------------------------------------------------------------
-## Optional section.
-#googleAnalytics {
-#  propertyId = "?"
-#}
-
-## ---------------------------------------------------------------------------
-## Optional section.
-## See https://www.google.com/recaptcha/intro/.
-#recaptcha {
-#  privateKey = "?"
-#  siteKey    = "?"
-#}
-
 ## ---------------------------------------------------------------------------
 ## files: managed file locations.
+## DO NOT change this section.
 files {
-  ## DO NOT change this.
   baseDirectory = "/opt/orr-ont-base-directory"
 }