docs: add alert for configuration sections (#5380)

Signed-off-by: James Elliott <james-d-elliott@users.noreply.github.com>

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" >}}

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" >}}

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" >}}

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" >}}

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/

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

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"

docs/content/en/configuration/miscellaneous/privacy-policy.md

@@ -14,6 +14,8 @@ toc: true
 
 ## Configuration
 
+{{< config-alert-example >}}
+
 ```yaml
 privacy_policy:
   enabled: false

docs/content/en/configuration/miscellaneous/server-endpoints-authz.md

@@ -16,6 +16,8 @@ aliases:
 
 ## Configuration
 
+{{< config-alert-example >}}
+
 ```yaml
 server:
   endpoints:

docs/content/en/configuration/miscellaneous/server.md

@@ -17,6 +17,8 @@ aliases:
 
 ## Configuration
 
+{{< config-alert-example >}}
+
 ```yaml
 server:
   host: 0.0.0.0

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" >}}

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" >}}

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" >}}

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
 

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" >}}

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" >}}

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" >}}

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" >}}

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.

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" >}}

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" >}}

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" >}}

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" >}}

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).

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).

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).

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" >}}

docs/layouts/shortcodes/config-alert-example.html

@@ -0,0 +1,7 @@
+<div class="alert alert-warning d-flex" role="alert">
+  <div class="flex-shrink-1 alert-icon">⚠️</div>
+  <div class="w-100">
+    This section is intended as an example configuration to help users with a rough contextual layout of this configuration section, it is <b>not</b> intended to explain the <a class="alert-link" href="#options">options</a>.
+    The configuration shown may not be a valid configuration, and you should see the <a class="alert-link" href="#options">options section</a> below and the navigation links to properly understand each option individually.
+  </div>
+</div>