Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.

Commit cdc0259

Browse files
authored
Document the --report-stats argument (#13029)
Signed-off-by: jejo86 <[email protected]>
1 parent 79c6b9e commit cdc0259

File tree

2 files changed

+4
-1
lines changed

2 files changed

+4
-1
lines changed

changelog.d/13029.doc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Add an explanation of the `--report-stats` argument to the docs.

docs/setup/installation.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -232,7 +232,9 @@ python -m synapse.app.homeserver \
232232
--report-stats=[yes|no]
233233
```
234234

235-
... substituting an appropriate value for `--server-name`.
235+
... substituting an appropriate value for `--server-name` and choosing whether
236+
or not to report usage statistics (hostname, Synapse version, uptime, total
237+
users, etc.) to the developers via the `--report-stats` argument.
236238

237239
This command will generate you a config file that you can then customise, but it will
238240
also generate a set of keys for you. These keys will allow your homeserver to

0 commit comments

Comments
 (0)