application_services.rst 1.1 KB

123456789101112131415161718192021222324252627282930313233343536
  1. Registering an Application Service
  2. ==================================
  3. The registration of new application services depends on the homeserver used.
  4. In synapse, you need to create a new configuration file for your AS and add it
  5. to the list specified under the ``app_service_config_files`` config
  6. option in your synapse config.
  7. For example:
  8. .. code-block:: yaml
  9. app_service_config_files:
  10. - /home/matrix/.synapse/<your-AS>.yaml
  11. The format of the AS configuration file is as follows:
  12. .. code-block:: yaml
  13. url: <base url of AS>
  14. as_token: <token AS will add to requests to HS>
  15. hs_token: <token HS will add to requests to AS>
  16. sender_localpart: <localpart of AS user>
  17. namespaces:
  18. users: # List of users we're interested in
  19. - exclusive: <bool>
  20. regex: <regex>
  21. - ...
  22. aliases: [] # List of aliases we're interested in
  23. rooms: [] # List of room ids we're interested in
  24. See the spec_ for further details on how application services work.
  25. .. _spec: https://github.com/matrix-org/matrix-doc/blob/master/specification/25_application_service_api.rst#application-service-api