diff options
| author | kegsay <7190048+kegsay@users.noreply.github.com> | 2024-02-20 17:14:50 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-02-20 17:14:50 +0000 |
| commit | 0c55c76da807c8ca0c37b7394594d3757ffab8a6 (patch) | |
| tree | 1f956e06ffb5caa3fce3a7542931fd81d6183ecd | |
| parent | Merge branch 'release-v1.102' into develop (diff) | |
| download | synapse-0c55c76da807c8ca0c37b7394594d3757ffab8a6.tar.xz | |
Better complement docs (#16946)
| -rw-r--r-- | changelog.d/16946.doc | 1 | ||||
| -rw-r--r-- | docker/complement/README.md | 11 |
2 files changed, 12 insertions, 0 deletions
diff --git a/changelog.d/16946.doc b/changelog.d/16946.doc new file mode 100644 index 0000000000..8037a65450 --- /dev/null +++ b/changelog.d/16946.doc @@ -0,0 +1 @@ +Improve the documentation around running Complement tests with new configuration parameters. \ No newline at end of file diff --git a/docker/complement/README.md b/docker/complement/README.md index 62682219e8..1ce8412818 100644 --- a/docker/complement/README.md +++ b/docker/complement/README.md @@ -30,3 +30,14 @@ Consult `scripts-dev/complement.sh` in the repository root for a real example. [complement]: https://github.com/matrix-org/complement [complementEnv]: https://github.com/matrix-org/complement/pull/382 + +## How to modify homeserver.yaml for Complement tests + +It's common for MSCs to be gated behind a feature flag like this: +```yaml +experimental_features: + faster_joins: true +``` +To modify this for the Complement image, modify `./conf/workers-shared-extra.yaml.j2`. Despite the name, +this will affect non-worker mode as well. Remember to _rebuild_ the image (so don't use `-e` if using +`complement.sh`). |