[seiscomp, scanloc] Install, add .gitignore

share/doc/seiscomp/html/_sources/apps/scm_email.rst.txt

@@ -0,0 +1,138 @@
+.. _scm_email:
+
+#####
+email
+#####
+
+Email plugin for scm which sends emails based on client status.
+
+Description
+===========
+
+The email plugin sends emails to configured receipients if a client status
+messages passes the configured :confval:`filter <memailplugin.filter>`.
+
+Plugin
+======
+
+The email plugin is installed under :file:`share/plugins/monitor/memailplugin.so`.
+
+To add the plugin to :ref:`scm`, add it to the plugin list:
+
+.. code-block:: sh
+
+   plugins = ${plugins}, memailplugin
+
+
+Examples
+========
+
+An example configuration looks like this:
+
+.. code-block:: sh
+
+   # Send notification is a clients CPU usage exceeds 100 percent
+   memailplugin.filter = "cpuusage>100"
+
+   # Send emails, yes
+   memailplugin.sendEmail = true
+
+   # Send emails to this address(es)
+   memailplugin.recipients = operator@my-agency.org, operator2@my-agency.org
+
+   memailplugin.reportSilentClients = false
+
+   # Minutes before report missing clients
+   memailplugin.reportRequiredClients = 1
+
+   # Interval to calculate mean of the message values for (in minutes)
+   memailplugin.filterMeanInterval = 1
+
+   # List of clients we definitely require to be operative
+   memailplugin.requiredClients = scautopick, scautoloc, scevent, scamp,\
+                                  scmag, scqc, scevtlog
+
+.. _scm_email_configuration:
+
+Module Configuration
+====================
+
+
+.. confval:: memailplugin.recipients
+
+   Type: *list:string*
+
+   Defines a comma separated list of email addresses to send
+   notifications to.
+
+
+.. confval:: memailplugin.template
+
+   Type: *string*
+
+   Configures a custom message text that is appended to each message
+   when clients passed the filter.
+
+
+.. confval:: memailplugin.filter
+
+   Type: *string*
+
+   Defines the filter for each client status. A filter is an expression
+   that can be constructed with all available status tags \(scm \-\-print\-tags\)
+   and logical and numerical operators. See scm for more information.
+
+
+.. confval:: memailplugin.requiredClients
+
+   Type: *list:string*
+
+   *No description available*
+
+.. confval:: memailplugin.reportSilentClients
+
+   Default: ``true``
+
+   Type: *boolean*
+
+   *No description available*
+
+.. confval:: memailplugin.reportSilentClientsTimeSpan
+
+   Default: ``1``
+
+   Type: *double*
+
+   Unit: *min*
+
+   *No description available*
+
+.. confval:: memailplugin.reportRequiredClients
+
+   Default: ``10``
+
+   Type: *double*
+
+   Unit: *min*
+
+   *No description available*
+
+.. confval:: memailplugin.filterMeanInterval
+
+   Default: ``10``
+
+   Type: *double*
+
+   Unit: *min*
+
+   *No description available*
+
+.. confval:: memailplugin.sendEmail
+
+   Default: ``false``
+
+   Type: *boolean*
+
+   Enables sending of emails using mailx shell command.
+
+