Stages Documentation

Differences

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

Link to this comparison view

Next revision		Previous revision
76:email_notification [2020/10/26 15:45] – created twn76:email_notification [2024/02/15 00:00] (current) – external edit 127.0.0.1
Line 3: Line 3:
 ====== E-mail Notifications ====== ====== E-mail Notifications ======
  
-The Stages e-mail notification service informs Stages users about new news application entries and the assignment of new roles. Also Stages can schedule certain tasks such as the creation of a process version, if a notification server has been configured. The task will then be queued and the user will be informed once it is finished.+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 ''<STAGESHOME>/conf/config.xml'' configuration file.
  
-Example:<code>+Example: (STARTTLS) 
 + 
 +<code>
 <notification> <notification>
  <!-- URL of Stages server -->  <!-- URL of Stages server -->
- <serverurl>http://stages.example.com:8080</serverurl>+ <serverurl>https://stages.example.com/stages</serverurl>
  
  <!-- hostname of SMTP server where e-mail can be delivered -->  <!-- hostname of SMTP server where e-mail can be delivered -->
  <mailserver>mail.example.com</mailserver>  <mailserver>mail.example.com</mailserver>
 + <!-- server port; optional; default: 25 -->
 + <mailserverport>587</mailserverport>
 + <!-- use STARTTLS; optional; default: false -->
 + <mailserverusestarttls>true</mailserverusestarttls>
  
  <!-- address that should be used as the "Reply-To:" header -->  <!-- address that should be used as the "Reply-To:" header -->
Line 25: Line 31:
  
 </notification> </notification>
- 
  
 </code> </code>
  
-To use encrytped communication with the mail server via STARTTLS please proceed as follows:+Example: (SMTPS)
  
-  * Windows: +<code> 
-      * Open file "<Stages installation path>\stages\config.bat" +<notification> 
-      * Add the red colored setting to the line: //set JAVA_OPTS=-Dmail.smtp.port=587 -Dmail.smtp.starttls.enable=true// + <!-- URL of Stages server --> 
-      * Open a cmd with administrative permissions and navigate to folder "<Stages installation path>\stages\bin" + <serverurl>https://stages.example.com/stages</serverurl> 
-      * Reinstall the Stages service: **reinstallService.bat** + 
-      * Restart Stages service: **net start stages** + <!-- hostname of SMTP server where e-mail can be delivered --> 
-  * Linux: + <mailserver>mail.example.com</mailserver> 
-      * Open file "<Stages installation path>/stages/bin/rc.conf" + <!-- server port; optional; default: 25 --> 
-      * Add the red colored seeting to the line: //CONF_JAVA_OPTS=-Dmail.smtp.port=587 -Dmail.smtp.starttls.enable=true// + <mailserverport>465</mailserverport> 
-      * Restart the Stages service:** stages restart**+ <!-- use smtps (SSL); optional; default: smtp --> 
 + <mailserverprotocol>smtps</mailserverprotocol> 
 + 
 + <!-- address that should be used as the "Reply-To:" header --> 
 + <replyto>noreply@yourdomain.com</replyto> 
 + 
 + <!--address that should be used as the "From:" header --> 
 + <sender>Stages Notification Service <noreply@yourdomain.com></sender> 
 + 
 + <!-- interval for "ASAP" notifications in minutes --> 
 + <minimumInterval>120</minimumInterval> 
 + 
 +</notification> 
 + 
 +</code>