diff options
| author | lub <github@lubiland.de> | 2020-04-27 16:03:09 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-04-27 15:03:09 +0100 |
| commit | aa2492907f2ff34d2c78d6e6680b8325c827aca4 (patch) | |
| tree | a4f8e07d1b18137ddce9b987a416e8f0ea71d6e7 | |
| parent | Don't crash when one of the configuration files is empty (#7341) (diff) | |
| download | synapse-aa2492907f2ff34d2c78d6e6680b8325c827aca4.tar.xz | |
Add some explanation to application_services.md (#7091)
Signed-off-by: Simon Körner <git@lubiland.de>
| -rw-r--r-- | changelog.d/7091.doc | 1 | ||||
| -rw-r--r-- | docs/application_services.md | 4 |
2 files changed, 5 insertions, 0 deletions
diff --git a/changelog.d/7091.doc b/changelog.d/7091.doc new file mode 100644 index 0000000000..463536c812 --- /dev/null +++ b/changelog.d/7091.doc @@ -0,0 +1 @@ +Improve the documentation of application service configuration files. diff --git a/docs/application_services.md b/docs/application_services.md index 06cb79f1f9..e4592010a2 100644 --- a/docs/application_services.md +++ b/docs/application_services.md @@ -23,9 +23,13 @@ namespaces: users: # List of users we're interested in - exclusive: <bool> regex: <regex> + group_id: <group> - ... aliases: [] # List of aliases we're interested in rooms: [] # List of room ids we're interested in ``` +`exclusive`: If enabled, only this application service is allowed to register users in its namespace(s). +`group_id`: All users of this application service are dynamically joined to this group. This is useful for e.g user organisation or flairs. + See the [spec](https://matrix.org/docs/spec/application_service/unstable.html) for further details on how application services work. |