Skip to content

Commit

Permalink
Doc System -> Alerts.
Browse files Browse the repository at this point in the history
Ticket: #26679
  • Loading branch information
dlavigne committed Jun 25, 2018
1 parent 5950ff8 commit 49a0471
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 7 deletions.
4 changes: 4 additions & 0 deletions userguide/intro.rst
Expand Up @@ -202,6 +202,10 @@ The following screen options have changed:
:guilabel:`Reset SED Password` fields have been added to
:menuselection:`System --> Advanced`.

* :guilabel:`Alert Settings` has been added to :guilabel:`System` and can
be used to list the available alert conditions and to configure the
notification frequency on a per-alert basis.

* The :guilabel:`Remote encryption`, :guilabel:`Filename encryption`,
:guilabel:`Encryption password`, and :guilabel:`Encryption salt`
fields have been added to
Expand Down
27 changes: 20 additions & 7 deletions userguide/system.rst
Expand Up @@ -29,8 +29,10 @@ The System section of the administrative GUI contains these entries:
* :ref:`Alert Services` configures services used to notify the
administrator about system events.

* :ref:`Alert Settings` configures the default notification timing for
each alert message. See :ref:`Alert` for more information.
#ifdef freenas
* :ref:`Alert Settings` lists the available :ref:`Alert` conditions and
provides configuration of the notification frequency for each alert.
#endif freenas

* :ref:`Cloud Credentials` is used to enter connection credentials for
remote cloud service providers
Expand Down Expand Up @@ -1070,18 +1072,29 @@ page. Alert services can be deleted from this list by clicking
temporarily, click |ui-options| and :guilabel:`Edit`, then unset the
:guilabel:`Enabled` checkbox.


#ifdef freenas
.. index:: Alert Settings

.. _Alert Settings:

Alert Settings
--------------

:menuselection:`System --> Alert Settings` displays default notification
settings for each alert. For an alert, open the drop-down menu and
choose when the alert is triggered in %brand%. Choices are *IMMEDIATELY*,
*HOURLY*, *DAILY*, or *NEVER*
:menuselection:`System --> Alert Settings` displays the default notification
frequency for each type of :ref:`Alert`. An example is seen in
:numref:`Figure %s <alert_settings_fig>`.

.. _alert_settings_fig:

.. figure:: images/system-alert-settings.png

Configure Alert Notification Frequency

To change the notification frequency of an alert, click its drop-down
menu and select *IMMEDIATELY*, *HOURLY*, *DAILY*, or *NEVER*.

.. note:: To configure where to send alerts, use :ref:`Alert Services`.
#endif freenas

.. index:: Cloud Credentials
.. _Cloud Credentials:
Expand Down

0 comments on commit 49a0471

Please sign in to comment.