Add support for config from /.well-known/matrix/client (#126)

* Add support for config from /.well-known/matrix/client

* final fixes, refactoring, updated readme
This commit is contained in:
Aine
2024-11-07 00:24:33 +02:00
committed by GitHub
parent 9adc13e722
commit c698f57395
6 changed files with 160 additions and 41 deletions

View File

@@ -90,6 +90,7 @@ with a proper manifest.json generation on build)
* [Add option to control user's experimental features](https://github.com/etkecc/synapse-admin/pull/111)
* [Add random password generation on user create/edit form](https://github.com/etkecc/synapse-admin/pull/123)
* [Add option to set user's rate limits](https://github.com/etkecc/synapse-admin/pull/125)
* [Support configuration via /.well-known/matrix/client](https://github.com/etkecc/synapse-admin/pull/126)
_the list will be updated as new changes are added_
@@ -106,7 +107,11 @@ After that open `http://localhost:5173` in your browser, login using the followi
## Configuration
You can use `config.json` file to configure synapse-admin
You can use `config.json` file to configure Synapse Admin instance,
and `/.well-known/matrix/client` file to provide Synapse Admin configuration specifically for your homeserver.
In the latter case, any instance of Synapse Admin will automatically pick up the configuration from the homeserver.
Note that configuration inside the `/.well-known/matrix/client` file should go under the `cc.etke.synapse-admin` key,
and it will override the configuration from the `config.json` file.
The `config.json` can be injected into a Docker container using a bind mount.
@@ -131,6 +136,16 @@ Edit `config.json` to restrict either to a single homeserver:
}
```
similar for `/.well-known/matrix/client`:
```json
{
"cc.etke.synapse-admin": {
"restrictBaseUrl": "https://your-matrixs-erver.example.com"
}
}
```
or to a list of homeservers:
```json
@@ -139,6 +154,16 @@ or to a list of homeservers:
}
```
similar for `/.well-known/matrix/client`:
```json
{
"cc.etke.synapse-admin": {
"restrictBaseUrl": ["https://your-first-matrix-server.example.com", "https://your-second-matrix-server.example.com"]
}
}
```
### Protecting appservice managed users
To avoid accidental adjustments of appservice-managed users (e.g., puppets created by a bridge) and breaking the bridge,
@@ -152,6 +177,16 @@ Example for [mautrix-telegram](https://github.com/mautrix/telegram)
}
```
similar for `/.well-known/matrix/client`:
```json
{
"cc.etke.synapse-admin": {
"asManagedUsers": ["^@telegram_[a-zA-Z0-9]+:example\\.com$"]
}
}
```
### Adding custom menu items
You can add custom menu items to the main menu by providing a `menu` array in the `config.json`.
@@ -168,6 +203,22 @@ You can add custom menu items to the main menu by providing a `menu` array in th
}
```
similar for `/.well-known/matrix/client`:
```json
{
"cc.etke.synapse-admin": {
"menu": [
{
"label": "Contact support",
"icon": "SupportAgent",
"url": "https://github.com/etkecc/synapse-admin/issues"
}
]
}
}
```
Where `icon` is one of the [preloaded icons](./src/components/icons.ts)
### Providing support URL
@@ -182,6 +233,16 @@ Where `icon` is one of the [preloaded icons](./src/components/icons.ts)
}
```
similar for `/.well-known/matrix/client`:
```json
{
"cc.etke.synapse-admin": {
"supportURL": "https://example.com/support"
}
}
```
## Usage
### Supported Synapse