Document the --report-stats argument (matrix-org#13029)

Signed-off-by: jejo86 <[email protected]>
richtera · Jun 29, 2022 · cdc0259 · cdc0259
1 parent 79c6b9e
commit cdc0259
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/changelog.d/13029.doc b/changelog.d/13029.doc
@@ -0,0 +1 @@
+Add an explanation of the `--report-stats` argument to the docs.
diff --git a/docs/setup/installation.md b/docs/setup/installation.md
@@ -232,7 +232,9 @@ python -m synapse.app.homeserver \
     --report-stats=[yes|no]
 ```
 
-... substituting an appropriate value for `--server-name`.
+... substituting an appropriate value for `--server-name` and choosing whether
+or not to report usage statistics (hostname, Synapse version, uptime, total
+users, etc.) to the developers via the `--report-stats` argument.
 
 This command will generate you a config file that you can then customise, but it will
 also generate a set of keys for you. These keys will allow your homeserver to
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Add an explanation of the `--report-stats` argument to the docs.