From f364e080be08f7578bd83daa570c307baa83f1c6 Mon Sep 17 00:00:00 2001 From: Slavi Pantaleev Date: Thu, 1 Nov 2018 18:21:38 +0200 Subject: [PATCH] Add documentation about Telemetry configuration --- docs/configuring-playbook-telemetry.md | 14 ++++++++++++++ docs/configuring-playbook.md | 2 ++ 2 files changed, 16 insertions(+) create mode 100644 docs/configuring-playbook-telemetry.md diff --git a/docs/configuring-playbook-telemetry.md b/docs/configuring-playbook-telemetry.md new file mode 100644 index 00000000..cd63f0ca --- /dev/null +++ b/docs/configuring-playbook-telemetry.md @@ -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./vars.yml`): + +```yaml +matrix_synapse_report_stats: true +``` diff --git a/docs/configuring-playbook.md b/docs/configuring-playbook.md index c073e2c9..c15b608e 100644 --- a/docs/configuring-playbook.md +++ b/docs/configuring-playbook.md @@ -23,6 +23,8 @@ When you're done with all the configuration you'd like to do, continue with [Ins ## Other configuration options +- [Enabling Telemetry for your Matrix server](configuring-playbook-telemetry.md) (optional) + - [Controlling Matrix federation](configuring-playbook-federation) (optional) - [Adjusting email-sending settings](configuring-playbook-email.md) (optional)