From 5b98526363a34c5c94d4ede0e8c44d262c085b78 Mon Sep 17 00:00:00 2001 From: anoadragon453 Date: Thu, 3 Jun 2021 16:21:02 +0000 Subject: deploy: fd9856e4a98fb3fa9c139317b0a3b79f22aff1c7 --- develop/application_services.html | 281 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 281 insertions(+) create mode 100644 develop/application_services.html (limited to 'develop/application_services.html') diff --git a/develop/application_services.html b/develop/application_services.html new file mode 100644 index 0000000000..1a12f9cdfe --- /dev/null +++ b/develop/application_services.html @@ -0,0 +1,281 @@ + + + + + + Application Services - Synapse + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + + + + + + +
+
+ +
+ +
+ +

Registering an Application Service

+

The registration of new application services depends on the homeserver used. +In synapse, you need to create a new configuration file for your AS and add it +to the list specified under the app_service_config_files config +option in your synapse config.

+

For example:

+
app_service_config_files:
+- /home/matrix/.synapse/<your-AS>.yaml
+
+

The format of the AS configuration file is as follows:

+
url: <base url of AS>
+as_token: <token AS will add to requests to HS>
+hs_token: <token HS will add to requests to AS>
+sender_localpart: <localpart of AS user>
+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 for further details on how application services work.

+ +
+ + +
+
+ + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file -- cgit 1.5.1