/
SHRINE 3.1.0 Upgrade Chapter 6 - Configuration Changes

SHRINE 3.1.0 Upgrade Chapter 6 - Configuration Changes

May 28, 2021

Clean up shrine.conf

shrine.conf is considerably more compact than in SHRINE 3.0.0. Take this opportunity to start with a fresh shrine.conf file available in shrine-setup/qep-and-adapter-shrine.conf.

Add password.conf file 

Move shrine.keystore.password and shrine.hiveCredentials.password properties from shrine.conf to password.conf. The password.conf file should contain the following properties:

shrine.keystore.password = "<enter your password>"
shrine.hiveCredentials.password = "<enter your password>"

Update shrine.conf

  • Remove pmEndpoint.url. Add pmEndpoint.urlPath property to shrine.conf only if different from default value of /i2b2/services/PMService/getServices/. This value will be appended to the i2b2BaseUrl. 
  • Remove ontEndpoint.url. Add ontEndpoint.urlPath property to shrine.conf only if different from default value of /i2b2/services/rest/OntologyService/. This value will be appended to the i2b2BaseUrl. 
  • Remove adapter.crcEndpoint.url. Add adapter.crcEndpoint.urlPath property to shrine.conf only if different from default value of /i2b2/services/QueryToolService/. This value will be appended to the i2b2BaseUrl. 
  • Remove breakdownResultOutputTypes.
  • Move shrine.messagequeue element to to shrine.hub.messagequeue.
  • Move i2b2BaseUrl and shrinehubBaseUrl into the main shrine{} block.

Updated shrine.conf

shrine {


  shrineHubBaseUrl = "https://shrine-hub.faraway.com:6443" //The shrine hub's URL as observed from this tomcat server
  i2b2BaseUrl = "http://i2b2.example.com:9090" //The local i2b2's URL as observed from this tomcat server
  i2b2Domain = "exampleDomain"
  i2b2ShrineProjectName = "SHRINE"


  nodeKey = "testNode" //node key to get information from the hub about this node.


  //shrineDatabaseType = "mysql" // "mysql" by default. It can be "sqlserver" "mysql" or "oracle"


  webclient {
   siteAdminEmail = "shrine-admin@example.com"
  }
  
  hiveCredentials {
    username = "demo"
    crcProjectId = "Demo"
  }//hiveCredentials


  keystore {
    privateKeyAlias = "shrine-node1"
    caCertAliases = ["shrine-ca"]
  }//keystore


  steward {
    emailDataSteward {
      //provide the email address of the shrine node system admin, to handle bounces and invalid addresses
      from = "shrine-admin@example.com"
      //provide the email address of the shrine node system admin, to handle bounces and invalid addresses
      to = "shrine-steward@example.com"
      //provide the externally-reachable URL for the data steward
      externalStewardBaseUrl = "https://shrine.example.com:6443/shrine-api/shrine-steward"
    }
  }//steward
}//shrine



(Optional) Require a specific project for users

To require users to be a member of a specific PM cell project.

shrine.authenticate.pmProjectName = "ACT"

(Optional) Override default info logging level

Override with environmental override in /opt/shrine/tomcat/webapps/shrine-api/WEB-INF/classes/logback.xml. Below is an example of changing the logging level to debug:

<logger name="net.shrine" additivity="false" level="debug">
 <appender-ref ref="shrine"/>
</logger>