synapse/docs/application_services.rst

27 lines
990 B
ReStructuredText
Raw Normal View History

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