|
|
|
@ -43,6 +43,8 @@ matrix_synapse_workers_generic_worker_endpoints:
|
|
|
|
|
- ^/_matrix/client/(api/v1|r0|v3|unstable)/rooms/.*/members$
|
|
|
|
|
- ^/_matrix/client/(api/v1|r0|v3|unstable)/rooms/.*/state$
|
|
|
|
|
- ^/_matrix/client/v1/rooms/.*/hierarchy$
|
|
|
|
|
- ^/_matrix/client/(v1|unstable)/rooms/.*/relations/
|
|
|
|
|
- ^/_matrix/client/v1/rooms/.*/threads$
|
|
|
|
|
- ^/_matrix/client/unstable/org.matrix.msc2716/rooms/.*/batch_send$
|
|
|
|
|
- ^/_matrix/client/unstable/im.nheko.summary/rooms/.*/summary$
|
|
|
|
|
- ^/_matrix/client/(r0|v3|unstable)/account/3pid$
|
|
|
|
@ -136,8 +138,9 @@ matrix_synapse_workers_generic_worker_endpoints:
|
|
|
|
|
# [#7530](https://github.com/matrix-org/synapse/issues/7530) and
|
|
|
|
|
# [#9427](https://github.com/matrix-org/synapse/issues/9427).
|
|
|
|
|
|
|
|
|
|
# Note that a HTTP listener with `client` and `federation` resources must be
|
|
|
|
|
# configured in the `worker_listeners` option in the worker config.
|
|
|
|
|
# Note that a [HTTP listener](usage/configuration/config_documentation.md#listeners)
|
|
|
|
|
# with `client` and `federation` `resources` must be configured in the `worker_listeners`
|
|
|
|
|
# option in the worker config.
|
|
|
|
|
|
|
|
|
|
# #### Load balancing
|
|
|
|
|
|
|
|
|
@ -177,7 +180,8 @@ matrix_synapse_workers_generic_worker_endpoints:
|
|
|
|
|
# Additionally, the writing of specific streams (such as events) can be moved off
|
|
|
|
|
# of the main process to a particular worker.
|
|
|
|
|
|
|
|
|
|
# To enable this, the worker must have a HTTP replication listener configured,
|
|
|
|
|
# To enable this, the worker must have a
|
|
|
|
|
# [HTTP `replication` listener](usage/configuration/config_documentation.md#listeners) configured,
|
|
|
|
|
# have a `worker_name` and be listed in the `instance_map` config. The same worker
|
|
|
|
|
# can handle multiple streams, but unless otherwise documented, each stream can only
|
|
|
|
|
# have a single writer.
|
|
|
|
@ -266,7 +270,7 @@ matrix_synapse_workers_generic_worker_endpoints:
|
|
|
|
|
# There is also support for moving background tasks to a separate
|
|
|
|
|
# worker. Background tasks are run periodically or started via replication. Exactly
|
|
|
|
|
# which tasks are configured to run depends on your Synapse configuration (e.g. if
|
|
|
|
|
# stats is enabled).
|
|
|
|
|
# stats is enabled). This worker doesn't handle any REST endpoints itself.
|
|
|
|
|
|
|
|
|
|
# To enable this, the worker must have a `worker_name` and can be configured to run
|
|
|
|
|
# background tasks. For example, to move background tasks to a dedicated worker,
|
|
|
|
@ -314,8 +318,8 @@ matrix_synapse_workers_generic_worker_endpoints:
|
|
|
|
|
# #### Notifying Application Services
|
|
|
|
|
|
|
|
|
|
# You can designate one generic worker to send output traffic to Application Services.
|
|
|
|
|
|
|
|
|
|
# Specify its name in the shared configuration as follows:
|
|
|
|
|
# Doesn't handle any REST endpoints itself, but you should specify its name in the
|
|
|
|
|
# shared configuration as follows:
|
|
|
|
|
|
|
|
|
|
# ```yaml
|
|
|
|
|
# notify_appservices_from_worker: worker_name
|
|
|
|
@ -342,6 +346,12 @@ matrix_synapse_workers_generic_worker_endpoints:
|
|
|
|
|
# - pusher_worker2
|
|
|
|
|
# ```
|
|
|
|
|
|
|
|
|
|
# An example for a pusher instance:
|
|
|
|
|
|
|
|
|
|
# ```yaml
|
|
|
|
|
# {{#include systemd-with-workers/workers/pusher_worker.yaml}}
|
|
|
|
|
# ```
|
|
|
|
|
|
|
|
|
|
# ]
|
|
|
|
|
|
|
|
|
|
# appservice worker (no API endpoints) [
|
|
|
|
@ -371,6 +381,12 @@ matrix_synapse_workers_generic_worker_endpoints:
|
|
|
|
|
# - federation_sender1
|
|
|
|
|
# - federation_sender2
|
|
|
|
|
# ```
|
|
|
|
|
|
|
|
|
|
# An example for a federation sender instance:
|
|
|
|
|
|
|
|
|
|
# ```yaml
|
|
|
|
|
# {{#include systemd-with-workers/workers/federation_sender.yaml}}
|
|
|
|
|
# ```
|
|
|
|
|
# ]
|
|
|
|
|
|
|
|
|
|
matrix_synapse_workers_media_repository_endpoints:
|
|
|
|
@ -392,16 +408,12 @@ matrix_synapse_workers_media_repository_endpoints:
|
|
|
|
|
# media repository. Note that doing so will prevent the main process from being
|
|
|
|
|
# able to handle the above endpoints.
|
|
|
|
|
|
|
|
|
|
# In the `media_repository` worker configuration file, configure the http listener to
|
|
|
|
|
# In the `media_repository` worker configuration file, configure the
|
|
|
|
|
# [HTTP listener](usage/configuration/config_documentation.md#listeners) to
|
|
|
|
|
# expose the `media` resource. For example:
|
|
|
|
|
|
|
|
|
|
# ```yaml
|
|
|
|
|
# worker_listeners:
|
|
|
|
|
# - type: http
|
|
|
|
|
# port: 8085
|
|
|
|
|
# resources:
|
|
|
|
|
# - names:
|
|
|
|
|
# - media
|
|
|
|
|
# {{#include systemd-with-workers/workers/media_worker.yaml}}
|
|
|
|
|
# ```
|
|
|
|
|
|
|
|
|
|
# Note that if running multiple media repositories they must be on the same server
|
|
|
|
|