From 1b80bd8f405786a89dbf9601def1dad3c7eb408a Mon Sep 17 00:00:00 2001 From: Kim Brose <2803622+HarHarLinks@users.noreply.github.com> Date: Mon, 13 Feb 2023 13:29:19 +0100 Subject: [PATCH] Register namespace for sample serviceBot in registration.sample.yml (#643) * Update service_bots.md * Update registration.sample.yml * Create 643.doc --- changelog.d/643.doc | 1 + docs/advanced/service_bots.md | 8 ++++++++ registration.sample.yml | 4 +++- 3 files changed, 12 insertions(+), 1 deletion(-) create mode 100644 changelog.d/643.doc diff --git a/changelog.d/643.doc b/changelog.d/643.doc new file mode 100644 index 00000000..0b019347 --- /dev/null +++ b/changelog.d/643.doc @@ -0,0 +1 @@ +Update docs and sample config for serviceBots. Thanks to @HarHarLinks. diff --git a/docs/advanced/service_bots.md b/docs/advanced/service_bots.md index f2e73c31..6336c648 100644 --- a/docs/advanced/service_bots.md +++ b/docs/advanced/service_bots.md @@ -26,3 +26,11 @@ serviceBots: ``` There will be a bot user `@feeds:example.com` which responds to commands prefixed with `!feeds`, and only handles feeds connections. + +For the homeserver to allow hookshot control over users, they need to be added to the list of user namespaces in the `registration.yml` file provided to the homeserver. + +In the example above, you would need to add these lines: +```yaml + - regex: "@feeds:example.com" # Where example.com is your homeserver's domain + exclusive: true +``` diff --git a/registration.sample.yml b/registration.sample.yml index d7a89d62..e22fcf89 100644 --- a/registration.sample.yml +++ b/registration.sample.yml @@ -12,6 +12,8 @@ namespaces: exclusive: true - regex: "@_webhooks_.*:foobar" # Where _webhooks_ is set by userIdPrefix in config.yml exclusive: true + - regex: "@feeds:foobar" # Matches the localpart of all serviceBots in config.yml + exclusive: true aliases: - regex: "#github_.+:foobar" # Where foobar is your homeserver's domain exclusive: true @@ -23,4 +25,4 @@ rate_limited: false # If enabling encryption de.sorunome.msc2409.push_ephemeral: true push_ephemeral: true -org.matrix.msc3202: true \ No newline at end of file +org.matrix.msc3202: true