Merge pull request #3607 from luixxiul/fix

Fix capitalization: id → ID

CHANGELOG.md

@@ -3478,7 +3478,7 @@ By default, public registration is forbidden.
 
 You can also make people automatically get auto-joined to rooms (controlled via `matrix_synapse_auto_join_rooms`).
 
-## Support for changing the welcome user id (welcome bot)
+## Support for changing the welcome user ID (welcome bot)
 
 By default, `@riot-bot:matrix.org` is used to welcome newly registered users.
 This can be changed to something else (or disabled) via the new `matrix_riot_web_welcome_user_id` variable.

docs/configuring-playbook-alertmanager-receiver.md

@@ -54,7 +54,7 @@ The playbook can automatically create users, but it cannot automatically obtain
 2. [Obtain an access token](obtaining-access-tokens.md) for the bot's user account
 3. Invite the bot to a room where you'd like to alerts to be delivered
 4. Log in as the bot using any Matrix client of your choosing, accept the room invitation from the bot's account and log out
-5. (Optionally) Adjust `matrix_alertmanager_receiver_config_matrix_room_mapping` to create a mapping between the new room and its id
+5. (Optionally) Adjust `matrix_alertmanager_receiver_config_matrix_room_mapping` to create a mapping between the new room and its ID
 
 Steps 1 and 2 above only need to be done once, while preparing your [configuration](#configuration).
 

docs/configuring-playbook-bridge-appservice-slack.md

@@ -16,7 +16,7 @@ loosely based on [this](https://github.com/matrix-org/matrix-appservice-slack#Se
 
     ```yaml
     matrix_appservice_slack_enabled: true
-    matrix_appservice_slack_control_room_id: "Your matrix admin room id"
+    matrix_appservice_slack_control_room_id: "Your matrix admin room ID"
     ```
 
 3. Enable puppeting (optional, but recommended)
@@ -83,7 +83,7 @@ loosely based on [this](https://github.com/matrix-org/matrix-appservice-slack#Se
 
     * Invite the bot user to both the Slack and Matrix channels you would like to bridge using `/invite @matrixbot` for Slack and `/invite @slackbot:MY.DOMAIN` for Matrix.
 
-    * Determine the "channel ID" that Slack uses to identify the channel. You can see it when you open a given Slack channel in a browser. The URL reads like this: `https://app.slack.com/client/XXX/<the channel id>/details/`.
+    * Determine the "channel ID" that Slack uses to identify the channel. You can see it when you open a given Slack channel in a browser. The URL reads like this: `https://app.slack.com/client/XXX/<the channel ID>/details/`.
 
     * Issue a link command in the administration control room with these collected values as arguments:
 
@@ -123,12 +123,12 @@ loosely based on [this](https://github.com/matrix-org/matrix-appservice-slack#Se
 
 * Linking: "Room is now pending-name"
 
-  This typically means that you haven't used the correct Slack channel id. Unlink the room and recheck 'Determine the "channel ID"' from above.
+  This typically means that you haven't used the correct Slack channel ID. Unlink the room and recheck 'Determine the "channel ID"' from above.
 
 * Messages work from M to S, but not the other way around
 
   Check you logs, if they say something like
 
-  `WARN SlackEventHandler Ignoring message from unrecognised Slack channel id : %s (%s) <the channel id> <some other id>`
+  `WARN SlackEventHandler Ignoring message from unrecognised Slack channel ID : %s (%s) <the channel ID> <some other ID>`
 
   then unlink your room, reinvite the bot and re-link it again. This may particularly hit you, if you tried to unsuccessfully link your room multiple times without unlinking it after each failed attempt.

docs/configuring-playbook-bridge-matrix-bridge-sms.md

@@ -13,7 +13,7 @@ To enable the bridge, add the following configuration to your `inventory/host_va
 ```yaml
 matrix_sms_bridge_enabled: true
 
-# (optional but recommended) a room id to a default room
+# (optional but recommended) a room ID to a default room
 matrix_sms_bridge_default_room: ""
 
 # (optional but recommended) configure your server location

docs/configuring-playbook-email2matrix.md

@@ -35,8 +35,8 @@ It doesn't matter who creates and owns the rooms and who joins later (you or the
 What matters is that both you and the sender user are part of the same room and that the sender user has enough privileges in the room to be able to send messages there.
 Inviting additional people to the room is okay too.
 
-Take note of each room's room id (different clients show the room id in a different place).
+Take note of each room's room ID (different clients show the room ID in a different place).
-You'll need the room id when doing [Configuration](#configuration) below.
+You'll need the room ID when doing [Configuration](#configuration) below.
 
 
 ### Obtaining an access token for the sender user

docs/configuring-playbook-jitsi.md

@@ -173,8 +173,8 @@ For this role to work you will need an additional section in the ansible hosts f
 <your jvb hosts> ansible_host=<ip address of the jvb host>
 ```
 
-Each JVB will require a server id to be set so that it can be uniquely identified and this allows Jitsi to keep track of which conferences are on which JVB.
+Each JVB will require a server ID to be set so that it can be uniquely identified and this allows Jitsi to keep track of which conferences are on which JVB.
-The server id is set with the variable `jitsi_jvb_server_id` which ends up as the JVB_WS_SERVER_ID environment variables in the JVB docker container.
+The server ID is set with the variable `jitsi_jvb_server_id` which ends up as the JVB_WS_SERVER_ID environment variables in the JVB docker container.
 This variable can be set via the host file, a parameter to the ansible command or in the `vars.yaml` for the host which will have the additional JVB. For example:
 
 ``` yaml
@@ -187,7 +187,7 @@ jvb-2.example.com ansible_host=192.168.0.2 jitsi_jvb_server_id=jvb-2
 jvb-3.example.com ansible_host=192.168.0.3 jitsi_jvb_server_id=jvb-2
 ```
 
-Note that the server id `jvb-1` is reserved for the JVB instance running on the Matrix host and therefore should not be used as the id of an additional jvb host.
+Note that the server ID `jvb-1` is reserved for the JVB instance running on the Matrix host and therefore should not be used as the ID of an additional jvb host.
 
 The additional JVB will also need to expose the colibri web socket port and this can be done with the following variable:
 
@@ -195,7 +195,7 @@ The additional JVB will also need to expose the colibri web socket port and this
 jitsi_jvb_container_colibri_ws_host_bind_port: 9090
 ```
 
-The JVB will also need to know where the prosody xmpp server is located, similar to the server id this can be set in the vars for the JVB by using the variable
+The JVB will also need to know where the prosody xmpp server is located, similar to the server ID this can be set in the vars for the JVB by using the variable
 `jitsi_xmpp_server`. The Jitsi prosody container is deployed on the matrix server by default so the value can be set to the matrix domain. For example:
 
 ```yaml

docs/configuring-playbook-matrix-corporal.md

@@ -52,7 +52,7 @@ matrix_corporal_policy_provider_config: |
 matrix_corporal_http_api_enabled: true
 matrix_corporal_http_api_auth_token: "AUTH_TOKEN_HERE"
 
-# If you need to change matrix-corporal's user id from the default (matrix-corporal).
+# If you need to change matrix-corporal's user ID from the default (matrix-corporal).
 # In any case, you need to make sure this Matrix user is created on your server.
 matrix_corporal_corporal_user_id_local_part: "matrix-corporal"
 
@@ -73,7 +73,7 @@ matrix_synapse_rc_login:
 
 Matrix Corporal operates with a specific Matrix user on your server.
 By default, it's `matrix-corporal` (controllable by the `matrix_corporal_reconciliation_user_id_local_part` setting, see above).
-No matter what Matrix user id you configure to run it with, make sure that:
+No matter what Matrix user ID you configure to run it with, make sure that:
 
 - the Matrix Corporal user is created by [registering it](registering-users.md) **with administrator privileges**. Use a password you remember, as you'll need to log in from time to time to create or join rooms
 

docs/configuring-playbook-matrix-media-repo.md

@@ -105,7 +105,7 @@ If you wish to manually generate the signing key and merge it with your homeserv
 
 ### Key backup and revoking
 
-Since your homeserver signing key file is modified by the playbook, a backup will be created in `HOMESERVER_DIR/config/DOMAIN.signing.key.backup`. If you need to remove/revoke old keys, you can restore from this backup or remove the MMR key id from your `DOMAIN.signing.key` file.
+Since your homeserver signing key file is modified by the playbook, a backup will be created in `HOMESERVER_DIR/config/DOMAIN.signing.key.backup`. If you need to remove/revoke old keys, you can restore from this backup or remove the MMR key ID from your `DOMAIN.signing.key` file.
 
 Additionally, its recommended after revoking a signing key to update your homeserver config file (`old_signing_keys` field for Synapse and `old_private_keys` for Dendrite). See your homeserver config file for further documentation on how to populate the field.
 

docs/configuring-playbook-prometheus-grafana.md

@@ -22,7 +22,7 @@ grafana_enabled: true
 
 grafana_anonymous_access: false
 
-# This has no relation to your Matrix user id. It can be any username you'd like.
+# This has no relation to your Matrix user ID. It can be any username you'd like.
 # Changing the username subsequently won't work.
 grafana_default_admin_user: "some_username_chosen_by_you"
 

docs/configuring-playbook-synapse-s3-storage-provider.md

@@ -36,7 +36,7 @@ matrix_synapse_ext_synapse_s3_storage_provider_config_region_name: some-region-n
 matrix_synapse_ext_synapse_s3_storage_provider_config_endpoint_url: https://s3.REGION_NAME.amazonaws.com # adjust this
 matrix_synapse_ext_synapse_s3_storage_provider_config_storage_class: STANDARD # or STANDARD_IA, etc.
 
-# Authentication Method 1 - (access key id + secret)
+# Authentication Method 1 - (access key ID + secret)
 # This works on all providers (AWS and other compatible systems).
 # Uncomment the variables below to use it.
 # matrix_synapse_ext_synapse_s3_storage_provider_config_access_key_id: access-key-goes-here

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

@@ -16,7 +16,7 @@ UVS can be used to verify two claims:
 * (A) Whether a given OpenID token is valid for a given server and
 * (B) whether a user is member of a given room and the corresponding PowerLevel
 
-Verifying an OpenID token id done by finding the corresponding Homeserver via  '.well-known/matrix/server' for the given domain.
+Verifying an OpenID token ID done by finding the corresponding Homeserver via  '.well-known/matrix/server' for the given domain.
 The configured `matrix_user_verification_service_uvs_homeserver_url` does **not** factor into this.
 By default, this playbook only checks against `matrix_server_fqn_matrix`.
 Therefore, the request will be made against the public openid API for `matrix_server_fqn_matrix`.

docs/configuring-well-known.md

@@ -25,7 +25,7 @@ To learn how to set up `/.well-known/matrix/server`, read the Installing section
 
 ## Introduction to Client Server Discovery
 
-Client Server Service discovery lets various client programs which support it, to receive a full user id (e.g. `@username:example.com`) and determine where the Matrix server is automatically (e.g. `https://matrix.example.com`).
+Client Server Service discovery lets various client programs which support it, to receive a full user ID (e.g. `@username:example.com`) and determine where the Matrix server is automatically (e.g. `https://matrix.example.com`).
 
 This lets you (and your users) easily connect to your Matrix server without having to customize connection URLs. When using client programs that support it, you won't need to point them to `https://matrix.example.com` in Custom Server options manually anymore. The connection URL would be discovered automatically from your full username.
 

docs/maintenance-migrating.md

@@ -10,5 +10,5 @@
 4. Make sure your DNS records are adjusted to point to the new server's IP address
 5. Remove old server from the `inventory/hosts` file and add new server.
 6. Run `ansible-playbook -i inventory/hosts setup.yml --tags=setup-system-user`. This will create the `matrix` user and group on the new server
-7. Because the `matrix` user and group are created dynamically on each server, the user/group id may differ between the old and new server. We suggest that you adjust ownership of `/matrix` files manually by running this on the new server: `chown -R matrix:matrix /matrix`.
+7. Because the `matrix` user and group are created dynamically on each server, the user/group ID may differ between the old and new server. We suggest that you adjust ownership of `/matrix` files manually by running this on the new server: `chown -R matrix:matrix /matrix`.
 8. Run `ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start` to finish the installation and start all services

roles/custom/matrix-appservice-draupnir-for-all/templates/production-appservice.yaml.j2

@@ -1,5 +1,5 @@
 homeserver:
-  # The Matrix server name, this will be the name of the server in your matrix id.
+  # The Matrix server name, this will be the name of the server in your matrix ID.
   domain: "{{ matrix_domain }}"
   # The url for the appservice to call the client server API from.
   url: "{{ matrix_homeserver_url }}"

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

@@ -139,8 +139,8 @@ matrix_user_username: "matrix"
 matrix_user_groupname: "matrix"
 
 # By default, the playbook creates the user (`matrix_user_username`)
-# and group (`matrix_user_groupname`) with a random id.
+# and group (`matrix_user_groupname`) with a random ID.
-# To use a specific user/group id, override these variables.
+# To use a specific user/group ID, override these variables.
 matrix_user_uid: ~
 matrix_user_gid: ~
 

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

@@ -156,10 +156,10 @@ matrix_bot_honoroit_healthchecks_duration: 60  # in seconds
 matrix_bot_honoroit_redmine_host: ''  # e.g. https://redmine.example.com
 matrix_bot_honoroit_redmine_apikey: ''
 matrix_bot_honoroit_redmine_project: ''  # project identifier (e.g. 'myproject')
-matrix_bot_honoroit_redmine_tracker_id: ''  # tracker id (e.g. 1)
+matrix_bot_honoroit_redmine_tracker_id: ''  # tracker ID (e.g. 1)
-matrix_bot_honoroit_redmine_new_status_id: ''  # new status id (e.g. 1)
+matrix_bot_honoroit_redmine_new_status_id: ''  # new status ID (e.g. 1)
-matrix_bot_honoroit_redmine_in_progress_status_id: ''  # in progress status id (e.g. 2)
+matrix_bot_honoroit_redmine_in_progress_status_id: ''  # in progress status ID (e.g. 2)
-matrix_bot_honoroit_redmine_done_status_id: ''  # done status id (e.g. 3)
+matrix_bot_honoroit_redmine_done_status_id: ''  # done status ID (e.g. 3)
 
 # A list of whitelisted users allowed to use/invite honoroit
 # If not defined, everyone is allowed.

roles/custom/matrix-bridge-appservice-irc/defaults/main.yml

@@ -412,7 +412,7 @@ matrix_appservice_irc_configuration: "{{ matrix_appservice_irc_configuration_yam
 #
 # We do this to ensure consistency:
 # - always having an up-to-date registration.yaml file (synced with the configuration file)
-# - always having the same AS/HS token and appservice id in the registration.yaml file
+# - always having the same AS/HS token and appservice ID in the registration.yaml file
 #
 # Learn more about this in `setup_install.yml`
 matrix_appservice_irc_registration_override_yaml: |

roles/custom/matrix-bridge-mautrix-meta-instagram/templates/config.yaml.j2

@@ -9,7 +9,7 @@ network:
     # * messenger - connect to FB Messenger via messenger.com (can be used with the facebook side deactivated)
     # * instagram - connect to Instagram DMs via instagram.com
     #
-    # Remember to change the appservice id, bot profile info, bridge username_template and management_room_text too.
+    # Remember to change the appservice ID, bot profile info, bridge username_template and management_room_text too.
     mode: {{ matrix_mautrix_meta_instagram_meta_mode | to_json }}
 
     # When in Instagram mode, should the bridge connect to WhatsApp servers for encrypted chats?

roles/custom/matrix-bridge-mautrix-meta-messenger/templates/config.yaml.j2

@@ -9,7 +9,7 @@ network:
     # * messenger - connect to FB Messenger via messenger.com (can be used with the facebook side deactivated)
     # * instagram - connect to Instagram DMs via instagram.com
     #
-    # Remember to change the appservice id, bot profile info, bridge username_template and management_room_text too.
+    # Remember to change the appservice ID, bot profile info, bridge username_template and management_room_text too.
     mode: {{ matrix_mautrix_meta_messenger_meta_mode | to_json }}
 
     # When in Instagram mode, should the bridge connect to WhatsApp servers for encrypted chats?

roles/custom/matrix-cactus-comments/templates/cactus_appservice.yaml.j2

@@ -10,7 +10,7 @@ url: "http://matrix-cactus-comments:{{ matrix_cactus_comments_container_port }}"
 as_token: {{ matrix_cactus_comments_as_token | to_json }}
 hs_token: {{ matrix_cactus_comments_hs_token | to_json }}
 
-# The user id of the cactusbot which can be used to register and moderate sites
+# The user ID of the cactusbot which can be used to register and moderate sites
 sender_localpart: "{{ matrix_cactus_comments_user_id }}"
 
 namespaces:

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

@@ -7,7 +7,7 @@
 
 [global]
 # The server_name is the pretty name of this server. It is used as a suffix for user
-# and room ids. Examples: matrix.org, conduit.rs
+# 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).

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

@@ -44,7 +44,7 @@ matrix_dimension_systemd_required_services_list_custom: []
 # List of systemd services that matrix-dimension.service wants
 matrix_dimension_systemd_wanted_services_list: []
 
-# The user and group id correspond to the node user in the `turt2live/matrix-dimension` image.
+# The user and group ID correspond to the node user in the `turt2live/matrix-dimension` image.
 matrix_dimension_user_uid: '1000'
 matrix_dimension_user_gid: '1000'
 

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

@@ -547,9 +547,9 @@ matrix_synapse_auto_join_rooms: []
 # automatically if they don't already exist.
 matrix_synapse_autocreate_auto_join_rooms: true
 
-# The local part of the user id which is used to create auto-join rooms if `matrix_synapse_autocreate_auto_join_rooms` is true.
+# The local part of the user ID which is used to create auto-join rooms if `matrix_synapse_autocreate_auto_join_rooms` is true.
 # Defaults to the initial user account that registers.
-# The user id is also used to invite new users to any auto-join rooms which are set to invite-only.
+# The user ID is also used to invite new users to any auto-join rooms which are set to invite-only.
 matrix_synapse_auto_join_mxid_localpart: ''
 
 # Controls whether room invites will be accepted on behalf of users.
@@ -832,7 +832,7 @@ matrix_synapse_worker_container_labels_traefik_hostname: "{{ matrix_synapse_cont
 
 # Controls whether labels will be added that expose metrics (see `matrix_synapse_metrics_proxying_enabled`)
 matrix_synapse_worker_container_labels_public_metrics_enabled: "{{ matrix_synapse_metrics_enabled and matrix_synapse_metrics_proxying_enabled }}"
-# The `__WORKER_ID__` placeholder will be replaced with the actual worker id during label-file generation (see `../templates/worker-labels.j2`).
+# The `__WORKER_ID__` placeholder will be replaced with the actual worker ID during label-file generation (see `../templates/worker-labels.j2`).
 matrix_synapse_worker_container_labels_public_metrics_traefik_path: "{{ matrix_synapse_metrics_proxying_path_prefix }}/worker/__WORKER_ID__"
 matrix_synapse_worker_container_labels_public_metrics_traefik_rule: "Host(`{{ matrix_synapse_metrics_proxying_hostname }}`) && Path(`{{ matrix_synapse_worker_container_labels_public_metrics_traefik_path }}`)"
 matrix_synapse_worker_container_labels_public_metrics_traefik_priority: 0
@@ -1210,7 +1210,7 @@ matrix_synapse_ext_encryption_disabler_download_url: "https://raw.githubusercont
 # A list of server domain names for which to deny encryption if the event sender's domain matches the domain in the list.
 # By default, with the configuration below, we prevent all homeserver users from initiating encryption in ANY room.
 matrix_synapse_ext_encryption_disabler_deny_encryption_for_users_of: ["{{ matrix_domain }}"]
-# A list of server domain names for which to deny encryption if the destination room id's domain matches the domain in the list.
+# A list of server domain names for which to deny encryption if the destination room ID's domain matches the domain in the list.
 # By default, with the configuration below, we prevent locally-created encryption events by ANY user encrypt rooms on the homeserver.
 # Note: foreign users with enough room privileges will still be able to send an encryption event to your rooms and encrypt them.
 matrix_synapse_ext_encryption_disabler_deny_encryption_for_rooms_of: ["{{ matrix_domain }}"]

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

@@ -1531,11 +1531,11 @@ autocreate_auto_join_rooms: {{ matrix_synapse_autocreate_auto_join_rooms|to_json
 #
 #autocreate_auto_join_room_preset: private_chat
 
-# The local part of the user id which is used to create auto_join_rooms if
+# The local part of the user ID which is used to create auto_join_rooms if
 # autocreate_auto_join_rooms is true. If this is not provided then the
 # initial user account that registers will be used to create the rooms.
 #
-# The user id is also used to invite new users to any auto-join rooms which
+# The user ID is also used to invite new users to any auto-join rooms which
 # are set to invite-only.
 #
 # It *must* be configured if autocreate_auto_join_room_preset is set to
@@ -1728,7 +1728,7 @@ old_signing_keys:
 #
 #    server_name: the name of the server. required.
 #
-#    verify_keys: an optional map from key id to base64-encoded public key.
+#    verify_keys: an optional map from key ID to base64-encoded public key.
 #       If specified, we will check that the response is signed by at least
 #       one of the given keys.
 #
@@ -1976,7 +1976,7 @@ saml2_config:
 #   issuer: Required. The OIDC issuer. Used to validate tokens and (if discovery
 #       is enabled) to discover the provider's endpoints.
 #
-#   client_id: Required. oauth2 client id to use.
+#   client_id: Required. oauth2 client ID to use.
 #
 #   client_secret: oauth2 client secret to use. May be omitted if
 #        client_secret_jwt_key is given, or if client_auth_method is 'none'.
@@ -2720,10 +2720,10 @@ stats:
 #
 # Uncomment this section to enable a room which can be used to send notices
 # from the server to users. It is a special room which cannot be left; notices
-# come from a special "notices" user id.
+# come from a special "notices" user ID.
 #
 # If you uncomment this section, you *must* define the system_mxid_localpart
-# setting, which defines the id of the user which will be used to send the
+# setting, which defines the ID of the user which will be used to send the
 # notices.
 #
 # It's also possible to override the room name, the display name of the

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

@@ -8,7 +8,7 @@ matrix_synapse_media_store_directory_name: "{{ matrix_synapse_media_store_path |
 # Optionally: `false` to fully disable tls on outbound smtp
 matrix_synapse_email_smtp_enable_tls: true
 
-# Room workers handle any URL that contains a room id, either through the client-server API or the federation API
+# Room workers handle any URL that contains a room ID, either through the client-server API or the federation API
 # - see https://tcpipuk.github.io/synapse/deployment/nginx.html#locationsconf
 matrix_synapse_workers_room_worker_client_server_endpoints:
   - ^/_matrix/client/.*?!(?<room>[A-Za-z0-9._=\-\/]+):[A-Za-z0-9.\-]+