Add documentation about Telemetry configuration
This commit is contained in:
parent
099558bee8
commit
f364e080be
14
docs/configuring-playbook-telemetry.md
Normal file
14
docs/configuring-playbook-telemetry.md
Normal file
|
@ -0,0 +1,14 @@
|
||||||
|
# Enabling Telemetry for your Matrix server
|
||||||
|
|
||||||
|
By default, this playbook configures your Matrix homeserver to not send any telemetry data anywhere.
|
||||||
|
|
||||||
|
The [matrix.org](https://matrix.org) team would really appreciate it if you could help the project out by reporting
|
||||||
|
anonymized usage statistics from your homeserver. Only very basic aggregate
|
||||||
|
data (e.g. number of users) will be reported, but it helps track the
|
||||||
|
growth of the Matrix community, and helps to make Matrix a success.
|
||||||
|
|
||||||
|
If you'd like to **help by enabling submission of anonymized usage statistics** for your homeserver, add this to your configuration file (`inventory/matrix.<your-domain>/vars.yml`):
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
matrix_synapse_report_stats: true
|
||||||
|
```
|
|
@ -23,6 +23,8 @@ When you're done with all the configuration you'd like to do, continue with [Ins
|
||||||
|
|
||||||
## Other configuration options
|
## Other configuration options
|
||||||
|
|
||||||
|
- [Enabling Telemetry for your Matrix server](configuring-playbook-telemetry.md) (optional)
|
||||||
|
|
||||||
- [Controlling Matrix federation](configuring-playbook-federation) (optional)
|
- [Controlling Matrix federation](configuring-playbook-federation) (optional)
|
||||||
|
|
||||||
- [Adjusting email-sending settings](configuring-playbook-email.md) (optional)
|
- [Adjusting email-sending settings](configuring-playbook-email.md) (optional)
|
||||||
|
|
Loading…
Reference in a new issue