Added config section for state compressor

1 files changed, 19 insertions, 0 deletions

diff --git a/docs/sample_config.yaml b/docs/sample_config.yaml

index 95cca16552..1ca4557b0f 100644
--- a/docs/sample_config.yaml
+++ b/docs/sample_config.yaml
@@ -2644,3 +2644,22 @@ redis:
   # Optional password if configured on the Redis instance
   #
   #password: <secret_password>
+
+
+# The state compressor is an experimental tool which attempts to 
+# reduce the number of rows in the state_groups_state table
+# of postgres databases.
+#
+# For more information please see
+# https://matrix-org.github.io/synapse/latest/state_compressor.html
+# 
+state_compressor:
+#       enabled: true
+#       # The (rough) number of state groups to load at one time
+#       chunk_size: 500
+#       # The number of rooms to compress on each run
+#       number_of_rooms: 5
+#       # The default level sizes for the compressor to use
+#       default_levels: 100,50,25
+#       # How frequently to run the state compressor
+#       time_between_runs: 1d