Mention that you need to configure max upload size in reverse proxy a…

…s well (#10122) Signed-off-by: Aaron Raimist <aaron@raim.ist>
matrix-org · Jun 10, 2021 · e6245e6 · e6245e6
1 parent aec2cf1
commit e6245e6
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 0 deletions.
diff --git a/changelog.d/10122.doc b/changelog.d/10122.doc
@@ -0,0 +1 @@
+Mention in the sample homeserver config that you may need to configure max upload size in your reverse proxy. Contributed by @aaronraimist.
diff --git a/docs/sample_config.yaml b/docs/sample_config.yaml
@@ -954,6 +954,10 @@ media_store_path: "DATADIR/media_store"
 
 # The largest allowed upload size in bytes
 #
+# If you are using a reverse proxy you may also need to set this value in
+# your reverse proxy's config. Notably Nginx has a small max body size by default.
+# See https://matrix-org.github.io/synapse/develop/reverse_proxy.html.
+#
 #max_upload_size: 50M
 
 # Maximum number of pixels that will be thumbnailed

diff --git a/synapse/config/repository.py b/synapse/config/repository.py
@@ -248,6 +248,10 @@ def generate_config_section(self, data_dir_path, **kwargs):
 
         # The largest allowed upload size in bytes
         #
+        # If you are using a reverse proxy you may also need to set this value in
+        # your reverse proxy's config. Notably Nginx has a small max body size by default.
+        # See https://matrix-org.github.io/synapse/develop/reverse_proxy.html.
+        #
         #max_upload_size: 50M
 
         # Maximum number of pixels that will be thumbnailed
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Mention in the sample homeserver config that you may need to configure max upload size in your reverse proxy. Contributed by @aaronraimist.