Better complement docs (#16946)

element-hq · Feb 20, 2024 · 0c55c76 · 0c55c76
1 parent 3eb0a3b
commit 0c55c76
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/changelog.d/16946.doc b/changelog.d/16946.doc
@@ -0,0 +1 @@
+Improve the documentation around running Complement tests with new configuration parameters.
diff --git 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`).