synapse-old/docs/application_services.rst

36 lines
1.1 KiB
ReStructuredText
Raw Normal View History

Registering an Application Service
==================================
2015-05-07 11:54:53 -06:00
The registration of new application services depends on the homeserver used.
2015-05-07 11:58:28 -06:00
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
2015-05-07 11:54:53 -06:00
option in your synapse config.
2015-05-07 11:58:28 -06:00
For example:
.. code-block:: yaml
app_service_config_files:
- /home/matrix/.synapse/<your-AS>.yaml
2015-05-07 11:54:53 -06:00
The format of the AS configuration file is as follows:
.. code-block:: yaml
url: <base url of AS>
as_token: <token AS will add to requests to HS>
2015-05-09 07:45:37 -06:00
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_ for further details on how application services work.
2016-05-23 09:29:38 -06:00
.. _spec: https://matrix.org/docs/spec/application_service/unstable.html