From 1e8030810f894c6a49ff548ecc9fcd0e6a94e4c1 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Sat, 19 Oct 2024 00:19:02 +0900 Subject: [PATCH] Update internal room ID: !someRoom Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-alertmanager-receiver.md | 6 +++--- docs/configuring-playbook-bot-buscarron.md | 2 +- docs/configuring-playbook-bot-draupnir.md | 4 ++-- docs/configuring-playbook-bot-go-neb.md | 8 ++++---- docs/configuring-playbook-bot-honoroit.md | 2 +- docs/configuring-playbook-bot-mjolnir.md | 2 +- docs/configuring-playbook-bridge-appservice-discord.md | 2 +- docs/configuring-playbook-bridge-appservice-slack.md | 10 +++++----- .../matrix-alertmanager-receiver/defaults/main.yml | 4 ++-- roles/custom/matrix-bot-go-neb/defaults/main.yml | 8 ++++---- .../matrix-bridge-appservice-irc/defaults/main.yml | 4 ++-- .../matrix-bridge-appservice-slack/defaults/main.yml | 2 +- .../templates/config.yaml.j2 | 2 +- roles/custom/matrix-synapse/defaults/main.yml | 2 +- .../templates/synapse/homeserver.yaml.j2 | 2 +- 15 files changed, 30 insertions(+), 30 deletions(-) diff --git a/docs/configuring-playbook-alertmanager-receiver.md b/docs/configuring-playbook-alertmanager-receiver.md index 0e10a5016..46f1626bb 100644 --- a/docs/configuring-playbook-alertmanager-receiver.md +++ b/docs/configuring-playbook-alertmanager-receiver.md @@ -25,12 +25,12 @@ matrix_alertmanager_receiver_config_matrix_access_token: '' # Optionally, configure some mappings (URL-friendly room name -> actual Matrix room ID). # # If you don't configure mappings, you can still deliver alerts using URLs like this: -# https://matrix.example.com/matrix-alertmanager-receiver-RANDOM_VALUE_HERE/alert/!some-room-id:example.com +# https://matrix.example.com/matrix-alertmanager-receiver-RANDOM_VALUE_HERE/alert/!someRoom:example.com # # If a mapping like the one below is configured, you can deliver alerts using friendlier URLs like this: # https://matrix.example.com/matrix-alertmanager-receiver-RANDOM_VALUE_HERE/alert/some-room-name matrix_alertmanager_receiver_config_matrix_room_mapping: - some-room-name: "!some-room-id:{{ matrix_domain }}" + some-room-name: "!someRoom:{{ matrix_domain }}" ``` See `roles/custom/matrix-alertmanager-receiver/defaults/main.yml` for additional configuration variables. @@ -102,6 +102,6 @@ route: - receiver: matrix ``` -.. where `URL_HERE` looks like `https://matrix.example.com/matrix-alertmanager-receiver-RANDOM_VALUE_HERE/alert/some-room-name` or `https://matrix.example.com/matrix-alertmanager-receiver-RANDOM_VALUE_HERE/alert/!some-room-id:example.com`. +.. where `URL_HERE` looks like `https://matrix.example.com/matrix-alertmanager-receiver-RANDOM_VALUE_HERE/alert/some-room-name` or `https://matrix.example.com/matrix-alertmanager-receiver-RANDOM_VALUE_HERE/alert/!someRoom:example.com`. This bot does **not** accept room invitations automatically (like many other bots do). To deliver messages to rooms, **the bot must be joined to all rooms manually** - see Step 5 of the [Account and room preparation](#account-and-room-preparation) section. diff --git a/docs/configuring-playbook-bot-buscarron.md b/docs/configuring-playbook-bot-buscarron.md index 20cd40c9f..9f006a303 100644 --- a/docs/configuring-playbook-bot-buscarron.md +++ b/docs/configuring-playbook-bot-buscarron.md @@ -20,7 +20,7 @@ matrix_bot_buscarron_password: PASSWORD_FOR_THE_BOT # Adjust accepted forms matrix_bot_buscarron_forms: - name: contact # (mandatory) Your form name, will be used as endpoint, eg: buscarron.example.com/contact - room: "!yourRoomID:{{ matrix_domain }}" # (mandatory) Room ID where form submission will be posted + room: "!someRoom:{{ matrix_domain }}" # (mandatory) Room ID where form submission will be posted redirect: https://example.com # (mandatory) To what page user will be redirected after the form submission ratelimit: 1r/m # (optional) rate limit of the form, format: r/, eg: 1r/s or 54r/m hasemail: 1 # (optional) form has "email" field that should be validated diff --git a/docs/configuring-playbook-bot-draupnir.md b/docs/configuring-playbook-bot-draupnir.md index f2a5df02e..70bb96dd9 100644 --- a/docs/configuring-playbook-bot-draupnir.md +++ b/docs/configuring-playbook-bot-draupnir.md @@ -47,7 +47,7 @@ Using your own account, create a new invite only room that you will use to manag If you make the management room encrypted (E2EE), then you MUST enable and use Pantalaimon (see below). -Once you have created the room you need to copy the room ID so you can tell the bot to use that room. In Element you can do this by going to the room's settings, clicking Advanced, and then copying the internal room ID. The room ID will look something like `!QvgVuKq0ha8glOLGMG:example.com`. +Once you have created the room you need to copy the room ID so you can tell the bot to use that room. In Element you can do this by going to the room's settings, clicking Advanced, and then copying the internal room ID. The room ID will look something like `!someRoom:example.com`. Finally invite the `@bot.draupnir:example.com` account you created earlier into the room. @@ -135,7 +135,7 @@ Draupnir can be told to self-join public rooms, but it's better to follow this f 2. [Give the bot permissions to do its job](#giving-draupnir-permissions-to-do-its-job) -3. Tell it to protect the room (using the [rooms command](https://the-draupnir-project.github.io/draupnir-documentation/moderator/managing-protected-rooms#using-the-draupnir-rooms-command)) by sending the following command to the Management Room: `!draupnir rooms add !ROOM_ID:example.com` +3. Tell it to protect the room (using the [rooms command](https://the-draupnir-project.github.io/draupnir-documentation/moderator/managing-protected-rooms#using-the-draupnir-rooms-command)) by sending the following command to the Management Room: `!draupnir rooms add !someRoom:example.com` To have Draupnir provide useful room protection, you need do to a bit more work (at least the first time around). You may wish to [Subscribe to a public policy list](#subscribing-to-a-public-policy-list), [Create your own own policy and rules](#creating-your-own-policy-lists-and-rules) and [Enabling built-in protections](#enabling-built-in-protections). diff --git a/docs/configuring-playbook-bot-go-neb.md b/docs/configuring-playbook-bot-go-neb.md index cd1974295..8c0ecc946 100644 --- a/docs/configuring-playbook-bot-go-neb.md +++ b/docs/configuring-playbook-bot-go-neb.md @@ -125,7 +125,7 @@ matrix_bot_go_neb_services: Config: feeds: "http://lorem-rss.herokuapp.com/feed?unit=second&interval=60": - rooms: ["!qmElAGdFYCHoCJuaNt:{{ matrix_domain }}"] + rooms: ["!someRoom:{{ matrix_domain }}"] must_include: author: - author1 @@ -151,7 +151,7 @@ matrix_bot_go_neb_services: 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. Rooms: - "!someroom:example.com": + "!someRoom:example.com": Repos: "element-hq/synapse": Events: ["push", "issues"] @@ -170,7 +170,7 @@ matrix_bot_go_neb_services: Config: Hooks: "hook1": - RoomID: "!someroom:example.com" + RoomID: "!someRoom:example.com" MessageType: "m.text" # default is m.text - ID: "alertmanager_service" @@ -184,7 +184,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:example.com": + "!someRoom: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\"}} [FIRING - CRITICAL] {{ else if eq $severity \"warning\"}} [FIRING - WARNING] {{ else }} [FIRING - {{ $severity }}] {{ end }} {{ else }} [RESOLVED] {{ end }} {{ index .Labels \"alertname\"}} : {{ index .Annotations \"description\"}} source
{{end -}}{% endraw %}" msg_type: "m.text" # Must be either `m.text` or `m.notice` diff --git a/docs/configuring-playbook-bot-honoroit.md b/docs/configuring-playbook-bot-honoroit.md index 29680cb04..f99c446a8 100644 --- a/docs/configuring-playbook-bot-honoroit.md +++ b/docs/configuring-playbook-bot-honoroit.md @@ -21,7 +21,7 @@ matrix_bot_honoroit_enabled: true matrix_bot_honoroit_password: PASSWORD_FOR_THE_BOT # Adjust this to your room ID -matrix_bot_honoroit_roomid: "!yourRoomID:{{ matrix_domain }}" +matrix_bot_honoroit_roomid: "!someRoom:{{ matrix_domain }}" ``` ### Adjusting the Honoroit URL diff --git a/docs/configuring-playbook-bot-mjolnir.md b/docs/configuring-playbook-bot-mjolnir.md index 4f314f672..c72780a40 100644 --- a/docs/configuring-playbook-bot-mjolnir.md +++ b/docs/configuring-playbook-bot-mjolnir.md @@ -41,7 +41,7 @@ Using your own account, create a new invite only room that you will use to manag If you make the management room encrypted (E2EE), then you MUST enable and use Pantalaimon (see below). -Once you have created the room you need to copy the room ID so you can tell the bot to use that room. In Element you can do this by going to the room's settings, clicking Advanced, and then copying the internal room ID. The room ID will look something like `!QvgVuKq0ha8glOLGMG:example.com`. +Once you have created the room you need to copy the room ID so you can tell the bot to use that room. In Element you can do this by going to the room's settings, clicking Advanced, and then copying the internal room ID. The room ID will look something like `!someRoom:example.com`. Finally invite the `@bot.mjolnir:example.com` account you created earlier into the room. diff --git a/docs/configuring-playbook-bridge-appservice-discord.md b/docs/configuring-playbook-bridge-appservice-discord.md index 191c1b073..de63d1bee 100644 --- a/docs/configuring-playbook-bridge-appservice-discord.md +++ b/docs/configuring-playbook-bridge-appservice-discord.md @@ -81,5 +81,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 "!ROOM_ID: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 "!someRoom:example.com" -u "@USER:example.com" -p 100' ``` diff --git a/docs/configuring-playbook-bridge-appservice-slack.md b/docs/configuring-playbook-bridge-appservice-slack.md index 80864cbf7..f0200ed89 100644 --- a/docs/configuring-playbook-bridge-appservice-slack.md +++ b/docs/configuring-playbook-bridge-appservice-slack.md @@ -79,7 +79,7 @@ loosely based on [this](https://github.com/matrix-org/matrix-appservice-slack#Se 11. If Team Sync is not enabled, for each channel you would like to bridge, perform the following steps: - * Create a Matrix room in the usual manner for your client. Take a note of its Matrix room ID - it will look something like !aBcDeF:example.com. + * Create a Matrix room in the usual manner for your client. Take a note of its Matrix room ID - it will look something like !someRoom:example.com. * Invite the bot user to both the Slack and Matrix channels you would like to bridge using `/invite @matrixbot` for Slack and `/invite @slackbot:example.com` for Matrix. @@ -90,19 +90,19 @@ loosely based on [this](https://github.com/matrix-org/matrix-appservice-slack#Se with file bridging: ``` - link --channel_id CHANNELID --room !the-matrix:example.com --slack_bot_token xoxb-xxxxxxxxxx-xxxxxxxxxxxxxxxxxxxx --slack_user_token xoxp-xxxxxxxx-xxxxxxxxx-xxxxxxxx-xxxxxxxx + link --channel_id CHANNELID --room !someRoom:example.com --slack_bot_token xoxb-xxxxxxxxxx-xxxxxxxxxxxxxxxxxxxx --slack_user_token xoxp-xxxxxxxx-xxxxxxxxx-xxxxxxxx-xxxxxxxx ``` without file bridging: ``` - link --channel_id CHANNELID --room !the-matrix:example.com --slack_bot_token xoxb-xxxxxxxxxx-xxxxxxxxxxxxxxxxxxxx + link --channel_id CHANNELID --room !someRoom:example.com --slack_bot_token xoxb-xxxxxxxxxx-xxxxxxxxxxxxxxxxxxxx ``` These arguments can be shortened to single-letter forms: ``` - link -I CHANNELID -R !the-matrix:example.com -t xoxb-xxxxxxxxxx-xxxxxxxxxxxxxxxxxxxx + link -I CHANNELID -R !someRoom:example.com -t xoxb-xxxxxxxxxx-xxxxxxxxxxxxxxxxxxxx ``` Other configuration options are available via the `matrix_appservice_slack_configuration_extension_yaml` variable. @@ -112,7 +112,7 @@ loosely based on [this](https://github.com/matrix-org/matrix-appservice-slack#Se Channels can be unlinked again like this: ``` - unlink --room !the-matrix:example.com + unlink --room !someRoom:example.com ``` Unlinking doesn't only disconnect the bridge, but also makes the slackbot leave the bridged Matrix room. So in case you want to re-link later, don't forget to re-invite the slackbot into this room again. diff --git a/roles/custom/matrix-alertmanager-receiver/defaults/main.yml b/roles/custom/matrix-alertmanager-receiver/defaults/main.yml index adc43220a..c91bb59bf 100644 --- a/roles/custom/matrix-alertmanager-receiver/defaults/main.yml +++ b/roles/custom/matrix-alertmanager-receiver/defaults/main.yml @@ -127,8 +127,8 @@ matrix_alertmanager_receiver_config_matrix_access_token: '' # # Example: # matrix_alertmanager_receiver_config_matrix_room: -# simple-name: "!qohfwef7qwerf:example.com" -# another-name: "!bf3zfio3wbanw:example.com" +# simple-name: "!someRoom:example.com" +# another-name: "!anotherRoom:example.com" matrix_alertmanager_receiver_config_matrix_room_mapping: {} # Controls the `templating.external-url-mapping` configuration setting. diff --git a/roles/custom/matrix-bot-go-neb/defaults/main.yml b/roles/custom/matrix-bot-go-neb/defaults/main.yml index a0bd8c699..275b47218 100644 --- a/roles/custom/matrix-bot-go-neb/defaults/main.yml +++ b/roles/custom/matrix-bot-go-neb/defaults/main.yml @@ -262,7 +262,7 @@ matrix_bot_go_neb_services: [] # Config: # feeds: # "http://lorem-rss.herokuapp.com/feed?unit=second&interval=60": -# rooms: ["!qmElAGdFYCHoCJuaNt:localhost"] +# rooms: ["!someRoom:localhost"] # must_include: # author: # - author1 @@ -288,7 +288,7 @@ matrix_bot_go_neb_services: [] # 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. # Rooms: -# "!someroom:example.com": +# "!someRoom:example.com": # Repos: # "element-hq/synapse": # Events: ["push", "issues"] @@ -307,7 +307,7 @@ matrix_bot_go_neb_services: [] # Config: # Hooks: # "hook1": -# RoomID: "!someroom:example.com" +# RoomID: "!someRoom:example.com" # MessageType: "m.text" # default is m.text # # - ID: "alertmanager_service" @@ -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:example.com": +# "!someRoom: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\"}} [FIRING - CRITICAL] {{ else if eq $severity \"warning\"}} [FIRING - WARNING] {{ else }} [FIRING - {{ $severity }}] {{ end }} {{ else }} [RESOLVED] {{ end }} {{ index .Labels \"alertname\"}} : {{ index .Annotations \"description\"}} source
{{end -}}{% endraw %}" # msg_type: "m.text" # Must be either `m.text` or `m.notice` diff --git a/roles/custom/matrix-bridge-appservice-irc/defaults/main.yml b/roles/custom/matrix-bridge-appservice-irc/defaults/main.yml index 04b2e7d5e..a6090d46a 100644 --- a/roles/custom/matrix-bridge-appservice-irc/defaults/main.yml +++ b/roles/custom/matrix-bridge-appservice-irc/defaults/main.yml @@ -256,7 +256,7 @@ matrix_appservice_irc_ircService_servers: [] # noqa var-naming # # Apply specific rules to Matrix rooms. Only matrix-to-IRC takes effect. # rooms: -# - room: "!fuasirouddJoxtwfge:localhost" +# - room: "!someRoom:localhost" # matrixToIrc: # initial: false # incremental: false @@ -273,7 +273,7 @@ matrix_appservice_irc_ircService_servers: [] # noqa var-naming # # The Matrix room must already exist. Your Matrix client should expose # # the room ID in a "settings" page for the room. # "#thepub": -# roomIds: ["!kieouiJuedJoxtVdaG:localhost"] +# roomIds: ["!someRoom:localhost"] # # Channel key/password to use. Optional. If provided, Matrix users do # # not need to know the channel key in order to join the channel. # # key: "secret" diff --git a/roles/custom/matrix-bridge-appservice-slack/defaults/main.yml b/roles/custom/matrix-bridge-appservice-slack/defaults/main.yml index 90e0ae2c9..5e88d8be0 100644 --- a/roles/custom/matrix-bridge-appservice-slack/defaults/main.yml +++ b/roles/custom/matrix-bridge-appservice-slack/defaults/main.yml @@ -141,7 +141,7 @@ matrix_appservice_slack_configuration_extension_yaml: | # Optional #slack_master_token: "abc-123-def" # Optional - #matrix_admin_room: "!aBcDeF:example.com" + #matrix_admin_room: "!someRoom:example.com" #homeserver: # url: http://localhost:{{ matrix_synapse_container_client_api_port }} # server_name: my.server diff --git a/roles/custom/matrix-bridge-go-skype-bridge/templates/config.yaml.j2 b/roles/custom/matrix-bridge-go-skype-bridge/templates/config.yaml.j2 index d37ca6efa..6fc62f14f 100644 --- a/roles/custom/matrix-bridge-go-skype-bridge/templates/config.yaml.j2 +++ b/roles/custom/matrix-bridge-go-skype-bridge/templates/config.yaml.j2 @@ -205,7 +205,7 @@ bridge: # The management room for the bot. This is where all status notifications are posted and # in this room, you can use `!wa ` instead of `!wa relaybot `. Omitting # the command prefix completely like in user management rooms is not possible. - management: '!foo:example.com' + management: '!someRoom:example.com' # List of users to invite to all created rooms that include the relaybot. invites: [] # The formats to use when sending messages to Skype via the relaybot. diff --git a/roles/custom/matrix-synapse/defaults/main.yml b/roles/custom/matrix-synapse/defaults/main.yml index 4f61886a4..198f9d80c 100644 --- a/roles/custom/matrix-synapse/defaults/main.yml +++ b/roles/custom/matrix-synapse/defaults/main.yml @@ -1245,7 +1245,7 @@ matrix_synapse_ext_spam_checker_mjolnir_antispam_config_block_usernames: false # this list cannot be room aliases or permalinks. This server is expected # to already be joined to the room - Mjolnir will not automatically join # these rooms. -# ["!roomid:example.org"] +# ["!someRoom:example.org"] matrix_synapse_ext_spam_checker_mjolnir_antispam_config_ban_lists: [] # A dictionary with various fields controlling max length. # See https://github.com/matrix-org/mjolnir/blob/main/docs/synapse_module.md for details. diff --git a/roles/custom/matrix-synapse/templates/synapse/homeserver.yaml.j2 b/roles/custom/matrix-synapse/templates/synapse/homeserver.yaml.j2 index a18e6173a..b7bc375a8 100644 --- a/roles/custom/matrix-synapse/templates/synapse/homeserver.yaml.j2 +++ b/roles/custom/matrix-synapse/templates/synapse/homeserver.yaml.j2 @@ -575,7 +575,7 @@ templates: # By default, no room is excluded. # #exclude_rooms_from_sync: -# - !foo:example.com +# - !someRoom:example.com # Message retention policy at the server level.