From 3166ffc56de9e98ed80542534a17dcb58495ffb0 Mon Sep 17 00:00:00 2001 From: pizzaboxer Date: Fri, 6 Oct 2023 16:12:33 +0100 Subject: [PATCH] Add documentation for Synapse/Matrix widget --- docs/widgets/services/synapse.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 docs/widgets/services/synapse.md diff --git a/docs/widgets/services/synapse.md b/docs/widgets/services/synapse.md new file mode 100644 index 00000000..7c2a4fa6 --- /dev/null +++ b/docs/widgets/services/synapse.md @@ -0,0 +1,19 @@ +--- +title: Synapse (Matrix) +description: Synapse (Matrix) Widget Configuration +--- + +This widget displays statistics of your Synapse Matrix homeserver, showing registered users, stored rooms, and federated peers. + +Note that the URL provided in the widget should be one that has access to the Admin API at `/_synapse/admin/`. This API is not normally publicly accessible behind a reverse proxy, so be sure to use a URL that points to the homeserver locally. + +For obtaining your access_token, see the [documentation on the Admin API](https://matrix-org.github.io/synapse/latest/usage/administration/admin_api/index.html). Element lets you obtain it through `All Settings > Help & About > Advanced > Access Token`. + +Allowed fields: `["users", "rooms", "peers"]`. + +```yaml +widget: + type: synapse + url: http://synapse.host.or.ip:port + key: access_token +``` \ No newline at end of file