From 4ba1b6465a07d64b1b2a1e4d73b8607a47534ae9 Mon Sep 17 00:00:00 2001 From: James Elliott Date: Thu, 4 May 2023 21:23:15 +1000 Subject: [PATCH] docs: add alert for configuration sections (#5380) Signed-off-by: James Elliott --- docs/content/en/configuration/first-factor/file.md | 4 ++++ docs/content/en/configuration/first-factor/introduction.md | 4 ++++ docs/content/en/configuration/first-factor/ldap.md | 4 ++++ .../en/configuration/identity-providers/open-id-connect.md | 4 +++- .../content/en/configuration/miscellaneous/introduction.md | 2 ++ docs/content/en/configuration/miscellaneous/logging.md | 2 ++ docs/content/en/configuration/miscellaneous/ntp.md | 2 ++ .../en/configuration/miscellaneous/privacy-policy.md | 2 ++ .../configuration/miscellaneous/server-endpoints-authz.md | 2 ++ docs/content/en/configuration/miscellaneous/server.md | 2 ++ docs/content/en/configuration/notifications/file.md | 4 ++++ .../content/en/configuration/notifications/introduction.md | 4 ++++ docs/content/en/configuration/notifications/smtp.md | 4 ++++ docs/content/en/configuration/prologue/common.md | 3 ++- docs/content/en/configuration/second-factor/duo.md | 4 ++++ .../second-factor/time-based-one-time-password.md | 4 ++++ docs/content/en/configuration/second-factor/webauthn.md | 4 ++++ docs/content/en/configuration/security/access-control.md | 4 ++++ docs/content/en/configuration/security/password-policy.md | 4 ++++ docs/content/en/configuration/security/regulation.md | 4 ++++ docs/content/en/configuration/session/introduction.md | 4 ++++ docs/content/en/configuration/session/redis.md | 4 ++++ docs/content/en/configuration/storage/introduction.md | 4 ++++ docs/content/en/configuration/storage/mysql.md | 4 ++++ docs/content/en/configuration/storage/postgres.md | 4 ++++ docs/content/en/configuration/storage/sqlite.md | 4 ++++ docs/content/en/configuration/telemetry/metrics.md | 4 ++++ docs/layouts/shortcodes/config-alert-example.html | 7 +++++++ 28 files changed, 100 insertions(+), 2 deletions(-) create mode 100644 docs/layouts/shortcodes/config-alert-example.html diff --git a/docs/content/en/configuration/first-factor/file.md b/docs/content/en/configuration/first-factor/file.md index 856d3da0d..896ec8aa2 100644 --- a/docs/content/en/configuration/first-factor/file.md +++ b/docs/content/en/configuration/first-factor/file.md @@ -16,6 +16,8 @@ aliases: ## Configuration +{{< config-alert-example >}} + ```yaml authentication_backend: file: @@ -54,6 +56,8 @@ authentication_backend: ## Options +This section describes the individual configuration options. + ### path {{< confkey type="string" required="yes" >}} diff --git a/docs/content/en/configuration/first-factor/introduction.md b/docs/content/en/configuration/first-factor/introduction.md index 4c620e9c7..434d601cb 100644 --- a/docs/content/en/configuration/first-factor/introduction.md +++ b/docs/content/en/configuration/first-factor/introduction.md @@ -23,6 +23,8 @@ There are two ways to integrate *Authelia* with an authentication backend: ## Configuration +{{< config-alert-example >}} + ```yaml authentication_backend: refresh_interval: 5m @@ -33,6 +35,8 @@ authentication_backend: ## Options +This section describes the individual configuration options. + ### refresh_interval {{< confkey type="duration" default="5m" required="no" >}} diff --git a/docs/content/en/configuration/first-factor/ldap.md b/docs/content/en/configuration/first-factor/ldap.md index 7a0ee0d31..a1f73f7df 100644 --- a/docs/content/en/configuration/first-factor/ldap.md +++ b/docs/content/en/configuration/first-factor/ldap.md @@ -17,6 +17,8 @@ aliases: ## Configuration +{{< config-alert-example >}} + ```yaml authentication_backend: ldap: @@ -113,6 +115,8 @@ authentication_backend: ## Options +This section describes the individual configuration options. + ### implementation {{< confkey type="string" default="custom" required="no" >}} diff --git a/docs/content/en/configuration/identity-providers/open-id-connect.md b/docs/content/en/configuration/identity-providers/open-id-connect.md index 83abaa8d7..f3fc3f15e 100644 --- a/docs/content/en/configuration/identity-providers/open-id-connect.md +++ b/docs/content/en/configuration/identity-providers/open-id-connect.md @@ -28,7 +28,7 @@ More information about the beta can be found in the [roadmap](../../roadmap/acti ## Configuration -The following snippet provides a sample-configuration for the OIDC identity provider explaining each field in detail. +{{< config-alert-example >}} ```yaml identity_providers: @@ -147,6 +147,8 @@ identity_providers: ## Options +This section describes the individual configuration options. + ### hmac_secret {{< confkey type="string" required="yes" >}} diff --git a/docs/content/en/configuration/miscellaneous/introduction.md b/docs/content/en/configuration/miscellaneous/introduction.md index b7036e231..907d0e4a5 100644 --- a/docs/content/en/configuration/miscellaneous/introduction.md +++ b/docs/content/en/configuration/miscellaneous/introduction.md @@ -17,6 +17,8 @@ aliases: ## Configuration +{{< config-alert-example >}} + ```yaml certificates_directory: /config/certs/ default_redirection_url: https://home.example.com:8080/ diff --git a/docs/content/en/configuration/miscellaneous/logging.md b/docs/content/en/configuration/miscellaneous/logging.md index 278511f08..31efd03b8 100644 --- a/docs/content/en/configuration/miscellaneous/logging.md +++ b/docs/content/en/configuration/miscellaneous/logging.md @@ -18,6 +18,8 @@ The logging section tunes the logging settings. ## Configuration +{{< config-alert-example >}} + ```yaml log: level: info diff --git a/docs/content/en/configuration/miscellaneous/ntp.md b/docs/content/en/configuration/miscellaneous/ntp.md index b16751d8e..860beaccb 100644 --- a/docs/content/en/configuration/miscellaneous/ntp.md +++ b/docs/content/en/configuration/miscellaneous/ntp.md @@ -23,6 +23,8 @@ unless configured otherwise. ## Configuration +{{< config-alert-example >}} + ```yaml ntp: address: "time.cloudflare.com:123" diff --git a/docs/content/en/configuration/miscellaneous/privacy-policy.md b/docs/content/en/configuration/miscellaneous/privacy-policy.md index 148e9f0ae..a8a3b4ee1 100644 --- a/docs/content/en/configuration/miscellaneous/privacy-policy.md +++ b/docs/content/en/configuration/miscellaneous/privacy-policy.md @@ -14,6 +14,8 @@ toc: true ## Configuration +{{< config-alert-example >}} + ```yaml privacy_policy: enabled: false diff --git a/docs/content/en/configuration/miscellaneous/server-endpoints-authz.md b/docs/content/en/configuration/miscellaneous/server-endpoints-authz.md index c6763a4e2..1381f04c3 100644 --- a/docs/content/en/configuration/miscellaneous/server-endpoints-authz.md +++ b/docs/content/en/configuration/miscellaneous/server-endpoints-authz.md @@ -16,6 +16,8 @@ aliases: ## Configuration +{{< config-alert-example >}} + ```yaml server: endpoints: diff --git a/docs/content/en/configuration/miscellaneous/server.md b/docs/content/en/configuration/miscellaneous/server.md index 2eaa4d1db..b679dc406 100644 --- a/docs/content/en/configuration/miscellaneous/server.md +++ b/docs/content/en/configuration/miscellaneous/server.md @@ -17,6 +17,8 @@ aliases: ## Configuration +{{< config-alert-example >}} + ```yaml server: host: 0.0.0.0 diff --git a/docs/content/en/configuration/notifications/file.md b/docs/content/en/configuration/notifications/file.md index e004fad9c..15f55314c 100644 --- a/docs/content/en/configuration/notifications/file.md +++ b/docs/content/en/configuration/notifications/file.md @@ -21,6 +21,8 @@ This method will use the plain text email template for readability purposes. ## Configuration +{{< config-alert-example >}} + ```yaml notifier: disable_startup_check: false @@ -30,6 +32,8 @@ notifier: ## Options +This section describes the individual configuration options. + ### filename {{< confkey type="string" required="yes" >}} diff --git a/docs/content/en/configuration/notifications/introduction.md b/docs/content/en/configuration/notifications/introduction.md index eb04def3d..d3752f55a 100644 --- a/docs/content/en/configuration/notifications/introduction.md +++ b/docs/content/en/configuration/notifications/introduction.md @@ -16,6 +16,8 @@ Authelia sends messages to users in order to verify their identity. ## Configuration +{{< config-alert-example >}} + ```yaml notifier: disable_startup_check: false @@ -26,6 +28,8 @@ notifier: ## Options +This section describes the individual configuration options. + ### disable_startup_check {{< confkey type="boolean" default="false" required="no" >}} diff --git a/docs/content/en/configuration/notifications/smtp.md b/docs/content/en/configuration/notifications/smtp.md index e22d4f834..876450a90 100644 --- a/docs/content/en/configuration/notifications/smtp.md +++ b/docs/content/en/configuration/notifications/smtp.md @@ -17,6 +17,8 @@ aliases: ## Configuration +{{< config-alert-example >}} + ```yaml notifier: disable_startup_check: false @@ -109,6 +111,8 @@ notifier: ## Options +This section describes the individual configuration options. + ### host {{< confkey type="integer" required="yes" >}} diff --git a/docs/content/en/configuration/prologue/common.md b/docs/content/en/configuration/prologue/common.md index 2c549f75c..48aadb745 100644 --- a/docs/content/en/configuration/prologue/common.md +++ b/docs/content/en/configuration/prologue/common.md @@ -184,7 +184,8 @@ especially for containerized deployments.* The private key to be used with the [certificate_chain](#certificatechain) for mutual TLS authentication. -The value must be one private key encoded in the DER base64 ([RFC4648]) encoded PEM format. +The value must be one private key encoded in the DER base64 ([RFC4648]) encoded PEM format. If more than one certificate +is provided, in top down order, each certificate must be signed by the next certificate if provided. [RFC4648]: https://datatracker.ietf.org/doc/html/rfc4648 diff --git a/docs/content/en/configuration/second-factor/duo.md b/docs/content/en/configuration/second-factor/duo.md index 9eacab0e9..6b3bebbfc 100644 --- a/docs/content/en/configuration/second-factor/duo.md +++ b/docs/content/en/configuration/second-factor/duo.md @@ -25,6 +25,8 @@ section of the configuration. ## Configuration +{{< config-alert-example >}} + ```yaml duo_api: disable: false @@ -36,6 +38,8 @@ duo_api: ## Options +This section describes the individual configuration options. + ### Disable {{< confkey type="boolean" default="false" required="no" >}} diff --git a/docs/content/en/configuration/second-factor/time-based-one-time-password.md b/docs/content/en/configuration/second-factor/time-based-one-time-password.md index b93ca987b..9b2279389 100644 --- a/docs/content/en/configuration/second-factor/time-based-one-time-password.md +++ b/docs/content/en/configuration/second-factor/time-based-one-time-password.md @@ -26,6 +26,8 @@ and many only support SHA1. ## Configuration +{{< config-alert-example >}} + ```yaml totp: disable: false @@ -39,6 +41,8 @@ totp: ## Options +This section describes the individual configuration options. + ### disable {{< confkey type="boolean" default="false" required="no" >}} diff --git a/docs/content/en/configuration/second-factor/webauthn.md b/docs/content/en/configuration/second-factor/webauthn.md index 99c66851c..d560354e7 100644 --- a/docs/content/en/configuration/second-factor/webauthn.md +++ b/docs/content/en/configuration/second-factor/webauthn.md @@ -16,6 +16,8 @@ aliases: ## Configuration +{{< config-alert-example >}} + ```yaml webauthn: disable: false @@ -27,6 +29,8 @@ webauthn: ## Options +This section describes the individual configuration options. + ### disable {{< confkey type="boolean" default="false" required="no" >}} diff --git a/docs/content/en/configuration/security/access-control.md b/docs/content/en/configuration/security/access-control.md index 5dae020d8..5edc77b46 100644 --- a/docs/content/en/configuration/security/access-control.md +++ b/docs/content/en/configuration/security/access-control.md @@ -17,6 +17,8 @@ aliases: ## Configuration +{{< config-alert-example >}} + ```yaml access_control: default_policy: deny @@ -57,6 +59,8 @@ access_control: ## Options +This section describes the individual configuration options. + ### default_policy {{< confkey type="string" default="deny" required="no" >}} diff --git a/docs/content/en/configuration/security/password-policy.md b/docs/content/en/configuration/security/password-policy.md index 5a759f70e..77a985c45 100644 --- a/docs/content/en/configuration/security/password-policy.md +++ b/docs/content/en/configuration/security/password-policy.md @@ -18,6 +18,8 @@ aliases: ## Configuration +{{< config-alert-example >}} + ```yaml password_policy: standard: @@ -35,6 +37,8 @@ password_policy: ## Options +This section describes the individual configuration options. + ### standard This section allows you to enable standard security policies. diff --git a/docs/content/en/configuration/security/regulation.md b/docs/content/en/configuration/security/regulation.md index 705c7e718..b1ea8f1df 100644 --- a/docs/content/en/configuration/security/regulation.md +++ b/docs/content/en/configuration/security/regulation.md @@ -20,6 +20,8 @@ authentication attempts. This helps prevent brute-force attacks. ## Configuration +{{< config-alert-example >}} + ```yaml regulation: max_retries: 3 @@ -29,6 +31,8 @@ regulation: ## Options +This section describes the individual configuration options. + ### max_retries {{< confkey type="integer" default="3" required="no" >}} diff --git a/docs/content/en/configuration/session/introduction.md b/docs/content/en/configuration/session/introduction.md index 4a5ed19ca..304cbf390 100644 --- a/docs/content/en/configuration/session/introduction.md +++ b/docs/content/en/configuration/session/introduction.md @@ -20,6 +20,8 @@ the session cookie behaviour and the domains which Authelia can service authoriz ## Configuration +{{< config-alert-example >}} + ```yaml session: secret: insecure_session_secret @@ -56,6 +58,8 @@ providers are recommended. ## Options +This section describes the individual configuration options. + ### secret {{< confkey type="string" required="yes" >}} diff --git a/docs/content/en/configuration/session/redis.md b/docs/content/en/configuration/session/redis.md index fa6b9dd8a..b36d51d08 100644 --- a/docs/content/en/configuration/session/redis.md +++ b/docs/content/en/configuration/session/redis.md @@ -20,6 +20,8 @@ this option and we highly recommend it in production environments. It requires y ## Configuration +{{< config-alert-example >}} + ```yaml session: redis: @@ -119,6 +121,8 @@ session: ## Options +This section describes the individual configuration options. + ### host {{< confkey type="string" required="yes" >}} diff --git a/docs/content/en/configuration/storage/introduction.md b/docs/content/en/configuration/storage/introduction.md index d2c09e830..97fcf08bf 100644 --- a/docs/content/en/configuration/storage/introduction.md +++ b/docs/content/en/configuration/storage/introduction.md @@ -21,6 +21,8 @@ The available storage backends are listed in the table of contents below. ## Configuration +{{< config-alert-example >}} + ```yaml storage: encryption_key: a_very_important_secret @@ -31,6 +33,8 @@ storage: ## Options +This section describes the individual configuration options. + ### encryption_key {{< confkey type="string" required="yes" >}} diff --git a/docs/content/en/configuration/storage/mysql.md b/docs/content/en/configuration/storage/mysql.md index 227eff96f..c187fbcee 100644 --- a/docs/content/en/configuration/storage/mysql.md +++ b/docs/content/en/configuration/storage/mysql.md @@ -22,6 +22,8 @@ guide for supported version information. ## Configuration +{{< config-alert-example >}} + ```yaml storage: encryption_key: a_very_important_secret @@ -108,6 +110,8 @@ storage: ## Options +This section describes the individual configuration options. + ### encryption_key See the [encryption_key docs](introduction.md#encryption_key). diff --git a/docs/content/en/configuration/storage/postgres.md b/docs/content/en/configuration/storage/postgres.md index 8ea2fae07..8e2c10977 100644 --- a/docs/content/en/configuration/storage/postgres.md +++ b/docs/content/en/configuration/storage/postgres.md @@ -21,6 +21,8 @@ guide for supported version information. ## Configuration +{{< config-alert-example >}} + ```yaml storage: encryption_key: a_very_important_secret @@ -107,6 +109,8 @@ storage: ## Options +This section describes the individual configuration options. + ### encryption_key See the [encryption_key docs](introduction.md#encryption_key). diff --git a/docs/content/en/configuration/storage/sqlite.md b/docs/content/en/configuration/storage/sqlite.md index cdb39a319..631003a7e 100644 --- a/docs/content/en/configuration/storage/sqlite.md +++ b/docs/content/en/configuration/storage/sqlite.md @@ -24,6 +24,8 @@ but this requires you setup an external database such as [PostgreSQL](postgres.m ## Configuration +{{< config-alert-example >}} + ```yaml storage: encryption_key: a_very_important_secret @@ -33,6 +35,8 @@ storage: ## Options +This section describes the individual configuration options. + ### encryption_key See the [encryption_key docs](introduction.md#encryptionkey). diff --git a/docs/content/en/configuration/telemetry/metrics.md b/docs/content/en/configuration/telemetry/metrics.md index 4917637e1..55e6f4dee 100644 --- a/docs/content/en/configuration/telemetry/metrics.md +++ b/docs/content/en/configuration/telemetry/metrics.md @@ -16,6 +16,8 @@ toc: true ## Configuration +{{< config-alert-example >}} + ```yaml telemetry: metrics: @@ -32,6 +34,8 @@ telemetry: ## Options +This section describes the individual configuration options. + ### enabled {{< confkey type="boolean" default="false" required="no" >}} diff --git a/docs/layouts/shortcodes/config-alert-example.html b/docs/layouts/shortcodes/config-alert-example.html new file mode 100644 index 000000000..19f8d1430 --- /dev/null +++ b/docs/layouts/shortcodes/config-alert-example.html @@ -0,0 +1,7 @@ + \ No newline at end of file