diff options
author | dstipp <dstipp@users.noreply.github.com> | 2019-09-17 07:55:29 -0400 |
---|---|---|
committer | Richard van der Hoff <1389908+richvdh@users.noreply.github.com> | 2019-09-17 12:55:29 +0100 |
commit | 379d2a8c3918557bacdadea6b508bddd1ce20eaf (patch) | |
tree | 8b8e3b016ce54d9d2e76a598931322ee7bd79754 /docs/application_services.md | |
parent | Fix race condition in room stats. (#6029) (diff) | |
download | synapse-379d2a8c3918557bacdadea6b508bddd1ce20eaf.tar.xz |
(#5849) Convert rst to markdown (#6040)
Converting some of the rst documentation to markdown. Attempted to preserve whitespace and line breaks to minimize cosmetic change.
Diffstat (limited to 'docs/application_services.md')
-rw-r--r-- | docs/application_services.md | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/docs/application_services.md b/docs/application_services.md new file mode 100644 index 0000000000..06cb79f1f9 --- /dev/null +++ b/docs/application_services.md @@ -0,0 +1,31 @@ +# 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> + - ... + aliases: [] # List of aliases we're interested in + rooms: [] # List of room ids we're interested in +``` + +See the [spec](https://matrix.org/docs/spec/application_service/unstable.html) for further details on how application services work. |