Merge pull request #3636 from luixxiul/fix

Update `roles/custom/matrix-bridge-mx-puppet-*`

docs/configuring-playbook-alertmanager-receiver.md

@@ -61,7 +61,7 @@ Steps 1 and 2 above only need to be done once, while preparing your [configurati
 Steps 3 and 4 need to be done for each new room you'd like the bot to deliver alerts to. Step 5 is optional and provides cleaner `/alert/` URLs.
 
 
-## Installation
+## Installing
 
 Now that you've [prepared the bot account and room](#account-and-room-preparation) and have [configured the playbook](#configuration), you can run the [installation](installing.md) command: `just install-all`
 

docs/configuring-playbook-conduit.md

@@ -9,7 +9,7 @@ By default, this playbook configures the [Synapse](https://github.com/element-hq
 - **homeserver implementations other than Synapse may not be fully functional**. The playbook may also not assist you in an optimal way (like it does with Synapse). Make yourself familiar with the downsides before proceeding
 
 
-## Installation
+## Installing
 
 To use Conduit, you **generally** need the following additional `vars.yml` configuration:
 

docs/configuring-playbook-dendrite.md

@@ -22,7 +22,7 @@ Alternatively, **if there is no pre-defined variable** for a Dendrite setting yo
 
 
 
-## Installation
+## Installing
 
 To use Dendrite, you **generally** need the following additional `vars.yml` configuration:
 

docs/configuring-playbook-dimension.md

@@ -69,7 +69,7 @@ matrix_dimension_access_token: "YOUR ACCESS TOKEN HERE"
 For more information on how to acquire an access token, visit [https://t2bot.io/docs/access_tokens](https://t2bot.io/docs/access_tokens).
 
 
-## Installation
+## Installing
 
 After these variables have been set and you have potentially [adjusted your DNS records](#adjusting-dns-records), please run the following command to re-run setup and to restart Dimension:
 

docs/configuring-playbook-user-verification-service.md

@@ -98,7 +98,7 @@ in your host_vars.
 This will instruct UVS to verify the OpenID token against any domain given in a request.
 Homeserver discovery is done via '.well-known/matrix/server' of the given domain.
 
-## Installation
+## Installing
 
 After these variables have been set, run the [installation](installing.md) command to restart UVS:
 

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:example.com" to allow specific user
+# "@user:example.com" to allow a 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:example.com" disallow a specific user
-# "@.*:example.com" disallow users on a specific homeserver
+# "@user:example.com" to disallow a specific user
+# "@.*:example.com" to disallow users on a specific homeserver
 matrix_mx_puppet_discord_provisioning_blacklist: []
 
 matrix_mx_puppet_discord_container_network: ""

roles/custom/matrix-bridge-mx-puppet-discord/templates/config.yaml.j2

@@ -31,17 +31,17 @@ provisioning:
   # Regex of Matrix IDs allowed to use the puppet bridge
   whitelist: {{ matrix_mx_puppet_discord_provisioning_whitelist|to_json }}
     # Allow a specific user
-    #- "@user:server\\.com"
+    #- "@user:example\\.com"
     # Allow users on a specific homeserver
-    #- "@.*:yourserver\\.com"
+    #- "@.*:example\\.com"
     # Allow anyone
     #- ".*"
   # Regex of Matrix IDs forbidden from using the puppet bridge
   #blacklist:
     # Disallow a specific user
-    #- "@user:server\\.com"
+    #- "@user:example\\.com"
     # Disallow users on a specific homeserver
-    #- "@.*:yourserver\\.com"
+    #- "@.*:example\\.com"
   blacklist: {{ matrix_mx_puppet_discord_provisioning_blacklist|to_json }}
 
 relay:

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:example.com" to allow specific user
+# "@user:example.com" to allow a 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:example.com" disallow a specific user
-# "@.*:example.com" disallow users on a specific homeserver
+# "@user:example.com" to disallow a specific user
+# "@.*:example.com" to disallow users on a specific homeserver
 matrix_mx_puppet_groupme_provisioning_blacklist: []
 
 matrix_mx_puppet_groupme_container_network: ""

roles/custom/matrix-bridge-mx-puppet-groupme/templates/config.yaml.j2

@@ -19,7 +19,7 @@ bridge:
   #
   # This is where GroupMe will download user profile pictures and media
   # from
-  #mediaUrl: https://external-url.org
+  #mediaUrl: https://example.org
 
 presence:
   # Bridge GroupMe online/offline status
@@ -31,17 +31,17 @@ provisioning:
   # Regex of Matrix IDs allowed to use the puppet bridge
   whitelist: {{ matrix_mx_puppet_groupme_provisioning_whitelist|to_json }}
     # Allow a specific user
-    #- "@user:server\\.com"
+    #- "@user:example\\.com"
     # Allow users on a specific homeserver
-    #- "@.*:yourserver\\.com"
+    #- "@.*:example\\.com"
     # Allow anyone
     #- ".*"
   # Regex of Matrix IDs forbidden from using the puppet bridge
   #blacklist:
     # Disallow a specific user
-    #- "@user:server\\.com"
+    #- "@user:example\\.com"
     # Disallow users on a specific homeserver
-    #- "@.*:yourserver\\.com"
+    #- "@.*:example\\.com"
   blacklist: {{ matrix_mx_puppet_groupme_provisioning_blacklist|to_json }}
 
 relay:

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:example.com" to allow specific user
+# "@user:example.com" to allow a 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:example.com" disallow a specific user
-# "@.*:example.com" disallow users on a specific homeserver
+# "@user:example.com" to disallow a specific user
+# "@.*:example.com" to disallow users on a specific homeserver
 matrix_mx_puppet_instagram_provisioning_blacklist: []
 
 matrix_mx_puppet_instagram_container_network: ""

roles/custom/matrix-bridge-mx-puppet-instagram/templates/config.yaml.j2

@@ -24,17 +24,17 @@ provisioning:
   # Regex of Matrix IDs allowed to use the puppet bridge
   whitelist: {{ matrix_mx_puppet_instagram_provisioning_whitelist|to_json }}
     # Allow a specific user
-    #- "@user:server\\.com"
+    #- "@user:example\\.com"
     # Allow users on a specific homeserver
-    #- "@.*:yourserver\\.com"
+    #- "@.*:example\\.com"
     # Allow anyone
     #- ".*"
   # Regex of Matrix IDs forbidden from using the puppet bridge
   #blacklist:
     # Disallow a specific user
-    #- "@user:server\\.com"
+    #- "@user:example\\.com"
     # Disallow users on a specific homeserver
-    #- "@.*:yourserver\\.com"
+    #- "@.*:example\\.com"
   blacklist: {{ matrix_mx_puppet_instagram_provisioning_blacklist|to_json }}
 
   # Shared secret for the provisioning API for use by integration managers.

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:example.com" to allow specific user
+# "@user:example.com" to allow a 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:example.com" disallow a specific user
-# "@.*:example.com" disallow users on a specific homeserver
+# "@user:example.com" to disallow a specific user
+# "@.*:example.com" to disallow users on a specific homeserver
 matrix_mx_puppet_slack_provisioning_blacklist: []
 
 matrix_mx_puppet_slack_container_network: ""

roles/custom/matrix-bridge-mx-puppet-slack/templates/config.yaml.j2

@@ -38,17 +38,17 @@ provisioning:
   # Regex of Matrix IDs allowed to use the puppet bridge
   whitelist: {{ matrix_mx_puppet_slack_provisioning_whitelist|to_json }}
     # Allow a specific user
-    #- "@user:server\\.com"
+    #- "@user:example\\.com"
     # Allow users on a specific homeserver
-    #- "@.*:yourserver\\.com"
+    #- "@.*:example\\.com"
     # Allow anyone
     #- ".*"
   # Regex of Matrix IDs forbidden from using the puppet bridge
   #blacklist:
     # Disallow a specific user
-    #- "@user:server\\.com"
+    #- "@user:example\\.com"
     # Disallow users on a specific homeserver
-    #- "@.*:yourserver\\.com"
+    #- "@.*:example\\.com"
   blacklist: {{ matrix_mx_puppet_slack_provisioning_blacklist|to_json }}
 
   # Shared secret for the provisioning API for use by integration managers.

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:example.com" to allow specific user
+# "@user:example.com" to allow a 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:example.com" disallow a specific user
-# "@.*:example.com" disallow users on a specific homeserver
+# "@user:example.com" to disallow a specific user
+# "@.*:example.com" to disallow users on a specific homeserver
 matrix_mx_puppet_steam_provisioning_blacklist: []
 
 matrix_mx_puppet_steam_container_network: ""

roles/custom/matrix-bridge-mx-puppet-steam/templates/config.yaml.j2

@@ -31,17 +31,17 @@ provisioning:
   # Regex of Matrix IDs allowed to use the puppet bridge
   whitelist: {{ matrix_mx_puppet_steam_provisioning_whitelist|to_json }}
     # Allow a specific user
-    #- "@user:server\\.com"
+    #- "@user:example\\.com"
     # Allow users on a specific homeserver
-    #- "@.*:yourserver\\.com"
+    #- "@.*:example\\.com"
     # Allow anyone
     #- ".*"
   # Regex of Matrix IDs forbidden from using the puppet bridge
   #blacklist:
     # Disallow a specific user
-    #- "@user:server\\.com"
+    #- "@user:example\\.com"
     # Disallow users on a specific homeserver
-    #- "@.*:yourserver\\.com"
+    #- "@.*:example\\.com"
   blacklist: {{ matrix_mx_puppet_steam_provisioning_blacklist|to_json }}
 
 relay:

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:example.com" to allow specific user
+# "@user:example.com" to allow a 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:example.com" disallow a specific user
-# "@.*:example.com" disallow users on a specific homeserver
+# "@user:example.com" to disallow a specific user
+# "@.*:example.com" to disallow users on a specific homeserver
 matrix_mx_puppet_twitter_provisioning_blacklist: []
 
 matrix_mx_puppet_twitter_container_network: ""

roles/custom/matrix-bridge-mx-puppet-twitter/templates/config.yaml.j2

@@ -34,17 +34,17 @@ provisioning:
   # Regex of Matrix IDs allowed to use the puppet bridge
   whitelist: {{ matrix_mx_puppet_twitter_provisioning_whitelist|to_json }}
     # Allow a specific user
-    #- "@user:server\\.com"
+    #- "@user:example\\.com"
     # Allow users on a specific homeserver
-    #- "@.*:yourserver\\.com"
+    #- "@.*:example\\.com"
     # Allow anyone
     #- ".*"
   # Regex of Matrix IDs forbidden from using the puppet bridge
   #blacklist:
     # Disallow a specific user
-    #- "@user:server\\.com"
+    #- "@user:example\\.com"
     # Disallow users on a specific homeserver
-    #- "@.*:yourserver\\.com"
+    #- "@.*:example\\.com"
   blacklist: {{ matrix_mx_puppet_twitter_provisioning_blacklist|to_json }}
 
   # Shared secret for the provisioning API for use by integration managers.