Stages Documentation

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Last revisionBoth sides next revision
710:email_notification [2024/03/06 01:32] – created - external edit 127.0.0.1710:email_notification [2024/03/08 10:20] – Weinlein, Thomas
Line 1: Line 1:
-[[:710:configure_stages|Configure the Stages Server]]+[[:79:configure_stages|Configure the Stages Server]]
  
 ====== E-mail Notifications ====== ====== E-mail Notifications ======
Line 5: Line 5:
 The Stages e-mail notification service informs Stages users about Process Release tasks. A Stages administrator gets informed about the result of regular background tasks like the CMS prefetch. The Stages e-mail notification service informs Stages users about Process Release tasks. A Stages administrator gets informed about the result of regular background tasks like the CMS prefetch.
  
-Before using this notification service, a few configuration parameters must be set in the ''<STAGESHOME>/conf/config.xml'' configuration file.+Before using this notification service, a few configuration parameters must be set in the ''$STAGES_CONF/config.xml'' configuration file.
  
 Example: (STARTTLS) Example: (STARTTLS)
Line 12: Line 12:
 <notification> <notification>
  <!-- URL of Stages server -->  <!-- URL of Stages server -->
- <serverurl>https://stages.example.com/stages</serverurl>+ <serverurl>https://${general.external.hostname}/stages</serverurl>
  
  <!-- hostname of SMTP server where e-mail can be delivered -->  <!-- hostname of SMTP server where e-mail can be delivered -->
Line 26: Line 26:
  <!--address that should be used as the "From:" header -->  <!--address that should be used as the "From:" header -->
  <sender>Stages Notification Service <noreply@yourdomain.com></sender>  <sender>Stages Notification Service <noreply@yourdomain.com></sender>
- 
- <!-- interval for "ASAP" notifications in minutes --> 
- <minimumInterval>120</minimumInterval> 
  
 </notification> </notification>
Line 39: Line 36:
 <notification> <notification>
  <!-- URL of Stages server -->  <!-- URL of Stages server -->
- <serverurl>https://stages.example.com/stages</serverurl>+ <serverurl>https://${general.external.hostname}/stages</serverurl>
  
  <!-- hostname of SMTP server where e-mail can be delivered -->  <!-- hostname of SMTP server where e-mail can be delivered -->
Line 53: Line 50:
  <!--address that should be used as the "From:" header -->  <!--address that should be used as the "From:" header -->
  <sender>Stages Notification Service <noreply@yourdomain.com></sender>  <sender>Stages Notification Service <noreply@yourdomain.com></sender>
- 
- <!-- interval for "ASAP" notifications in minutes --> 
- <minimumInterval>120</minimumInterval> 
  
 </notification> </notification>
Line 61: Line 55:
 </code> </code>
  
 +===== Email Authentication =====
  
 +If the specified notification e-mail server requires user authentication, additional tags have to be inserted.
 +
 +The following example describes such an authentication configuration:
 +
 +<code>
 +<!—- username that should be used for authentication -->
 +<mailuser>${mailserver.username}</mailuser>
 +
 +<!—- password to authenticate mailuser -->
 +<mailpassword>${mailserver.password}</mailpassword>
 +
 +<!—- name of the SASL realm -->
 +<saslrealm>SASL.YOURDOMAIN.COM</saslrealm>
 +</code>
 +
 +''$STAGES_CONF/secret.properties''
 +<code>
 +mailserver.username = John Doe
 +mailserver.password = secret
 +</code>