From f0cc5da229a83526b35690cad628552b59dae563 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Sun, 8 Dec 2024 17:03:37 +0900 Subject: [PATCH] Edit user identifier examples: to `@alice` and `@bob` Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-bot-draupnir.md | 4 ++-- docs/configuring-playbook-bot-go-neb.md | 6 +++--- docs/configuring-playbook-bot-mjolnir.md | 2 +- docs/configuring-playbook-bridge-appservice-discord.md | 2 +- .../configuring-playbook-bridge-mautrix-meta-instagram.md | 2 +- .../configuring-playbook-bridge-mautrix-meta-messenger.md | 2 +- docs/configuring-playbook-bridge-mautrix-signal.md | 4 ++-- docs/configuring-playbook-bridge-mautrix-telegram.md | 2 +- docs/configuring-playbook-email2matrix.md | 6 +++--- .../configuring-playbook-matrix-authentication-service.md | 2 +- docs/configuring-well-known.md | 4 ++-- docs/faq.md | 8 ++++---- docs/quick-start.md | 2 +- docs/registering-users.md | 2 +- docs/updating-users-passwords.md | 6 +++--- examples/vars.yml | 2 +- roles/custom/matrix-base/defaults/main.yml | 4 ++-- roles/custom/matrix-bot-chatgpt/defaults/main.yml | 6 +++--- roles/custom/matrix-bot-chatgpt/templates/env.j2 | 2 +- roles/custom/matrix-bot-go-neb/defaults/main.yml | 4 ++-- roles/custom/matrix-bot-honoroit/defaults/main.yml | 4 ++-- .../matrix-bridge-mx-puppet-discord/defaults/main.yml | 4 ++-- .../templates/config.yaml.j2 | 4 ++-- .../matrix-bridge-mx-puppet-groupme/defaults/main.yml | 4 ++-- .../templates/config.yaml.j2 | 4 ++-- .../matrix-bridge-mx-puppet-instagram/defaults/main.yml | 4 ++-- .../templates/config.yaml.j2 | 4 ++-- .../matrix-bridge-mx-puppet-slack/defaults/main.yml | 4 ++-- .../templates/config.yaml.j2 | 4 ++-- .../matrix-bridge-mx-puppet-steam/defaults/main.yml | 4 ++-- .../templates/config.yaml.j2 | 4 ++-- .../matrix-bridge-mx-puppet-twitter/defaults/main.yml | 4 ++-- .../templates/config.yaml.j2 | 4 ++-- roles/custom/matrix-bridge-postmoogle/defaults/main.yml | 4 ++-- roles/custom/matrix-dendrite/templates/dendrite.yaml.j2 | 2 +- roles/custom/matrix-email2matrix/defaults/main.yml | 4 ++-- .../matrix-synapse/templates/synapse/homeserver.yaml.j2 | 2 +- 37 files changed, 68 insertions(+), 68 deletions(-) diff --git a/docs/configuring-playbook-bot-draupnir.md b/docs/configuring-playbook-bot-draupnir.md index 22e04e434..48b7e96f6 100644 --- a/docs/configuring-playbook-bot-draupnir.md +++ b/docs/configuring-playbook-bot-draupnir.md @@ -34,7 +34,7 @@ You will need to prevent Synapse from rate limiting the bot's account. This is n If your Synapse Admin API is exposed to the internet for some reason like running the Synapse Admin Role [Link](configuring-playbook-synapse-admin.md) or running `matrix_synapse_container_labels_public_client_synapse_admin_api_enabled: true` in your playbook config. If your API is not externally exposed you should still be able to on the local host for your synapse run these commands. -The following command works on semi up to date Windows 10 installs and All Windows 11 installations and other systems that ship curl. `curl --header "Authorization: Bearer " -X POST https://matrix.example.com/_synapse/admin/v1/users/@example:example.com/override_ratelimit` Replace `@example:example.com` with the MXID of your Draupnir and example.com with your homeserver domain. You can easily obtain an access token for a homeserver admin account the same way you can obtain an access token for Draupnir itself. If you made Draupnir Admin you can just use the Draupnir token. +The following command works on semi up to date Windows 10 installs and All Windows 11 installations and other systems that ship curl. `curl --header "Authorization: Bearer " -X POST https://matrix.example.com/_synapse/admin/v1/users/@alice:example.com/override_ratelimit` Replace `@alice:example.com` with the MXID of your Draupnir and example.com with your homeserver domain. You can easily obtain an access token for a homeserver admin account the same way you can obtain an access token for Draupnir itself. If you made Draupnir Admin you can just use the Draupnir token. ## Create a management room @@ -170,7 +170,7 @@ The simplest and most useful entity to target is `user`. Below are a few example To create rules, you run commands in the Management Room (**not** in the policy list room). -- (ban a single user on a given homeserver): `!draupnir ban @someone:example.com my-bans Rude to others` +- (ban a single user on a given homeserver): `!draupnir ban @alice:example.com my-bans Rude to others` - (ban all users on a given homeserver by using a [wildcard](https://the-draupnir-project.github.io/draupnir-documentation/moderator/managing-users#wildcards)): `!draupnir ban @*:example.org my-bans Spam server - all users are fake` As a result of running these commands, you may observe: diff --git a/docs/configuring-playbook-bot-go-neb.md b/docs/configuring-playbook-bot-go-neb.md index 17580e9b1..c1e1d068c 100644 --- a/docs/configuring-playbook-bot-go-neb.md +++ b/docs/configuring-playbook-bot-go-neb.md @@ -62,7 +62,7 @@ matrix_bot_go_neb_realms: matrix_bot_go_neb_sessions: - SessionID: "your_github_session" RealmID: "github_realm" - UserID: "@YOUR_USER_ID:{{ matrix_domain }}" # This needs to be the username of the person that's allowed to use the !github commands + UserID: "@alice:{{ matrix_domain }}" # This needs to be the username of the person that's allowed to use the !github commands Config: # Populate these fields by generating a "Personal Access Token" on github.com AccessToken: "YOUR_GITHUB_ACCESS_TOKEN" @@ -149,7 +149,7 @@ matrix_bot_go_neb_services: UserID: "@another_goneb:{{ matrix_domain }}" Config: RealmID: "github_realm" - ClientUserID: "@YOUR_USER_ID:{{ matrix_domain }}" # needs to be an authenticated user so Go-NEB can create webhooks. Check the UserID field in the github_realm in matrix_bot_go_neb_sessions. + ClientUserID: "@alice:{{ matrix_domain }}" # needs to be an authenticated user so Go-NEB can create webhooks. Check the UserID field in the github_realm in matrix_bot_go_neb_sessions. Rooms: "!qporfwt:example.com": Repos: @@ -234,7 +234,7 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use ## Usage -To use the bot, invite it to any existing Matrix room (`/invite @whatever_you_chose:example.com` where `example.com` is your base domain, not the `matrix.` domain, make sure you have permission from the room owner if that's not you). +To use the bot, invite it to any existing Matrix room (`/invite @alice:example.com` where `example.com` is your base domain, not the `matrix.` domain, make sure you have permission from the room owner if that's not you). Basic usage is like this: `!echo hi` or `!imgur puppies` or `!giphy matrix` diff --git a/docs/configuring-playbook-bot-mjolnir.md b/docs/configuring-playbook-bot-mjolnir.md index 5cdf998d9..886225e26 100644 --- a/docs/configuring-playbook-bot-mjolnir.md +++ b/docs/configuring-playbook-bot-mjolnir.md @@ -30,7 +30,7 @@ You will need to prevent Synapse from rate limiting the bot's account. This is n If your Synapse Admin API is exposed to the internet for some reason like running the Synapse Admin Role [Link](configuring-playbook-synapse-admin.md) or running `matrix_synapse_container_labels_public_client_synapse_admin_api_enabled: true` in your playbook config. If your API is not externally exposed you should still be able to on the local host for your synapse run these commands. -The following command works on semi up to date Windows 10 installs and All Windows 11 installations and other systems that ship curl. `curl --header "Authorization: Bearer " -X POST https://matrix.example.com/_synapse/admin/v1/users/@example:example.com/override_ratelimit` Replace `@example:example.com` with the MXID of your Mjolnir and example.com with your homeserver domain. You can easily obtain an access token for a homeserver admin account the same way you can obtain an access token for Mjolnir itself. If you made Mjolnir Admin you can just use the Mjolnir token. +The following command works on semi up to date Windows 10 installs and All Windows 11 installations and other systems that ship curl. `curl --header "Authorization: Bearer " -X POST https://matrix.example.com/_synapse/admin/v1/users/@alice:example.com/override_ratelimit` Replace `@alice:example.com` with the MXID of your Mjolnir and example.com with your homeserver domain. You can easily obtain an access token for a homeserver admin account the same way you can obtain an access token for Mjolnir itself. If you made Mjolnir Admin you can just use the Mjolnir token. ## Create a management room diff --git a/docs/configuring-playbook-bridge-appservice-discord.md b/docs/configuring-playbook-bridge-appservice-discord.md index 604356467..8dbf09474 100644 --- a/docs/configuring-playbook-bridge-appservice-discord.md +++ b/docs/configuring-playbook-bridge-appservice-discord.md @@ -97,5 +97,5 @@ There's the Discord bridge's guide for [setting privileges on bridge managed roo ```sh docker exec -it matrix-appservice-discord \ -/bin/sh -c 'cp /cfg/registration.yaml /tmp/discord-registration.yaml && cd /tmp && node /build/tools/adminme.js -c /cfg/config.yaml -m "!qporfwt:example.com" -u "@USER:example.com" -p 100' +/bin/sh -c 'cp /cfg/registration.yaml /tmp/discord-registration.yaml && cd /tmp && node /build/tools/adminme.js -c /cfg/config.yaml -m "!qporfwt:example.com" -u "@alice:example.com" -p 100' ``` diff --git a/docs/configuring-playbook-bridge-mautrix-meta-instagram.md b/docs/configuring-playbook-bridge-mautrix-meta-instagram.md index 83d73062f..e47884846 100644 --- a/docs/configuring-playbook-bridge-mautrix-meta-instagram.md +++ b/docs/configuring-playbook-bridge-mautrix-meta-instagram.md @@ -56,7 +56,7 @@ matrix_mautrix_meta_instagram_bridge_permissions_default: '{{ matrix_admin }}': admin ``` -If you don't define the `matrix_admin` in your configuration (e.g. `matrix_admin: @user:example.com`), then there's no admin by default. +If you don't define the `matrix_admin` in your configuration (e.g. `matrix_admin: @alice:example.com`), then there's no admin by default. You may redefine `matrix_mautrix_meta_instagram_bridge_permissions_default` any way you see fit, or add extra permissions using `matrix_mautrix_meta_instagram_bridge_permissions_custom` like this: diff --git a/docs/configuring-playbook-bridge-mautrix-meta-messenger.md b/docs/configuring-playbook-bridge-mautrix-meta-messenger.md index 1825751df..c20ea86c9 100644 --- a/docs/configuring-playbook-bridge-mautrix-meta-messenger.md +++ b/docs/configuring-playbook-bridge-mautrix-meta-messenger.md @@ -69,7 +69,7 @@ matrix_mautrix_meta_messenger_bridge_permissions_default: '{{ matrix_admin }}': admin ``` -If you don't define the `matrix_admin` in your configuration (e.g. `matrix_admin: @user:example.com`), then there's no admin by default. +If you don't define the `matrix_admin` in your configuration (e.g. `matrix_admin: @alice:example.com`), then there's no admin by default. You may redefine `matrix_mautrix_meta_messenger_bridge_permissions_default` any way you see fit, or add extra permissions using `matrix_mautrix_meta_messenger_bridge_permissions_custom` like this: diff --git a/docs/configuring-playbook-bridge-mautrix-signal.md b/docs/configuring-playbook-bridge-mautrix-signal.md index 4f3780cc4..a8500de77 100644 --- a/docs/configuring-playbook-bridge-mautrix-signal.md +++ b/docs/configuring-playbook-bridge-mautrix-signal.md @@ -63,8 +63,8 @@ In case you want to replace the default permissions settings **completely**, pop ```yaml matrix_mautrix_signal_bridge_permissions: - '@ADMIN:example.com': admin - '@USER:example.com' : user + '@alice:example.com': admin + '@bob:example.com' : user ``` You may wish to look at `roles/custom/matrix-bridge-mautrix-signal/templates/config.yaml.j2` to find more information on the permissions settings and other options you would like to configure. diff --git a/docs/configuring-playbook-bridge-mautrix-telegram.md b/docs/configuring-playbook-bridge-mautrix-telegram.md index 34f385027..73b9cf529 100644 --- a/docs/configuring-playbook-bridge-mautrix-telegram.md +++ b/docs/configuring-playbook-bridge-mautrix-telegram.md @@ -57,7 +57,7 @@ You might also want to give permissions to administrate the bot: matrix_mautrix_telegram_configuration_extension_yaml: | bridge: permissions: - '@user:example.com': admin + '@alice:example.com': admin ``` More details about permissions in this example: https://github.com/mautrix/telegram/blob/master/mautrix_telegram/example-config.yaml#L410 diff --git a/docs/configuring-playbook-email2matrix.md b/docs/configuring-playbook-email2matrix.md index a819aa081..9c804831e 100644 --- a/docs/configuring-playbook-email2matrix.md +++ b/docs/configuring-playbook-email2matrix.md @@ -51,7 +51,7 @@ matrix_email2matrix_matrix_mappings: - MailboxName: "mailbox1" MatrixRoomId: "!qporfwt:{{ matrix_domain }}" MatrixHomeserverUrl: "{{ matrix_homeserver_url }}" - MatrixUserId: "@email2matrix:{{ matrix_domain }}" + MatrixUserId: "@alice:{{ matrix_domain }}" MatrixAccessToken: "MATRIX_ACCESS_TOKEN_HERE" IgnoreSubject: false IgnoreBody: false @@ -60,7 +60,7 @@ matrix_email2matrix_matrix_mappings: - MailboxName: "mailbox2" MatrixRoomId: "!aaabaa:{{ matrix_domain }}" MatrixHomeserverUrl: "{{ matrix_homeserver_url }}" - MatrixUserId: "@email2matrix:{{ matrix_domain }}" + MatrixUserId: "@bob:{{ matrix_domain }}" MatrixAccessToken: "MATRIX_ACCESS_TOKEN_HERE" IgnoreSubject: true IgnoreBody: false @@ -72,7 +72,7 @@ where: * MailboxName - local-part of the email address, through which emails are bridged to the room whose ID is defined with MatrixRoomId * MatrixRoomId - internal ID of the room, to which received emails are sent as Matrix message * MatrixHomeserverUrl - URL of your Matrix homeserver, through which to send Matrix messages. You can also set `MatrixHomeserverUrl` to the container URL where your homeserver's Client-Server API lives by using the `{{ matrix_addons_homeserver_client_api_url }}` variable -* MatrixUserId - the full ID of the sender user which sends bridged messages to the room +* MatrixUserId - the full ID of the sender user which sends bridged messages to the room. On this configuration it is `@alice:example.com` and `@bob:example.com` (where `example.com` is your base domain, not the `matrix.` domain) * MatrixAccessToken - sender user's access token * IgnoreSubject - if set to "true", the subject is not bridged to Matrix * IgnoreBody - if set to "true", the message body is not bridged to Matrix diff --git a/docs/configuring-playbook-matrix-authentication-service.md b/docs/configuring-playbook-matrix-authentication-service.md index 3dd34ae95..71fbc7c5e 100644 --- a/docs/configuring-playbook-matrix-authentication-service.md +++ b/docs/configuring-playbook-matrix-authentication-service.md @@ -353,7 +353,7 @@ If you have existing OIDC users in your Synapse user database (which will be the If you don't do this, `syn2mas` would report errors like this one: -> [FATAL] migrate - [Failed to import external id 4264b0f0-4f11-4ddd-aedb-b500e4d07c25 with oidc-keycloak for user @user:example.com: Error: Unknown upstream provider oidc-keycloak] +> [FATAL] migrate - [Failed to import external id 4264b0f0-4f11-4ddd-aedb-b500e4d07c25 with oidc-keycloak for user @alice:example.com: Error: Unknown upstream provider oidc-keycloak] Below is an example situation and a guide for how to solve it. diff --git a/docs/configuring-well-known.md b/docs/configuring-well-known.md index 5b051492d..eb6463f87 100644 --- a/docs/configuring-well-known.md +++ b/docs/configuring-well-known.md @@ -16,7 +16,7 @@ There are 3 types of well-known service discovery mechanism that Matrix makes us All services created by this playbook are meant to be installed on their own server (such as `matrix.example.com`), instead of the base domain (`example.com`). -As [per the Server-Server specification](https://matrix.org/docs/spec/server_server/r0.1.0.html#server-discovery), to use a short Matrix user identifier like `@user:example.com` while hosting services on a subdomain such as `matrix.example.com`, the Matrix network needs to be instructed of [server delegation](howto-server-delegation.md) / redirection. +As [per the Server-Server specification](https://matrix.org/docs/spec/server_server/r0.1.0.html#server-discovery), to use a short Matrix user identifier like `@alice:example.com` while hosting services on a subdomain such as `matrix.example.com`, the Matrix network needs to be instructed of [server delegation](howto-server-delegation.md) / redirection. For simplicity reasons, this playbook recommends you to set up server delegation via a `/.well-known/matrix/server` file. @@ -24,7 +24,7 @@ If you set up the DNS SRV record for server delegation instead, take a look at t ### 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. `@alice: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. diff --git a/docs/faq.md b/docs/faq.md index 5e9f8189a..a264dc272 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -26,9 +26,9 @@ In the world of the Matrix chat protocol, there are various client programs. The Matrix is also like email due to the fact that there are many servers around the world which can all talk to each other (you can send email from `@gmail.com` addresses to `@yahoo.com` and `@hotmail.com` addresses). It's the same with Matrix (`@bob:example.com` can talk to `@alice:example.org`). -If someone else is hosting your Matrix server (you being `@user:matrix.org` or some other public server like this), all you need is a Matrix client program, like Element Web or Element X Android. +If someone else is hosting your Matrix server (you being `@example:matrix.org` or some other public server like this), all you need is a Matrix client program, like Element Web or Element X Android. -If you'd like to host your own server (you being `@user:example.com`), you'd need to set up a Matrix server program, like Synapse. +If you'd like to host your own server (you being `@alice:example.com`), you'd need to set up a Matrix server program, like Synapse. In short: @@ -281,7 +281,7 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start `just install-all` is useful for maintaining your setup quickly ([2x-5x faster](../CHANGELOG.md#2x-5x-performance-improvements-in-playbook-runtime) than `just setup-all`) when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. Note these shortcuts run the `ensure-matrix-users-created` tag too. -- Without setting up [server delegation](howto-server-delegation.md) to `matrix.example.com`, your user identifiers will be like `@user:matrix.example.com`. This is equivalent to having an email address like `bob@mail.company.com`, instead of just `bob@company.com`. +- Without setting up [server delegation](howto-server-delegation.md) to `matrix.example.com`, your user identifiers will be like `@example:matrix.example.com`. This is equivalent to having an email address like `bob@mail.company.com`, instead of just `bob@company.com`. ### I don't use the base domain for anything. How am I supposed to set up Server Delegation for Matrix services? @@ -391,7 +391,7 @@ Yes, you can. You generally need to do a playbook installation. It's recommended to follow the full installation guide (starting at the [Prerequisites](prerequisites.md) page), not the [Quick start](quick-start.md) guide. The full installation guide will tell you when it's time to import your existing data into the newly-prepared server. -This Ansible playbook guides you into installing a server for `example.com` (user identifiers are like this: `@user:example.com`), while the server is at `matrix.example.com`. If your existing setup has a server name (`server_name` configuration setting in Synapse's `homeserver.yaml` file) other than the base `example.com`, you may need to tweak some additional variables. This FAQ entry may be of use if you're dealing with a more complicated setup - [How do I install on matrix.example.com without involving the base domain?](#how-do-i-install-on-matrixexamplecom-without-involving-the-base-domain) +This Ansible playbook guides you into installing a server for `example.com` (user identifiers are like this: `@alice:example.com`), while the server is at `matrix.example.com`. If your existing setup has a server name (`server_name` configuration setting in Synapse's `homeserver.yaml` file) other than the base `example.com`, you may need to tweak some additional variables. This FAQ entry may be of use if you're dealing with a more complicated setup - [How do I install on matrix.example.com without involving the base domain?](#how-do-i-install-on-matrixexamplecom-without-involving-the-base-domain) After configuring the playbook and installing and **before starting** services (done with `ansible-playbook … --tags=start`) you'd import [your SQLite](importing-synapse-sqlite.md) (or [Postgres](importing-postgres.md)) database and also [import your media store](importing-synapse-media-store.md). diff --git a/docs/quick-start.md b/docs/quick-start.md index 11d8cb7d4..be46da718 100644 --- a/docs/quick-start.md +++ b/docs/quick-start.md @@ -13,7 +13,7 @@ We will be using `example.com` as the "base domain" in the following instruction By following the instruction on this page, you will set up: - **your own Matrix server** on a `matrix.example.com` server, which is configured to present itself as `example.com` -- **your user account** like `@user:example.com` on the server +- **your user account** like `@alice:example.com` on the server - a **self-hosted Matrix client**, [Element Web](configuring-playbook-client-element-web.md) with the default subdomain at `element.example.com` - Matrix delegation, so that your `matrix.example.com` server (presenting itself as `example.com`) can join the Matrix Federation and communicate with any other server in the Matrix network diff --git a/docs/registering-users.md b/docs/registering-users.md index 210c16838..db7043a64 100644 --- a/docs/registering-users.md +++ b/docs/registering-users.md @@ -130,7 +130,7 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start To change the admin privileges for a user in Synapse's local database, you need to run an SQL query like this against the `synapse` database: ```sql -UPDATE users SET admin=ADMIN_VALUE WHERE name = '@USER:example.com'; +UPDATE users SET admin=ADMIN_VALUE WHERE name = '@alice:example.com'; ``` where: diff --git a/docs/updating-users-passwords.md b/docs/updating-users-passwords.md index 3dcc71e19..0b7ef0aa0 100644 --- a/docs/updating-users-passwords.md +++ b/docs/updating-users-passwords.md @@ -25,7 +25,7 @@ docker exec -it matrix-synapse /usr/local/bin/hash_password -c /data/homeserver. and then connecting to the postgres server and executing: ```sql -UPDATE users SET password_hash = '' WHERE name = '@someone:example.com'; +UPDATE users SET password_hash = '' WHERE name = '@alice:example.com'; ``` where `` is the hash returned by the docker command above. @@ -40,8 +40,8 @@ If you didn't make your account a server admin when you created it, you can lear ### Example: -To set @user:example.com's password to `correct_horse_battery_staple` you could use this curl command: +To set @alice:example.com's password to `correct_horse_battery_staple` you could use this curl command: ```sh -curl -XPOST -d '{ "new_password": "correct_horse_battery_staple" }' "https://matrix.example.com/_matrix/client/r0/admin/reset_password/@user:example.com?access_token=MDA...this_is_my_access_token +curl -XPOST -d '{ "new_password": "correct_horse_battery_staple" }' "https://matrix.example.com/_matrix/client/r0/admin/reset_password/@alice:example.com?access_token=MDA...this_is_my_access_token ``` diff --git a/examples/vars.yml b/examples/vars.yml index 45c631f14..31a421671 100644 --- a/examples/vars.yml +++ b/examples/vars.yml @@ -1,6 +1,6 @@ --- # The bare domain name which represents your Matrix identity. -# Matrix user IDs for your server will be of the form (`@user:example.com`). +# Matrix user IDs for your server will be of the form (`@alice:example.com`). # # Note: this playbook does not touch the server referenced here. # Installation happens on another server ("matrix.example.com", see `matrix_server_fqn_matrix`). diff --git a/roles/custom/matrix-base/defaults/main.yml b/roles/custom/matrix-base/defaults/main.yml index c3f2ffd07..076cb8006 100644 --- a/roles/custom/matrix-base/defaults/main.yml +++ b/roles/custom/matrix-base/defaults/main.yml @@ -1,7 +1,7 @@ --- # The bare domain name which represents your Matrix identity. -# Matrix user IDs for your server will be of the form (`@user:example.com`). +# Matrix user IDs for your server will be of the form (`@alice:example.com`). # # Note: this playbook does not touch the server referenced here. # Installation happens on another server ("matrix.example.com", see `matrix_server_fqn_matrix`). @@ -10,7 +10,7 @@ matrix_domain: ~ # The optional Matrix admin MXID, used in bridges' configs to set bridge admin user -# Example value: "@someone:{{ matrix_domain }}" +# Example value: "@alice:{{ matrix_domain }}" matrix_admin: '' # Global var to enable/disable encryption across all bridges with encryption support diff --git a/roles/custom/matrix-bot-chatgpt/defaults/main.yml b/roles/custom/matrix-bot-chatgpt/defaults/main.yml index 0cd01b518..a1b22656f 100644 --- a/roles/custom/matrix-bot-chatgpt/defaults/main.yml +++ b/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 :example.com, ie @SOMETHING:example.com, needs to be set, created manually beforehand. +# With the @ and :example.com, ie @alice: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 @@ -87,8 +87,8 @@ matrix_bot_chatgpt_matrix_rich_text: true # MATRIX_RICH_TEXT=true # A list of admins # Example set of rules: # matrix_bot_chatgpt_admins: -# - @someone:example.com -# - @another:example.com +# - @alice:example.com +# - @bob:example.com # - @bot.*:example.com # - @*:example.net # matrix_bot_chatgpt_admins: "{{ [matrix_admin] if matrix_admin else [] }}" diff --git a/roles/custom/matrix-bot-chatgpt/templates/env.j2 b/roles/custom/matrix-bot-chatgpt/templates/env.j2 index a6f62cc67..2c1a0a680 100644 --- a/roles/custom/matrix-bot-chatgpt/templates/env.j2 +++ b/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 :example.com, ie @SOMETHING:example.com +# With the @ and :example.com, ie @alice:example.com MATRIX_BOT_USERNAME={{ matrix_bot_chatgpt_matrix_bot_username }} MATRIX_BOT_PASSWORD={{ matrix_bot_chatgpt_matrix_bot_password }} diff --git a/roles/custom/matrix-bot-go-neb/defaults/main.yml b/roles/custom/matrix-bot-go-neb/defaults/main.yml index 359101bba..fd4bd9bd8 100644 --- a/roles/custom/matrix-bot-go-neb/defaults/main.yml +++ b/roles/custom/matrix-bot-go-neb/defaults/main.yml @@ -200,7 +200,7 @@ matrix_bot_go_neb_realms: [] matrix_bot_go_neb_sessions: [] # - SessionID: "your_github_session" # RealmID: "github_realm" -# UserID: "@YOUR_USER_ID:{{ matrix_domain }}" # This needs to be the username of the person that's allowed to use the !github commands +# UserID: "@alice:{{ matrix_domain }}" # This needs to be the username of the person that's allowed to use the !github commands # Config: # # Populate these fields by generating a "Personal Access Token" on github.com # AccessToken: "YOUR_GITHUB_ACCESS_TOKEN" @@ -286,7 +286,7 @@ matrix_bot_go_neb_services: [] # UserID: "@another_goneb:{{ matrix_domain }}" # Config: # RealmID: "github_realm" -# ClientUserID: "@YOUR_USER_ID:{{ matrix_domain }}" # needs to be an authenticated user so Go-NEB can create webhooks. Check the UserID field in the github_realm in matrix_bot_go_neb_sessions. +# ClientUserID: "@alice:{{ matrix_domain }}" # needs to be an authenticated user so Go-NEB can create webhooks. Check the UserID field in the github_realm in matrix_bot_go_neb_sessions. # Rooms: # "!qporfwt:example.com": # Repos: diff --git a/roles/custom/matrix-bot-honoroit/defaults/main.yml b/roles/custom/matrix-bot-honoroit/defaults/main.yml index 4f35ad931..850842db6 100644 --- a/roles/custom/matrix-bot-honoroit/defaults/main.yml +++ b/roles/custom/matrix-bot-honoroit/defaults/main.yml @@ -165,8 +165,8 @@ matrix_bot_honoroit_redmine_done_status_id: '' # done status ID (e.g. 3) # If not defined, everyone is allowed. # Example set of rules: # matrix_bot_honoroit_allowedusers: -# - @someone:example.com -# - @another:example.com +# - @alice:example.com +# - @bob:example.com # - @bot.*:example.com # - @*:example.net matrix_bot_honoroit_allowedusers: diff --git a/roles/custom/matrix-bridge-mx-puppet-discord/defaults/main.yml b/roles/custom/matrix-bridge-mx-puppet-discord/defaults/main.yml index 3c825b351..faf1a770c 100644 --- a/roles/custom/matrix-bridge-mx-puppet-discord/defaults/main.yml +++ b/roles/custom/matrix-bridge-mx-puppet-discord/defaults/main.yml @@ -33,14 +33,14 @@ 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 a specific user +# "@alice: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" to disallow a specific user +# "@bob:example.com" to disallow a specific user # "@.*:example.com" to disallow users on a specific homeserver matrix_mx_puppet_discord_provisioning_blacklist: [] diff --git a/roles/custom/matrix-bridge-mx-puppet-discord/templates/config.yaml.j2 b/roles/custom/matrix-bridge-mx-puppet-discord/templates/config.yaml.j2 index 4940a469d..3db538127 100644 --- a/roles/custom/matrix-bridge-mx-puppet-discord/templates/config.yaml.j2 +++ b/roles/custom/matrix-bridge-mx-puppet-discord/templates/config.yaml.j2 @@ -31,7 +31,7 @@ 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:example\\.com" + #- "@alice:example\\.com" # Allow users on a specific homeserver #- "@.*:example\\.com" # Allow anyone @@ -39,7 +39,7 @@ provisioning: # Regex of Matrix IDs forbidden from using the puppet bridge #blacklist: # Disallow a specific user - #- "@user:example\\.com" + #- "@bob:example\\.com" # Disallow users on a specific homeserver #- "@.*:example\\.com" blacklist: {{ matrix_mx_puppet_discord_provisioning_blacklist|to_json }} diff --git a/roles/custom/matrix-bridge-mx-puppet-groupme/defaults/main.yml b/roles/custom/matrix-bridge-mx-puppet-groupme/defaults/main.yml index 730123b0b..67ecd6cbd 100644 --- a/roles/custom/matrix-bridge-mx-puppet-groupme/defaults/main.yml +++ b/roles/custom/matrix-bridge-mx-puppet-groupme/defaults/main.yml @@ -29,14 +29,14 @@ 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 a specific user +# "@alice: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" to disallow a specific user +# "@bob:example.com" to disallow a specific user # "@.*:example.com" to disallow users on a specific homeserver matrix_mx_puppet_groupme_provisioning_blacklist: [] diff --git a/roles/custom/matrix-bridge-mx-puppet-groupme/templates/config.yaml.j2 b/roles/custom/matrix-bridge-mx-puppet-groupme/templates/config.yaml.j2 index 862397577..c3237513d 100644 --- a/roles/custom/matrix-bridge-mx-puppet-groupme/templates/config.yaml.j2 +++ b/roles/custom/matrix-bridge-mx-puppet-groupme/templates/config.yaml.j2 @@ -31,7 +31,7 @@ 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:example\\.com" + #- "@alice:example\\.com" # Allow users on a specific homeserver #- "@.*:example\\.com" # Allow anyone @@ -39,7 +39,7 @@ provisioning: # Regex of Matrix IDs forbidden from using the puppet bridge #blacklist: # Disallow a specific user - #- "@user:example\\.com" + #- "@bob:example\\.com" # Disallow users on a specific homeserver #- "@.*:example\\.com" blacklist: {{ matrix_mx_puppet_groupme_provisioning_blacklist|to_json }} diff --git a/roles/custom/matrix-bridge-mx-puppet-instagram/defaults/main.yml b/roles/custom/matrix-bridge-mx-puppet-instagram/defaults/main.yml index 54d56b3cd..168c4a3b3 100644 --- a/roles/custom/matrix-bridge-mx-puppet-instagram/defaults/main.yml +++ b/roles/custom/matrix-bridge-mx-puppet-instagram/defaults/main.yml @@ -24,14 +24,14 @@ 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 a specific user +# "@alice: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" to disallow a specific user +# "@bob:example.com" to disallow a specific user # "@.*:example.com" to disallow users on a specific homeserver matrix_mx_puppet_instagram_provisioning_blacklist: [] diff --git a/roles/custom/matrix-bridge-mx-puppet-instagram/templates/config.yaml.j2 b/roles/custom/matrix-bridge-mx-puppet-instagram/templates/config.yaml.j2 index 69943fe9b..2e15c5b0c 100644 --- a/roles/custom/matrix-bridge-mx-puppet-instagram/templates/config.yaml.j2 +++ b/roles/custom/matrix-bridge-mx-puppet-instagram/templates/config.yaml.j2 @@ -24,7 +24,7 @@ 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:example\\.com" + #- "@alice:example\\.com" # Allow users on a specific homeserver #- "@.*:example\\.com" # Allow anyone @@ -32,7 +32,7 @@ provisioning: # Regex of Matrix IDs forbidden from using the puppet bridge #blacklist: # Disallow a specific user - #- "@user:example\\.com" + #- "@bob:example\\.com" # Disallow users on a specific homeserver #- "@.*:example\\.com" blacklist: {{ matrix_mx_puppet_instagram_provisioning_blacklist|to_json }} diff --git a/roles/custom/matrix-bridge-mx-puppet-slack/defaults/main.yml b/roles/custom/matrix-bridge-mx-puppet-slack/defaults/main.yml index 307ee5b22..030ac871f 100644 --- a/roles/custom/matrix-bridge-mx-puppet-slack/defaults/main.yml +++ b/roles/custom/matrix-bridge-mx-puppet-slack/defaults/main.yml @@ -42,14 +42,14 @@ 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 a specific user +# "@alice: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" to disallow a specific user +# "@bob:example.com" to disallow a specific user # "@.*:example.com" to disallow users on a specific homeserver matrix_mx_puppet_slack_provisioning_blacklist: [] diff --git a/roles/custom/matrix-bridge-mx-puppet-slack/templates/config.yaml.j2 b/roles/custom/matrix-bridge-mx-puppet-slack/templates/config.yaml.j2 index b2ea9586d..ff965a172 100644 --- a/roles/custom/matrix-bridge-mx-puppet-slack/templates/config.yaml.j2 +++ b/roles/custom/matrix-bridge-mx-puppet-slack/templates/config.yaml.j2 @@ -38,7 +38,7 @@ 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:example\\.com" + #- "@alice:example\\.com" # Allow users on a specific homeserver #- "@.*:example\\.com" # Allow anyone @@ -46,7 +46,7 @@ provisioning: # Regex of Matrix IDs forbidden from using the puppet bridge #blacklist: # Disallow a specific user - #- "@user:example\\.com" + #- "@bob:example\\.com" # Disallow users on a specific homeserver #- "@.*:example\\.com" blacklist: {{ matrix_mx_puppet_slack_provisioning_blacklist|to_json }} diff --git a/roles/custom/matrix-bridge-mx-puppet-steam/defaults/main.yml b/roles/custom/matrix-bridge-mx-puppet-steam/defaults/main.yml index 639537e0b..0e4ce1674 100644 --- a/roles/custom/matrix-bridge-mx-puppet-steam/defaults/main.yml +++ b/roles/custom/matrix-bridge-mx-puppet-steam/defaults/main.yml @@ -30,14 +30,14 @@ 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 a specific user +# "@alice: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" to disallow a specific user +# "@bob:example.com" to disallow a specific user # "@.*:example.com" to disallow users on a specific homeserver matrix_mx_puppet_steam_provisioning_blacklist: [] diff --git a/roles/custom/matrix-bridge-mx-puppet-steam/templates/config.yaml.j2 b/roles/custom/matrix-bridge-mx-puppet-steam/templates/config.yaml.j2 index 213d628d2..c2d089f7f 100644 --- a/roles/custom/matrix-bridge-mx-puppet-steam/templates/config.yaml.j2 +++ b/roles/custom/matrix-bridge-mx-puppet-steam/templates/config.yaml.j2 @@ -31,7 +31,7 @@ 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:example\\.com" + #- "@alice:example\\.com" # Allow users on a specific homeserver #- "@.*:example\\.com" # Allow anyone @@ -39,7 +39,7 @@ provisioning: # Regex of Matrix IDs forbidden from using the puppet bridge #blacklist: # Disallow a specific user - #- "@user:example\\.com" + #- "@bob:example\\.com" # Disallow users on a specific homeserver #- "@.*:example\\.com" blacklist: {{ matrix_mx_puppet_steam_provisioning_blacklist|to_json }} diff --git a/roles/custom/matrix-bridge-mx-puppet-twitter/defaults/main.yml b/roles/custom/matrix-bridge-mx-puppet-twitter/defaults/main.yml index 4f806ff5d..24fc7fc07 100644 --- a/roles/custom/matrix-bridge-mx-puppet-twitter/defaults/main.yml +++ b/roles/custom/matrix-bridge-mx-puppet-twitter/defaults/main.yml @@ -42,14 +42,14 @@ 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 a specific user +# "@alice: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" to disallow a specific user +# "@bob:example.com" to disallow a specific user # "@.*:example.com" to disallow users on a specific homeserver matrix_mx_puppet_twitter_provisioning_blacklist: [] diff --git a/roles/custom/matrix-bridge-mx-puppet-twitter/templates/config.yaml.j2 b/roles/custom/matrix-bridge-mx-puppet-twitter/templates/config.yaml.j2 index c7dc8c32e..9cbcf2bc7 100644 --- a/roles/custom/matrix-bridge-mx-puppet-twitter/templates/config.yaml.j2 +++ b/roles/custom/matrix-bridge-mx-puppet-twitter/templates/config.yaml.j2 @@ -34,7 +34,7 @@ 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:example\\.com" + #- "@alice:example\\.com" # Allow users on a specific homeserver #- "@.*:example\\.com" # Allow anyone @@ -42,7 +42,7 @@ provisioning: # Regex of Matrix IDs forbidden from using the puppet bridge #blacklist: # Disallow a specific user - #- "@user:example\\.com" + #- "@bob:example\\.com" # Disallow users on a specific homeserver #- "@.*:example\\.com" blacklist: {{ matrix_mx_puppet_twitter_provisioning_blacklist|to_json }} diff --git a/roles/custom/matrix-bridge-postmoogle/defaults/main.yml b/roles/custom/matrix-bridge-postmoogle/defaults/main.yml index 58700b913..99bd6085a 100644 --- a/roles/custom/matrix-bridge-postmoogle/defaults/main.yml +++ b/roles/custom/matrix-bridge-postmoogle/defaults/main.yml @@ -100,8 +100,8 @@ matrix_postmoogle_relay_password: '' # A list of admins # Example set of rules: # matrix_postmoogle_admins: -# - '@someone:example.com' -# - '@another:example.com' +# - '@alice:example.com' +# - '@bob:example.com' # - '@bot.*:example.com' # - '@*:example.net' matrix_postmoogle_admins: "{{ [matrix_admin] if matrix_admin else [] }}" diff --git a/roles/custom/matrix-dendrite/templates/dendrite.yaml.j2 b/roles/custom/matrix-dendrite/templates/dendrite.yaml.j2 index 8ad058cab..3b7947260 100644 --- a/roles/custom/matrix-dendrite/templates/dendrite.yaml.j2 +++ b/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:{{ matrix_domain }}" + # - "@alice:{{ matrix_domain }}" # Configuration for the Federation API. federation_api: diff --git a/roles/custom/matrix-email2matrix/defaults/main.yml b/roles/custom/matrix-email2matrix/defaults/main.yml index 3f5d89d7b..736dc4bfe 100644 --- a/roles/custom/matrix-email2matrix/defaults/main.yml +++ b/roles/custom/matrix-email2matrix/defaults/main.yml @@ -48,7 +48,7 @@ matrix_email2matrix_smtp_hostname: "{{ matrix_server_fqn_matrix }}" # - MailboxName: "mailbox1" # MatrixRoomId: "!qporfwt:{{ matrix_domain }}" # MatrixHomeserverUrl: "{{ matrix_homeserver_url }}" -# MatrixUserId: "@email2matrix:{{ matrix_domain }}" +# MatrixUserId: "@alice:{{ matrix_domain }}" # MatrixAccessToken: "MATRIX_ACCESS_TOKEN_HERE" # IgnoreSubject: false # IgnoreBody: false @@ -57,7 +57,7 @@ matrix_email2matrix_smtp_hostname: "{{ matrix_server_fqn_matrix }}" # - MailboxName: "mailbox2" # MatrixRoomId: "!aaabaa:{{ matrix_domain }}" # MatrixHomeserverUrl: "{{ matrix_homeserver_url }}" -# MatrixUserId: "@email2matrix:{{ matrix_domain }}" +# MatrixUserId: "@bob:{{ matrix_domain }}" # MatrixAccessToken: "MATRIX_ACCESS_TOKEN_HERE" # IgnoreSubject: true # IgnoreBody: false diff --git a/roles/custom/matrix-synapse/templates/synapse/homeserver.yaml.j2 b/roles/custom/matrix-synapse/templates/synapse/homeserver.yaml.j2 index c4827fb61..457726774 100644 --- a/roles/custom/matrix-synapse/templates/synapse/homeserver.yaml.j2 +++ b/roles/custom/matrix-synapse/templates/synapse/homeserver.yaml.j2 @@ -30,7 +30,7 @@ modules: {{ matrix_synapse_modules|to_json }} # # The server_name name will appear at the end of usernames and room addresses # created on this server. For example if the server_name was example.com, -# usernames on this server would be in the format @user:example.com +# usernames on this server would be in the format @alice:example.com # # In most cases you should avoid using a Matrix specific subdomain such as # matrix.example.com or synapse.example.com as the server_name for the same