Page tree
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 8 Current »

To configure the Data Steward, you must first make sure that you have created a user with Data Steward privileges. To create a Data Steward, please follow the instructions here: SHRINE 3.1.0 Chapter 8.2 - Setting Up the Data Steward User


Find the steward section in shrine.conf . This section governs how the data steward application behaves, including its ability to send audit emails to the Data Steward. Set valid email addresses in the 'From' and 'To' fields. Set the externalStewardBaseUrl to the URL your Data Steward should use for the data steward application. (The email contains a link to help easily start the audits.)


shrine.conf
shrine {
...
  steward {
    createTopicsMode = Approved //the default is Pending - the most secure - but most sites use Approved

    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 = ${shrine.shrineHubBaseUrl}/shrine-api/shrine-steward
    }
  } // end steward
...
}

If you wish to not send emails, override the sendAuditEmails = false in this section.


SHRINE by default assumes it can send mail via smtp on localhost port 25. However, if your tomcat server cannot easily send email you may need to add an email{} section inside of the shrine{} section in shrine.conf. SHRINE sends emails from postfix on port 25 by default. SHRINE uses javaxmail internally. Any valid javaxmail configuration values should be supported by shrine.conf. Here is an example that uses AWS SES:

shrine.conf
shrine {
...
  email {
    //add javax mail properties from https://www.tutorialspoint.com/javamail_api/javamail_api_smtp_servers.htm here
    javaxmail {
      mail {
        smtp {
          //for postfix on localhost
          //host = localhost
          //port = 25

          //for AWS SES - See http://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-using-smtp-java.html
		  //comment out if you want to just use postfix over port 25
          host = email-smtp.us-east-1.amazonaws.com
          port = 25
          transport.protocol = smtps
          auth = true
          starttls.enable = true
          starttls.required = true
        } 
      } 
    }//end javaxmail section

    //Must be set for AWS SES. See http://docs.aws.amazon.com/ses/latest/DeveloperGuide/send-using-smtp-java.html
    authenticator {
      username = yourSESUsername
    }
  } //end email section
...
}
password.conf
shrine.email.javaxmail.authenticator.password = yourSESPassword
  • No labels