diff --git a/roles/custom/matrix-authentication-service/defaults/main.yml b/roles/custom/matrix-authentication-service/defaults/main.yml index 61dc8f58c..2936d313f 100644 --- a/roles/custom/matrix-authentication-service/defaults/main.yml +++ b/roles/custom/matrix-authentication-service/defaults/main.yml @@ -161,13 +161,13 @@ matrix_authentication_service_config_email_reply_to_address: "{{ matrix_authenti # Controls the `email.transport` configuration setting. # -# Valid options are: blackhole, smtp, aws_ses +# Valid values: blackhole, smtp, aws_ses # Upstream reports that `sendmail` is supported as well, # but this is not true when running it in a container image due to the `sendmail` binary not being included. matrix_authentication_service_config_email_transport: blackhole # Controls the `email.mode` configuration setting for SMTP. -# Options are 'plain', 'tls', or 'starttls'. +# Valid values: plain, tls, starttls matrix_authentication_service_config_email_mode: plain # Controls the `email.hostname` configuration setting for SMTP. @@ -220,7 +220,7 @@ matrix_authentication_service_config_account_password_change_allowed: true # Controls the `account.password_recovery_enabled` configuration setting. # -# Whether email-based password recovery is enabled +# Whether email-based password recovery is enabled. # This has no effect if password login is disabled. matrix_authentication_service_config_account_password_recovery_enabled: false @@ -340,7 +340,7 @@ matrix_authentication_service_config_http_trusted_proxies: matrix_authentication_service_config_matrix_homeserver: "" # Controls the `matrix.endpoint` configuration setting. -# URL to which the homeserver is accessible from the service +# URL to which the homeserver is accessible from the service. matrix_authentication_service_config_matrix_endpoint: "" # Controls the `matrix.secret` configuration setting. @@ -361,20 +361,20 @@ matrix_authentication_service_config_matrix_secret: "" # Controls the `passwords.enabled` configuration setting. # Whether to enable the password database. -# If disabled, users will only be able to log in using upstream OIDC providers +# If disabled, users will only be able to log in using upstream OIDC providers. matrix_authentication_service_config_passwords_enabled: true # Controls the `passwords.schemes` configuration setting. # List of password hashing schemes being used. -# Only change this if you know what you're doing +# Only change this if you know what you're doing. matrix_authentication_service_config_passwords_schemes: - version: 1 algorithm: argon2id # Controls the `passwords.minimum_complexity` configuration setting. -# Minimum complexity required for passwords, estimated by the zxcvbn algorithm -# Must be between 0 and 4, default is 3 -# See https://github.com/dropbox/zxcvbn#usage for more information +# Minimum complexity required for passwords, estimated by the zxcvbn algorithm. +# Must be between 0 and 4. Default is 3. +# See https://github.com/dropbox/zxcvbn#usage for more information. matrix_authentication_service_config_passwords_minimum_complexity: 3 ######################################################################################## @@ -502,7 +502,7 @@ matrix_authentication_service_container_labels_public_main_tls_certResolver: "{{ # - https://element-hq.github.io/matrix-authentication-service/setup/reverse-proxy.html#compatibility-layer # # Regardless of whether this is enabled, it may or may not take effect due to the value of other variables. -# See `matrix_authentication_service_container_labels_traefik_enabled` +# See `matrix_authentication_service_container_labels_traefik_enabled`. matrix_authentication_service_container_labels_public_compatibility_layer_enabled: false matrix_authentication_service_container_labels_public_compatibility_layer_hostname: "" matrix_authentication_service_container_labels_public_compatibility_layer_path_regexp: "^/_matrix/client/(?P([^/]+))/(?P(login|logout|refresh))"