diff options
| author | realtyem <realtyem@gmail.com> | 2022-11-08 06:34:09 -0600 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-11-08 12:34:09 +0000 |
| commit | 69814eb2824daf846f869cb9579eb1008e61f8ad (patch) | |
| tree | ea4a4057a1505b1ad0cd01b55874fb135c4038f2 /docs | |
| parent | Correctly create power level event during initial room creation (#14361) (diff) | |
| download | synapse-69814eb2824daf846f869cb9579eb1008e61f8ad.tar.xz | |
Allow override for requesting specific worker types for Complement on command line. (#14324)
* Expose getting SYNAPSE_WORKER_TYPES from external, allowing override of workers requested. * Add WORKER_TYPES variable option to complement.sh script that passes requested workers into start_for_complement.sh entrypoint. * Update docs to reflect this new ability. * Changelog * Don't rely on soft wrapping to format long strings Good idea dklimpel. Thanks for catching that. Co-authored-by: Dirk Klimpel <5740567+dklimpel@users.noreply.github.com> * Small nits just noticed in docs. * Fixup new line in docs. Co-authored-by: Dirk Klimpel <5740567+dklimpel@users.noreply.github.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/development/contributing_guide.md | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/development/contributing_guide.md b/docs/development/contributing_guide.md index 1e52f9808c..342bc1d340 100644 --- a/docs/development/contributing_guide.md +++ b/docs/development/contributing_guide.md @@ -324,6 +324,12 @@ The above will run a monolithic (single-process) Synapse with SQLite as the data - Passing `POSTGRES=1` as an environment variable to use the Postgres database instead. - Passing `WORKERS=1` as an environment variable to use a workerised setup instead. This option implies the use of Postgres. + - If setting `WORKERS=1`, optionally set `WORKER_TYPES=` to declare which worker + types you wish to test. A simple comma-delimited string containing the worker types + defined from the `WORKERS_CONFIG` template in + [here](https://github.com/matrix-org/synapse/blob/develop/docker/configure_workers_and_start.py#L54). + A safe example would be `WORKER_TYPES="federation_inbound, federation_sender, synchrotron"`. + See the [worker documentation](../workers.md) for additional information on workers. To increase the log level for the tests, set `SYNAPSE_TEST_LOG_LEVEL`, e.g: ```sh |