diff --git a/auth/customers.rst b/auth/customers.rst new file mode 100644 index 00000000..e69de29b diff --git a/auth/introduction.rst b/auth/introduction.rst new file mode 100644 index 00000000..139597f9 --- /dev/null +++ b/auth/introduction.rst @@ -0,0 +1,2 @@ + + diff --git a/auth/ldap.rst b/auth/ldap.rst new file mode 100644 index 00000000..e69de29b diff --git a/auth/openid.rst b/auth/openid.rst new file mode 100644 index 00000000..e69de29b diff --git a/auth/proxy.rst b/auth/proxy.rst new file mode 100644 index 00000000..e69de29b diff --git a/auth/roles.rst b/auth/roles.rst new file mode 100644 index 00000000..e69de29b diff --git a/configuration.rst b/configuration.rst index 2e205ccd..60ae621e 100644 --- a/configuration.rst +++ b/configuration.rst @@ -500,7 +500,7 @@ HMAC Auth Settings ``HMAC_AUTH_CREDENTIALS`` HMAC credentials -.. _Audit Log config: +.. _Audit Log settings: Audit Log Settings ~~~~~~~~~~~~~~~~~~ @@ -532,7 +532,7 @@ using a POST. ``AUDIT_URL`` forward audit logs to HTTP POST URL (no default) -.. _CORS config: +.. _CORS settings: CORS Settings ~~~~~~~~~~~~~ @@ -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 ~~~~~~~~~~~~~~~~~ @@ -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 ~~~~~~~~~~~~~~~~ @@ -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 ~~~~~~~~~~~~~~~~~~~~~ @@ -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 ~~~~~~~~~~~~~~ @@ -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 ~~~~~~~~~~~~~~~ @@ -719,6 +719,9 @@ The following settings are specific to the web UI and are not used by the server } GOOGLE_TRACKING_ID = 'UA-44644195-5' AUTO_REFRESH_INTERVAL = 30000 # 30s + CLIPBOARD_TEMPLATE = """ + [{{environment}} - {{severity}}] {{text}} + """ .. index:: SITE_LOGO_URL, DATE_FORMAT_SHORT_TIME, DATE_FORMAT_MEDIUM_DATE, DATE_FORMAT_LONG_DATE .. index:: DEFAULT_AUDIO_FILE, COLUMNS, SORT_LIST_BY, DEFAULT_FILTER, DEFAULT_FONT, ACTIONS @@ -748,6 +751,10 @@ The following settings are specific to the web UI and are not used by the server used by the web UI to send tracking data to Google Analytics (no default) ``AUTO_REFRESH_INTERVAL`` interval at which the web UI refreshes alert list (default is ``5000`` milliseconds) +``CLIPBOARD_TEMPLATE`` + `Nunjucks-template`_ used to format alert data for clipboard copy. For the copy button in the alert-details. Refer to :ref:`the alert format documentation ` to get details of the fields you can use (no default). + +.. _Nunjucks-template: https://mozilla.github.io/nunjucks/templating.html .. asi_config: @@ -773,7 +780,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 ~~~~~~~~~~~~~~~~ @@ -887,7 +894,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 ~~~~~~~~~~~~~~~~ diff --git a/faq.rst b/faq.rst index 09b33871..72ada428 100644 --- a/faq.rst +++ b/faq.rst @@ -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 ` 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 ` setting. +configuration ` 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 diff --git a/webui/configuration.rst b/webui/configuration.rst index 0ea44fdc..a5b80693 100644 --- a/webui/configuration.rst +++ b/webui/configuration.rst @@ -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