From 1a8406f42ac3a7f63690c13cb8d8fd5547928632 Mon Sep 17 00:00:00 2001
From: Andrew Morgan <andrew@amorgan.xyz>
Date: Sun, 21 Nov 2021 02:39:02 +0000
Subject: Move documentation files to their place in the hierarchy; update
 SUMMARY.md

---
 docs/usage/configuration/application_services.md | 35 ++++++++++++++++++++++++
 1 file changed, 35 insertions(+)
 create mode 100644 docs/usage/configuration/application_services.md

(limited to 'docs/usage/configuration/application_services.md')

diff --git a/docs/usage/configuration/application_services.md b/docs/usage/configuration/application_services.md
new file mode 100644
index 0000000000..e4592010a2
--- /dev/null
+++ b/docs/usage/configuration/application_services.md
@@ -0,0 +1,35 @@
+# 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:
+
+```yaml
+app_service_config_files:
+- /home/matrix/.synapse/<your-AS>.yaml
+```
+
+The format of the AS configuration file is as follows:
+
+```yaml
+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](https://matrix.org/docs/spec/application_service/unstable.html) for further details on how application services work.
-- 
cgit 1.5.1