Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

typo #116

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

typo #116

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7a59dac
Fix config references
satterly Dec 12, 2021
72e666d
typo
fungusakafungus Feb 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Empty file added auth/customers.rst
View file
Open in desktop
Empty file.
2 changes: 2 additions & 0 deletions auth/introduction.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@


Empty file added auth/ldap.rst
View file
Open in desktop
Empty file.
Empty file added auth/openid.rst
View file
Open in desktop
Empty file.
Empty file added auth/proxy.rst
View file
Open in desktop
Empty file.
Empty file added auth/roles.rst
View file
Open in desktop
Empty file.
18 changes: 9 additions & 9 deletions configuration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -500,7 +500,7 @@ HMAC Auth Settings
``HMAC_AUTH_CREDENTIALS``
HMAC credentials

.. _Audit Log config:
.. _Audit Log settings:

Audit Log Settings
~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -532,7 +532,7 @@ using a POST.
``AUDIT_URL``
forward audit logs to HTTP POST URL (no default)

.. _CORS config:
.. _CORS settings:

CORS Settings
~~~~~~~~~~~~~
Expand All @@ -552,7 +552,7 @@ CORS Settings
``CORS_ORIGINS``
URL origins that can access the API for Cross-Origin Resource Sharing (CORS)

.. _severity config:
.. _severity settings:

Severity Settings
~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -598,7 +598,7 @@ in which Alerta is deployed.
``COLOR_MAP``
dictionary of severity colors, text and highlight color

.. _timeout config:
.. _timeout settings:

Timeout Settings
~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -627,7 +627,7 @@ are important for generating alerts from stale heartbeats.
``SHELVE_TIMEOUT``
timeout period for unshelving alerts in shelved status (default is ``7200`` seconds, ``0`` = do not auto-unshelve)

.. _housekeeping config:
.. _housekeeping settings:

Housekeeping Settings
~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -648,7 +648,7 @@ Housekeeping Settings

.. note:: Ensure to set ``DEFAULT_INFORM_SEVERITY`` to the "informational" severity that should be deleted.

.. _email config:
.. _email settings:

Email Settings
~~~~~~~~~~~~~~
Expand Down Expand Up @@ -692,7 +692,7 @@ email address before they can login.
``SMTP_PASSWORD``
application-specific password for ``MAIL_FROM`` or ``SMTP_USERNAME`` (no default)

.. _webui config:
.. _webui settings:

Web UI Settings
~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -773,7 +773,7 @@ Alert Status Indicator Settings
``ASI_QUERIES``
list of alert queries applied to filter status indicators (see example for default)

.. _plugin config:
.. _plugin settings:

Plugin Settings
~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -887,7 +887,7 @@ Alerts and actions can be forwarded to other Alerta servers to create a
$ date | md5 | base64 <= create HMAC "secret"
MzVlMzQ5NWYzYWE2YTgxYTUyYmIyNDY0ZWE2ZWJlYTMK

.. _webhook config:
.. _webhook settings:

Webhook Settings
~~~~~~~~~~~~~~~~
Expand Down
4 changes: 2 additions & 2 deletions faq.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ To fix this you can either serve the web UI from the `same origin`_ as
the API using a web server to :ref:`reverse proxy <reverse proxy>` the
web UI or ensure that the API server `allows the origin`_ where the
web UI is hosted by adding it to the :envvar:`CORS_ORIGINS` :ref:`server
configuration <CORS config>` setting.
configuration <CORS settings>` setting.

.. _CORS: https://en.wikipedia.org/wiki/Cross-origin_resource_sharing
.. _same origin: https://developer.mozilla.org/en-US/docs/Web/Security/Same-origin_policy
Expand All @@ -39,7 +39,7 @@ enforces an alert "policy" of requiring an ``environment`` attribute of either

This is to encourage good habits early in defining useful alert attributes
that can be used to "namespace" alerts (this is what the ``environment``
attribute is for) and so that the web console can organise by ``environemnt``
attribute is for) and so that the web console can organise by ``environment``
and filter alerts by ``service``.

However, one of the principles of Alerta is not to enforce its view of the
Expand Down
33 changes: 2 additions & 31 deletions webui/configuration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,37 +113,8 @@ shown below that.

Client Settings
~~~~~~~~~~~~~~~
Full list of API server settings that can be used to configure clients.

``AUTH_REQUIRED``

``CUSTOMER_VIEWS``

``AUTH_PROVIDER``

``SIGNUP_ENABLED``

``OAUTH2_CLIENT_ID``

``GITHUB_URL``

``GITLAB_URL``

``KEYCLOAK_URL``

``KEYCLOAK_REALM``

``PINGFEDERATE_URL``

``COLOR_MAP``

``SEVERITY_MAP``

``GOOGLE_TRACKING_ID``

``AUTO_REFRESH_INTERVAL``

.. note:: It is not currently possible to configure dates or audio.
Full list of API server settings that can be used to configure clients can be found
at :ref:`webui settings`.

.. raw:: html
<style> .red { background-color: red } </style>
Expand Down