Merge pull request #3628 from luixxiul/fix

Adopt special-use domain names for documentation purpose

roles/custom/matrix-alertmanager-receiver/defaults/main.yml

@@ -41,7 +41,7 @@ matrix_alertmanager_receiver_container_additional_networks_default: []
 matrix_alertmanager_receiver_container_additional_networks_auto: []
 matrix_alertmanager_receiver_container_additional_networks_custom: []
 
-# Controls whether matrix-alertmanager-receiver metrics should be proxied (exposed) on `matrix.DOMAIN/metrics/matrix-alertmanager-receiver`
+# Controls whether matrix-alertmanager-receiver metrics should be proxied (exposed) on `matrix.example.com/metrics/matrix-alertmanager-receiver`
 matrix_alertmanager_receiver_metrics_proxying_enabled: false
 matrix_alertmanager_receiver_metrics_proxying_hostname: ''
 matrix_alertmanager_receiver_metrics_proxying_path: /metrics/matrix-alertmanager-receiver

roles/custom/matrix-base/defaults/main.yml

@@ -1,10 +1,10 @@
 ---
 
 # The bare domain name which represents your Matrix identity.
-# Matrix user ids for your server will be of the form (`@user:<matrix-domain>`).
+# Matrix user ids for your server will be of the form (`@user:example.com`).
 #
 # Note: this playbook does not touch the server referenced here.
-# Installation happens on another server ("matrix.<matrix-domain>", see `matrix_server_fqn_matrix`).
+# Installation happens on another server ("matrix.example.com", see `matrix_server_fqn_matrix`).
 #
 # Example value: example.com
 matrix_domain: ~
@@ -289,7 +289,7 @@ matrix_playbook_public_matrix_federation_api_traefik_entrypoint_definition:
 # may wish to register their routes with this additional entrypoint and provide their services on it for internal (no-public-network and non-TLS) use.
 #
 # This entrypoint provides local addons (e.g. bridges, bots, etc.) with the ability to easily & quickly communicate with the homeserver and/or related software.
-# Such services can reach the homeserver over the public internet (e.g. https://matrix.DOMAIN), but this is slow due to networking and SSL-termination.
+# Such services can reach the homeserver over the public internet (e.g. https://matrix.example.com), but this is slow due to networking and SSL-termination.
 # Talking directly to the homeserver (e.g. `http://matrix-synapse:8008`) is another option, but does not allow other homeserver-related software
 # (e.g. identity servers like ma1sd, media repository servers like matrix-media-repo, firewalls like matrix-corporal)
 # to register itself for certain homeserver routes.

roles/custom/matrix-base/tasks/validate_config.yml

@@ -30,7 +30,7 @@
 
       If you're observing this error on a new installation, you should ensure that the `matrix_homeserver_generic_secret_key` is defined.
       If you think you've defined it, but are still getting this error, then it's likely that you have a typo
-      in your domain name in `inventory/hosts` or in one of the directories leading up to your `inventory/host_vars/matrix.DOMAIN/vars.yml` file.
+      in your domain name in `inventory/hosts` or in one of the directories leading up to your `inventory/host_vars/matrix.example.com/vars.yml` file.
 
       If you're observing this error on an existing homeserver installation, you can fix it easily and in a backward-compatible way by adding
       `{% raw %}matrix_homeserver_generic_secret_key: "{{ matrix_synapse_macaroon_secret_key }}"{% endraw %}`

roles/custom/matrix-bot-baibot/defaults/main.yml

@@ -93,7 +93,7 @@ matrix_bot_baibot_config_command_prefix: "!bai"
 # Example:
 # matrix_bot_baibot_config_access_admin_patterns:
 #   - "@*:example.com"
-#   - "@admin:another.com"
+#   - "@admin:example.net"
 matrix_bot_baibot_config_access_admin_patterns: "{{ [matrix_admin] if matrix_admin else [] }}"
 
 # Controls the `persistence.data_dir_path` configuration setting.

roles/custom/matrix-bot-chatgpt/defaults/main.yml

@@ -57,7 +57,7 @@ matrix_bot_chatgpt_keyv_bot_storage: true
 # Matrix Static Settings (required, see notes)
 # Defaults to "https://matrix.org"
 matrix_bot_chatgpt_matrix_homeserver_url: ""  # MATRIX_HOMESERVER_URL=
-# With the @ and :DOMAIN, ie @SOMETHING:DOMAIN, needs to be set, created manually beforehand.
+# With the @ and :example.com, ie @SOMETHING:example.com, needs to be set, created manually beforehand.
 matrix_bot_chatgpt_matrix_bot_username_localpart: 'bot.chatgpt'
 matrix_bot_chatgpt_matrix_bot_username: "@{{ matrix_bot_chatgpt_matrix_bot_username_localpart }}:{{ matrix_domain }}"  # MATRIX_BOT_USERNAME=
 # Set `MATRIX_BOT_PASSWORD` the bot will print an `MATRIX_ACCESS_TOKEN` to the terminal
@@ -73,7 +73,7 @@ matrix_bot_chatgpt_matrix_default_prefix_reply: false  # MATRIX_DEFAULT_PREFIX_R
 # Matrix Access Control (optional)
 #
 # Lists of space-separated entries. Example:
-# matrix_bot_chatgpt_matrix_whitelist: ":{{ matrix_domain }} :second-domain.com :third-domain.com"
+# matrix_bot_chatgpt_matrix_whitelist: ":{{ matrix_domain }} :example.net :example.org"
 matrix_bot_chatgpt_matrix_blacklist: ''
 matrix_bot_chatgpt_matrix_whitelist: ':{{ matrix_domain }}'
 
@@ -90,7 +90,7 @@ matrix_bot_chatgpt_matrix_rich_text: true  # MATRIX_RICH_TEXT=true
 # - @someone:example.com
 # - @another:example.com
 # - @bot.*:example.com
-# - @*:another.com
+# - @*:example.net
 # matrix_bot_chatgpt_admins: "{{ [matrix_admin] if matrix_admin else [] }}"
 
 # Additional environment variables to pass to the chatgpt container

roles/custom/matrix-bot-chatgpt/templates/env.j2

@@ -10,7 +10,7 @@ KEYV_URL={{ matrix_bot_chatgpt_keyv_url }}
 KEYV_BOT_ENCRYPTION={{ matrix_bot_chatgpt_keyv_bot_encryption|lower }}
 KEYV_BOT_STORAGE={{ matrix_bot_chatgpt_keyv_bot_storage|lower }}
 
-# With the @ and :DOMAIN, ie @SOMETHING:DOMAIN
+# With the @ and :example.com, ie @SOMETHING:example.com
 MATRIX_BOT_USERNAME={{ matrix_bot_chatgpt_matrix_bot_username }}
 MATRIX_BOT_PASSWORD={{ matrix_bot_chatgpt_matrix_bot_password }}
 

roles/custom/matrix-bot-go-neb/defaults/main.yml

@@ -321,7 +321,7 @@ matrix_bot_go_neb_services: []
 #      webhook_url: "http://localhost/services/hooks/YWxlcnRtYW5hZ2VyX3NlcnZpY2U"
 #      # Each room will get the notification with the alert rendered with the given template
 #      rooms:
-#        "!someroomid:domain.tld":
+#        "!someroomid:example.com":
 #          text_template: "{% raw %}{{range .Alerts -}} [{{ .Status }}] {{index .Labels \"alertname\"}}: {{index .Annotations \"description\"}} {{ end -}}{% endraw %}"
 #          html_template: "{% raw %}{{range .Alerts -}}  {{ $severity := index .Labels \"severity\"}}    {{ if eq .Status \"firing\"}}      {{ if eq $severity \"critical\"}}        <font color='red'><b>[FIRING - CRITICAL]</b></font>      {{ else if eq $severity \"warning\"}}        <font color='orange'><b>[FIRING - WARNING]</b></font>      {{ else }}        <b>[FIRING - {{ $severity }}]</b>      {{ end }}    {{ else }}      <font color='green'><b>[RESOLVED]</b></font>    {{ end }}  {{ index .Labels \"alertname\"}} : {{ index .Annotations \"description\"}}   <a href=\"{{ .GeneratorURL }}\">source</a><br/>{{end -}}{% endraw %}"
 #          msg_type: "m.text"  # Must be either `m.text` or `m.notice`

roles/custom/matrix-bot-honoroit/defaults/main.yml

@@ -168,7 +168,7 @@ matrix_bot_honoroit_redmine_done_status_id: ''  # done status ID (e.g. 3)
 # - @someone:example.com
 # - @another:example.com
 # - @bot.*:example.com
-# - @*:another.com
+# - @*:example.net
 matrix_bot_honoroit_allowedusers:
   - "@*:*"
 

roles/custom/matrix-bot-matrix-reminder-bot/templates/config.yaml.j2

@@ -39,9 +39,9 @@ allowlist:
   enabled: {{ matrix_bot_matrix_reminder_bot_allowlist_enabled | to_json }}
   # A list of MXID regexes to be allowed
   # To allow a certain homeserver:
-  #     regexes: ["@[a-z0-9-_.]+:myhomeserver.tld"]
+  #     regexes: ["@[a-z0-9-_.]+:example.com"]
   # To allow a set of users:
-  #     regexes: ["@alice:someserver.tld", "@bob:anotherserver.tld"]
+  #     regexes: ["@alice:example.net", "@bob:example.org"]
   # To allow nobody (same as blocking every MXID):
   #     regexes: []
   regexes: {{ matrix_bot_matrix_reminder_bot_allowlist_regexes | to_json }}
@@ -53,9 +53,9 @@ blocklist:
   enabled: {{ matrix_bot_matrix_reminder_bot_blocklist_enabled | to_json }}
   # A list of MXID regexes to be blocked
   # To block a certain homeserver:
-  #     regexes: [".*:myhomeserver.tld"]
+  #     regexes: [".*:example.com"]
   # To block a set of users:
-  #     regexes: ["@alice:someserver.tld", "@bob:anotherserver.tld"]
+  #     regexes: ["@alice:example.net", "@bob:example.org"]
   # To block absolutely everyone (same as allowing nobody):
   #     regexes: [".*"]
   regexes: {{ matrix_bot_matrix_reminder_bot_blocklist_regexes | to_json }}

roles/custom/matrix-bot-postmoogle/defaults/main.yml

@@ -103,7 +103,7 @@ matrix_bot_postmoogle_relay_password: ''
 # - '@someone:example.com'
 # - '@another:example.com'
 # - '@bot.*:example.com'
-# - '@*:another.com'
+# - '@*:example.net'
 matrix_bot_postmoogle_admins: "{{ [matrix_admin] if matrix_admin else [] }}"
 
 # Sentry DSN. Deprecated, use matrix_bot_postmoogle_monitoring_sentry_dsn

roles/custom/matrix-bridge-appservice-irc/templates/config.yaml.j2

@@ -41,7 +41,7 @@ ircService:
   #
   # The path to the RSA PEM-formatted private key to use when encrypting IRC passwords
   # for storage in the database. Passwords are stored by using the admin room command
-  # `!storepass server.name passw0rd. When a connection is made to IRC on behalf of
+  # `!storepass example.com passw0rd. When a connection is made to IRC on behalf of
   # the Matrix user, this password will be sent as the server password (PASS command).
   passwordEncryptionKeyPath: "/data/passkey.pem" # does not typically need modification
 

roles/custom/matrix-bridge-hookshot/tasks/validate_config.yml

@@ -102,7 +102,7 @@
   ansible.builtin.fail:
     msg: >-
       Your configuration contains a variable (`{{ item }}`), which refers to the old metrics collection system for Hookshot,
-      which exposed metrics on `https://stats.DOMAIN/hookshot/metrics`.
+      which exposed metrics on `https://stats.example.com/hookshot/metrics`.
 
       We now recommend exposing Hookshot metrics in another way, from another URL.
       Refer to the changelog for more details: https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/master/CHANGELOG.md#2022-06-22

roles/custom/matrix-bridge-mautrix-meta-instagram/defaults/main.yml

@@ -114,10 +114,10 @@ matrix_mautrix_meta_instagram_appservice_address: "http://{{ matrix_mautrix_meta
 
 matrix_mautrix_meta_instagram_appservice_id: "{{ matrix_mautrix_meta_instagram_meta_mode }}"
 
-# For Facebook/Messenger, we use the same `@messengerbot:DOMAIN` username regardless of how bridging happens for multiple reasons:
+# For Facebook/Messenger, we use the same `@messengerbot:example.com` username regardless of how bridging happens for multiple reasons:
 # - it's consistent - regardless of how bridging happens, the bridged service is actually Messenger
-# - it's easy for users - you may change the mode, but the bot is always at `@messengerbot:DOMAIN`
-# - it doesn't conflict with mautrix-facebook which uses `@facebookbot:DOMAIN`
+# - it's easy for users - you may change the mode, but the bot is always at `@messengerbot:example.com`
+# - it doesn't conflict with mautrix-facebook which uses `@facebookbot:example.com`
 # - `matrix_mautrix_meta_instagram_appservice_avatar` only has icons for Messenger and Instagram, not Facebook
 matrix_mautrix_meta_instagram_appservice_username_prefix: |-
   {{

roles/custom/matrix-bridge-mautrix-meta-messenger/defaults/main.yml

@@ -114,10 +114,10 @@ matrix_mautrix_meta_messenger_appservice_address: "http://{{ matrix_mautrix_meta
 
 matrix_mautrix_meta_messenger_appservice_id: "{{ matrix_mautrix_meta_messenger_meta_mode }}"
 
-# For Facebook/Messenger, we use the same `@messengerbot:DOMAIN` username regardless of how bridging happens for multiple reasons:
+# For Facebook/Messenger, we use the same `@messengerbot:example.com` username regardless of how bridging happens for multiple reasons:
 # - it's consistent - regardless of how bridging happens, the bridged service is actually Messenger
-# - it's easy for users - you may change the mode, but the bot is always at `@messengerbot:DOMAIN`
-# - it doesn't conflict with mautrix-facebook which uses `@facebookbot:DOMAIN`
+# - it's easy for users - you may change the mode, but the bot is always at `@messengerbot:example.com`
+# - it doesn't conflict with mautrix-facebook which uses `@facebookbot:example.com`
 # - `matrix_mautrix_meta_messenger_appservice_avatar` only has icons for Messenger and Instagram, not Facebook
 matrix_mautrix_meta_messenger_appservice_username_prefix: |-
   {{

roles/custom/matrix-bridge-mx-puppet-discord/defaults/main.yml

@@ -33,15 +33,15 @@ matrix_mx_puppet_discord_appservice_address: 'http://matrix-mx-puppet-discord:{{
 
 matrix_mx_puppet_discord_bridge_mediaUrl: "{{ matrix_homeserver_url }}"  # noqa var-naming
 
-# "@user:server.com" to allow specific user
-# "@.*:yourserver.com" to allow users on a specific homeserver
+# "@user:example.com" to allow specific user
+# "@.*:example.com" to allow users on a specific homeserver
 # "@.*" to allow anyone
 matrix_mx_puppet_discord_provisioning_whitelist:
   - "@.*:{{ matrix_domain | regex_escape }}"
 
 # Leave empty to disable blacklist
-# "@user:server.com" disallow a specific user
-# "@.*:yourserver.com" disallow users on a specific homeserver
+# "@user:example.com" disallow a specific user
+# "@.*:example.com" disallow users on a specific homeserver
 matrix_mx_puppet_discord_provisioning_blacklist: []
 
 matrix_mx_puppet_discord_container_network: ""

roles/custom/matrix-bridge-mx-puppet-groupme/defaults/main.yml

@@ -29,15 +29,15 @@ matrix_mx_puppet_groupme_homeserver_address: ""
 matrix_mx_puppet_groupme_homeserver_domain: '{{ matrix_domain }}'
 matrix_mx_puppet_groupme_appservice_address: 'http://matrix-mx-puppet-groupme:{{ matrix_mx_puppet_groupme_appservice_port }}'
 
-# "@user:server.com" to allow specific user
-# "@.*:yourserver.com" to allow users on a specific homeserver
+# "@user:example.com" to allow specific user
+# "@.*:example.com" to allow users on a specific homeserver
 # "@.*" to allow anyone
 matrix_mx_puppet_groupme_provisioning_whitelist:
   - "@.*:{{ matrix_domain | regex_escape }}"
 
 # Leave empty to disable blacklist
-# "@user:server.com" disallow a specific user
-# "@.*:yourserver.com" disallow users on a specific homeserver
+# "@user:example.com" disallow a specific user
+# "@.*:example.com" disallow users on a specific homeserver
 matrix_mx_puppet_groupme_provisioning_blacklist: []
 
 matrix_mx_puppet_groupme_container_network: ""

roles/custom/matrix-bridge-mx-puppet-instagram/defaults/main.yml

@@ -24,15 +24,15 @@ matrix_mx_puppet_instagram_homeserver_address: ""
 matrix_mx_puppet_instagram_homeserver_domain: '{{ matrix_domain }}'
 matrix_mx_puppet_instagram_appservice_address: 'http://matrix-mx-puppet-instagram:{{ matrix_mx_puppet_instagram_appservice_port }}'
 
-# "@user:server.com" to allow specific user
-# "@.*:yourserver.com" to allow users on a specific homeserver
+# "@user:example.com" to allow specific user
+# "@.*:example.com" to allow users on a specific homeserver
 # "@.*" to allow anyone
 matrix_mx_puppet_instagram_provisioning_whitelist:
   - "@.*:{{ matrix_domain | regex_escape }}"
 
 # Leave empty to disable blacklist
-# "@user:server.com" disallow a specific user
-# "@.*:yourserver.com" disallow users on a specific homeserver
+# "@user:example.com" disallow a specific user
+# "@.*:example.com" disallow users on a specific homeserver
 matrix_mx_puppet_instagram_provisioning_blacklist: []
 
 matrix_mx_puppet_instagram_container_network: ""

roles/custom/matrix-bridge-mx-puppet-slack/defaults/main.yml

@@ -42,15 +42,15 @@ matrix_mx_puppet_slack_oauth_enabled: true
 matrix_mx_puppet_slack_oauth_redirect_path: "{{ matrix_mx_puppet_slack_path_prefix }}"
 matrix_mx_puppet_slack_oauth_redirect_uri: '{{ matrix_mx_puppet_slack_scheme }}://{{ matrix_mx_puppet_slack_hostname }}{{ matrix_mx_puppet_slack_oauth_redirect_path }}'
 
-# "@user:server.com" to allow specific user
-# "@.*:yourserver.com" to allow users on a specific homeserver
+# "@user:example.com" to allow specific user
+# "@.*:example.com" to allow users on a specific homeserver
 # "@.*" to allow anyone
 matrix_mx_puppet_slack_provisioning_whitelist:
   - "@.*:{{ matrix_domain | regex_escape }}"
 
 # Leave empty to disable blacklist
-# "@user:server.com" disallow a specific user
-# "@.*:yourserver.com" disallow users on a specific homeserver
+# "@user:example.com" disallow a specific user
+# "@.*:example.com" disallow users on a specific homeserver
 matrix_mx_puppet_slack_provisioning_blacklist: []
 
 matrix_mx_puppet_slack_container_network: ""

roles/custom/matrix-bridge-mx-puppet-steam/defaults/main.yml

@@ -30,15 +30,15 @@ matrix_mx_puppet_steam_homeserver_address: ""
 matrix_mx_puppet_steam_homeserver_domain: '{{ matrix_domain }}'
 matrix_mx_puppet_steam_appservice_address: 'http://matrix-mx-puppet-steam:{{ matrix_mx_puppet_steam_appservice_port }}'
 
-# "@user:server.com" to allow specific user
-# "@.*:yourserver.com" to allow users on a specific homeserver
+# "@user:example.com" to allow specific user
+# "@.*:example.com" to allow users on a specific homeserver
 # "@.*" to allow anyone
 matrix_mx_puppet_steam_provisioning_whitelist:
   - "@.*:{{ matrix_domain | regex_escape }}"
 
 # Leave empty to disable blacklist
-# "@user:server.com" disallow a specific user
-# "@.*:yourserver.com" disallow users on a specific homeserver
+# "@user:example.com" disallow a specific user
+# "@.*:example.com" disallow users on a specific homeserver
 matrix_mx_puppet_steam_provisioning_blacklist: []
 
 matrix_mx_puppet_steam_container_network: ""

roles/custom/matrix-bridge-mx-puppet-twitter/defaults/main.yml

@@ -42,15 +42,15 @@ matrix_mx_puppet_twitter_environment: ''
 matrix_mx_puppet_twitter_server_path: "{{ matrix_mx_puppet_twitter_path_prefix }}"
 matrix_mx_puppet_twitter_server_url: '{{ matrix_homeserver_url }}{{ matrix_mx_puppet_twitter_server_path }}'
 
-# "@user:server.com" to allow specific user
-# "@.*:yourserver.com" to allow users on a specific homeserver
+# "@user:example.com" to allow specific user
+# "@.*:example.com" to allow users on a specific homeserver
 # "@.*" to allow anyone
 matrix_mx_puppet_twitter_provisioning_whitelist:
   - "@.*:{{ matrix_domain | regex_escape }}"
 
 # Leave empty to disable blacklist
-# "@user:server.com" disallow a specific user
-# "@.*:yourserver.com" disallow users on a specific homeserver
+# "@user:example.com" disallow a specific user
+# "@.*:example.com" disallow users on a specific homeserver
 matrix_mx_puppet_twitter_provisioning_blacklist: []
 
 matrix_mx_puppet_twitter_container_network: ""

roles/custom/matrix-conduit/defaults/main.yml

@@ -112,9 +112,9 @@ matrix_conduit_container_extra_arguments: []
 
 # Specifies which template files to use when configuring Conduit.
 # If you'd like to have your own different configuration, feel free to copy and paste
-# the original files into your inventory (e.g. in `inventory/host_vars/<host>/`)
+# the original files into your inventory (e.g. in `inventory/host_vars/matrix.example.com/`)
 # and then change the specific host's `vars.yaml` file like this:
-# matrix_conduit_template_conduit_config: "{{ playbook_dir }}/inventory/host_vars/<host>/conduit.toml.j2"
+# matrix_conduit_template_conduit_config: "{{ playbook_dir }}/inventory/host_vars/matrix.example.com/conduit.toml.j2"
 matrix_conduit_template_conduit_config: "{{ role_path }}/templates/conduit.toml.j2"
 
 # Max size for uploads, in bytes

roles/custom/matrix-conduit/templates/conduit.toml.j2

@@ -10,7 +10,7 @@
 # and room IDs. Examples: matrix.org, conduit.rs
 
 # The Conduit server needs all /_matrix/ requests to be reachable at
-# https://your.server.name/ on port 443 (client-server) and 8448 (federation).
+# https://example.com/ on port 443 (client-server) and 8448 (federation).
 
 # If that's not possible for you, you can create /.well-known files to redirect
 # requests. See

roles/custom/matrix-dendrite/defaults/main.yml

@@ -199,9 +199,9 @@ matrix_dendrite_systemd_service_post_start_delay_seconds: 3
 
 # Specifies which template files to use when configuring Dendrite.
 # If you'd like to have your own different configuration, feel free to copy and paste
-# the original files into your inventory (e.g. in `inventory/host_vars/<host>/`)
+# the original files into your inventory (e.g. in `inventory/host_vars/matrix.example.com/`)
 # and then change the specific host's `vars.yml` file like this:
-# matrix_dendrite_template_dendrite_config: "{{ playbook_dir }}/inventory/host_vars/<host>/dendrite.yaml.j2"
+# matrix_dendrite_template_dendrite_config: "{{ playbook_dir }}/inventory/host_vars/matrix.example.com/dendrite.yaml.j2"
 matrix_dendrite_template_dendrite_config: "{{ role_path }}/templates/dendrite.yaml.j2"
 
 matrix_dendrite_client_api_registration_shared_secret: ""
@@ -321,7 +321,7 @@ matrix_dendrite_configuration_extension_yaml: |
   # server_notices:
   #   system_mxid_localpart: notices
   #   system_mxid_display_name: "Server Notices"
-  #   system_mxid_avatar_url: "mxc://server.com/oumMVlgDnLYFaPVkExemNVVZ"
+  #   system_mxid_avatar_url: "mxc://example.com/oumMVlgDnLYFaPVkExemNVVZ"
   #   room_name: "Server Notices"
 
 matrix_dendrite_configuration_extension: "{{ matrix_dendrite_configuration_extension_yaml | from_yaml if matrix_dendrite_configuration_extension_yaml | from_yaml is mapping else {} }}"

roles/custom/matrix-dendrite/templates/dendrite.yaml.j2

@@ -213,7 +213,7 @@ client_api:
     threshold: {{ matrix_dendrite_client_api_rate_limiting_threshold | to_json }}
     cooloff_ms: {{ matrix_dendrite_client_api_rate_limiting_cooloff_ms | to_json }}
     exempt_user_ids:
-    #  - "@user:domain.com"
+    #  - "@user:{{ matrix_domain }}"
 
 # Configuration for the Federation API.
 federation_api:

roles/custom/matrix-dimension/defaults/main.yml

@@ -16,7 +16,7 @@ matrix_dimension_path_prefix: /
 # For information on how to acquire an access token, visit https://t2bot.io/docs/access_tokens
 matrix_dimension_access_token: ""
 
-# Users in form: ['@user1:domain.com', '@user2:domain.com']
+# Users in form: ['@user1:example.com', '@user2:example.com']
 matrix_dimension_admins: []
 
 # Whether to allow Dimension widgets serve websites with invalid or self signed SSL certificates

roles/custom/matrix-media-repo/defaults/main.yml

@@ -44,7 +44,7 @@ matrix_media_repo_container_network: "{{ matrix_media_repo_identifier }}"
 # Use this to expose this container to another reverse proxy, which runs in a different container network.
 matrix_media_repo_container_additional_networks: []
 
-# Controls whether media repo metrics should be proxied (exposed) on `matrix.DOMAIN/metrics/matrix-media-repo`
+# Controls whether media repo metrics should be proxied (exposed) on `matrix.example.com/metrics/matrix-media-repo`
 matrix_media_repo_metrics_proxying_enabled: false
 matrix_media_repo_metrics_proxying_hostname: ""
 matrix_media_repo_metrics_proxying_path: "/metrics/matrix-media-repo"
@@ -366,9 +366,9 @@ matrix_media_repo_access_tokens_use_local_appservice_config: false
 #   {
 #     id: "Name_of_appservice_for_your_reference",
 #     asToken: "Secret_token_for_appservices_to_use",
-#     senderUserId: "@_example_bridge:yourdomain.com",
+#     senderUserId: "@_example_bridge:example.com",
 #     userNamespaces: [
-#       regex: "@_example_bridge_.+:yourdomain.com"
+#       regex: "@_example_bridge_.+:example.com"
 #       # A note about regexes: it is best to suffix *all* namespaces with the homeserver
 #       # domain users are valid for, as otherwise the appservice can use any user with
 #       # any domain name it feels like, even if that domain is not configured with the

roles/custom/matrix-media-repo/templates/media-repo/media-repo.yaml.j2

@@ -153,9 +153,9 @@ accessTokens:
 # appservices:
 #   - id: Name_of_appservice_for_your_reference
 #     asToken: Secret_token_for_appservices_to_use
-#     senderUserId: "@_example_bridge:yourdomain.com"
+#     senderUserId: "@_example_bridge:example.com"
 #     userNamespaces:
-#       - regex: "@_example_bridge_.+:yourdomain.com"
+#       - regex: "@_example_bridge_.+:example.com"
 #         # A note about regexes: it is best to suffix *all* namespaces with the homeserver
 #         # domain users are valid for, as otherwise the appservice can use any user with
 #         # any domain name it feels like, even if that domain is not configured with the

roles/custom/matrix-registration/defaults/main.yml

@@ -114,7 +114,7 @@ matrix_registration_api_token_endpoint: "{{ matrix_registration_scheme }}://{{ m
 
 matrix_registration_api_validate_certs: true
 
-# The URL to your homeserver (e.g.: `https://matrix.DOMAIN`).
+# The URL to your homeserver (e.g.: `https://matrix.example.com`).
 # A local (in-container address) is preferable.
 matrix_registration_server_location: ""
 

roles/custom/matrix-sliding-sync/defaults/main.yml

@@ -43,7 +43,7 @@ matrix_sliding_sync_container_additional_networks: []
 matrix_sliding_sync_metrics_enabled: false
 matrix_sliding_sync_metrics_port: 2112
 
-# Controls whether Sliding Sync metrics should be proxied (exposed) on `matrix.DOMAIN/metrics/sliding-sync`
+# Controls whether Sliding Sync metrics should be proxied (exposed) on `matrix.example.com/metrics/sliding-sync`
 matrix_sliding_sync_metrics_proxying_enabled: false
 matrix_sliding_sync_metrics_proxying_hostname: ''
 matrix_sliding_sync_metrics_proxying_path: /metrics/sliding-sync

roles/custom/matrix-static-files/defaults/main.yml

@@ -386,6 +386,6 @@ matrix_static_files_self_check_well_known_matrix_client_follow_redirects: none
 # TODO - review this one
 # Specifies where requests for the root URI (`/`) on the `matrix.` domain should be redirected.
 # If this has an empty value, they're just passed to the homeserver, which serves a static page.
-# If you'd like to make `https://matrix.DOMAIN` redirect to `https://element.DOMAIN` (or something of that sort), specify the domain name here.
-# Example value: `element.DOMAIN` (or `{{ matrix_server_fqn_element }}`).
+# If you'd like to make `https://matrix.example.com` redirect to `https://element.example.com` (or something of that sort), specify the domain name here.
+# Example value: `element.example.com` (or `{{ matrix_server_fqn_element }}`).
 matrix_static_files_client_redirect_root_uri_to_domain: ""

roles/custom/matrix-synapse-usage-exporter/defaults/main.yml

@@ -51,7 +51,7 @@ matrix_synapse_usage_exporter_container_extra_arguments: []
 
 # Controls whether the synapse-usage-exporter's web services should be proxied (exposed publicly).
 #
-# Exposure happens on `matrix.DOMAIN/report-usage-stats/push` by default.
+# Exposure happens on `matrix.example.com/report-usage-stats/push` by default.
 # See: `matrix_synapse_usage_exporter_hostname` and `matrix_synapse_usage_exporter_path_prefix`.
 matrix_synapse_usage_exporter_proxying_enabled: false
 

roles/custom/matrix-synapse/defaults/main.yml

@@ -339,9 +339,9 @@ matrix_synapse_in_container_python_packages_path: "/usr/local/lib/python3.11/sit
 
 # Specifies which template files to use when configuring Synapse.
 # If you'd like to have your own different configuration, feel free to copy and paste
-# the original files into your inventory (e.g. in `inventory/host_vars/<host>/`)
+# the original files into your inventory (e.g. in `inventory/host_vars/matrix.example.com/`)
 # and then change the specific host's `vars.yml` file like this:
-# matrix_synapse_template_synapse_homeserver: "{{ playbook_dir }}/inventory/host_vars/<host>/homeserver.yaml.j2"
+# matrix_synapse_template_synapse_homeserver: "{{ playbook_dir }}/inventory/host_vars/matrix.example.com/homeserver.yaml.j2"
 matrix_synapse_template_synapse_homeserver: "{{ role_path }}/templates/synapse/homeserver.yaml.j2"
 matrix_synapse_template_synapse_log: "{{ role_path }}/templates/synapse/synapse.log.config.j2"
 
@@ -733,8 +733,8 @@ matrix_synapse_grafana_dashboard_urls:
   - https://raw.githubusercontent.com/element-hq/synapse/master/contrib/grafana/synapse.json
 
 # Controls whether Synapse metrics should be proxied (exposed) on:
-# - `matrix.DOMAIN/metrics/synapse/main-process` for the main process
-# - `matrix.DOMAIN/metrics/synapse/worker/{type}-{id}` for each worker process
+# - `matrix.example.com/metrics/synapse/main-process` for the main process
+# - `matrix.example.com/metrics/synapse/worker/{type}-{id}` for each worker process
 matrix_synapse_metrics_proxying_enabled: false
 matrix_synapse_metrics_proxying_hostname: ''
 matrix_synapse_metrics_proxying_path_prefix: /metrics/synapse
@@ -1153,7 +1153,7 @@ matrix_synapse_ext_password_provider_shared_secret_config_yaml: |
 
 # Enable this to activate LDAP password provider
 matrix_synapse_ext_password_provider_ldap_enabled: false
-matrix_synapse_ext_password_provider_ldap_uri: "ldap://ldap.mydomain.tld:389"
+matrix_synapse_ext_password_provider_ldap_uri: "ldap://ldap.example.com:389"
 matrix_synapse_ext_password_provider_ldap_start_tls: true
 matrix_synapse_ext_password_provider_ldap_mode: "search"
 matrix_synapse_ext_password_provider_ldap_base: ""
@@ -1398,7 +1398,7 @@ matrix_synapse_configuration_extension_yaml: |
   # server_notices:
   #   system_mxid_localpart: notices
   #   system_mxid_display_name: "Server Notices"
-  #   system_mxid_avatar_url: "mxc://server.com/oumMVlgDnLYFaPVkExemNVVZ"
+  #   system_mxid_avatar_url: "mxc://example.com/oumMVlgDnLYFaPVkExemNVVZ"
   #   room_name: "Server Notices"
 
 matrix_synapse_configuration_extension: "{{ matrix_synapse_configuration_extension_yaml | from_yaml if matrix_synapse_configuration_extension_yaml | from_yaml is mapping else {} }}"

roles/custom/matrix-synapse/templates/synapse/homeserver.yaml.j2

@@ -391,7 +391,7 @@ manhole_settings:
 
 # How to reach the server admin, used in ResourceLimitError
 #
-#admin_contact: 'mailto:admin@server.com'
+#admin_contact: 'mailto:admin@example.com'
 
 # Global blocking
 #
@@ -691,7 +691,7 @@ tls_private_key_path: {{ matrix_synapse_tls_private_key_path|to_json }}
 #
 #federation_certificate_verification_whitelist:
 #  - lon.example.com
-#  - "*.domain.com"
+#  - "*.example.com"
 #  - "*.onion"
 
 # List of custom certificate authorities for federation traffic.
@@ -1962,7 +1962,7 @@ saml2_config:
 #
 #   idp_icon: An optional icon for this identity provider, which is presented
 #       by clients and Synapse's own IdP picker page. If given, must be an
-#       MXC URI of the format mxc://<server-name>/<media-id>. (An easy way to
+#       MXC URI of the format mxc://example.com/<media-id>. (An easy way to
 #       obtain such an MXC URI is to upload an image to an (unencrypted) room
 #       and then copy the "url" from the source of the event.)
 #
@@ -2732,7 +2732,7 @@ stats:
 #server_notices:
 #  system_mxid_localpart: notices
 #  system_mxid_display_name: "Server Notices"
-#  system_mxid_avatar_url: "mxc://server.com/oumMVlgDnLYFaPVkExemNVVZ"
+#  system_mxid_avatar_url: "mxc://example.com/oumMVlgDnLYFaPVkExemNVVZ"
 #  room_name: "Server Notices"