Document the `--report-stats` argument (#13029)

Signed-off-by: jejo86 <28619134+jejo86@users.noreply.github.com>
This commit is contained in:
jejo86 2022-06-29 11:24:10 +02:00 committed by GitHub
parent 79c6b9e12b
commit cdc0259449
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 4 additions and 1 deletions

1
changelog.d/13029.doc Normal file
View File

@ -0,0 +1 @@
Add an explanation of the `--report-stats` argument to the docs.

View File

@ -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