OpenSource/homepage
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add documentation for Synapse/Matrix widget

Browse Source
This commit is contained in:
pizzaboxer 2023-10-06 16:12:33 +01:00
parent a4066d63cc
commit 3166ffc56d
No known key found for this signature in database
GPG Key ID: 59D4A1DBAD0F2BA8
1 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/widgets/services/synapse.md Normal file
View File

@ -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
```