From 35698484a51081126d3f8b37a599d7d37a91f5fb Mon Sep 17 00:00:00 2001
From: Erik Johnston <erik@matrix.org>
Date: Thu, 7 May 2015 18:51:09 +0100
Subject: Add some information on registering AS's

---
 docs/application_services.rst | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)
 create mode 100644 docs/application_services.rst

(limited to 'docs')

diff --git a/docs/application_services.rst b/docs/application_services.rst
new file mode 100644
index 0000000000..07236e62ae
--- /dev/null
+++ b/docs/application_services.rst
@@ -0,0 +1,26 @@
+Registering an Application Service
+==================================
+
+The registration of new application services is implementation dependent. In
+synapse you need to create a new configuration file for you AS and add it to
+the list of AS's specified under ``app_service_config_files`` synapse
+config option.
+
+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 ad to requests to AS>
+    sender_localpart: <localpart of AS user>
+    namespaces:
+      users:  # List of users we're interested in
+        - exclusive: <bool>
+          regex: <regex>
+        - ...
+      aliases: []  # List of aliases we're interested in
+      rooms: [] # List of room ids we're interested in
+
+See the spec_ for further details on how application services work.
+
+.. _spec: https://github.com/matrix-org/matrix-doc/blob/master/specification/25_application_service_api.rst#application-service-api
+
-- 
cgit 1.4.1