diff --git a/charts/matrix-stack/ci/fragments/synapse-disable-usage-statistics.yaml b/charts/matrix-stack/ci/fragments/synapse-disable-usage-statistics.yaml new file mode 100644 index 000000000..ad9f49258 --- /dev/null +++ b/charts/matrix-stack/ci/fragments/synapse-disable-usage-statistics.yaml @@ -0,0 +1,9 @@ +# Copyright 2026 Element Creations Ltd +# +# SPDX-License-Identifier: AGPL-3.0-only + +synapse: + additional: + disable-usage-statistics.yaml: + config: | + report_stats: false diff --git a/charts/matrix-stack/configs/synapse/synapse-01-shared-underrides.yaml.tpl b/charts/matrix-stack/configs/synapse/synapse-01-shared-underrides.yaml.tpl index 287ed7ffb..df5afb93b 100644 --- a/charts/matrix-stack/configs/synapse/synapse-01-shared-underrides.yaml.tpl +++ b/charts/matrix-stack/configs/synapse/synapse-01-shared-underrides.yaml.tpl @@ -10,7 +10,7 @@ SPDX-License-Identifier: AGPL-3.0-only web_client_location: https://{{ $root.Values.elementWeb.ingress.host }}/ {{- end }} -report_stats: false +report_stats: true require_auth_for_profile_requests: true diff --git a/docs/advanced.md b/docs/advanced.md index 5cb9beb6c..81b6d7837 100644 --- a/docs/advanced.md +++ b/docs/advanced.md @@ -16,6 +16,7 @@ SPDX-License-Identifier: AGPL-3.0-only - [Configuring Element Web](#configuring-element-web) - [Configuring Hookshot](#configuring-hookshot) - [Configuring Synapse](#configuring-synapse) + - [Worked example: disabling homeserver usage statistics](#worked-example-disabling-homeserver-usage-statistics) - [Configuring Matrix Authentication Service](#configuring-matrix-authentication-service) - [Configuring Matrix RTC](#configuring-matrix-rtc) - [Networking](#networking) @@ -169,6 +170,19 @@ One common Synapse configuration option that can't be set by this mechanism is ` This is controlled by `synapse.media.maxUploadSize`. This is so that Ingress controller specific annotations can be adjusted to match. +#### Worked example: disabling homeserver usage statistics + +By default ESS Community submits [homeserver usage statistics](https://element-hq.github.io/synapse/latest/usage/administration/monitoring/reporting_homeserver_usage_statistics.html). +[`charts/matrix-stack/ci/fragments/synapse-disable-usage-statistics.yaml`] or below show how these can be disabled: + +```yml +synapse: + additional: + disable-usage-statistics.yaml: + config: | + report_stats: false +``` + ### Configuring Matrix Authentication Service Matrix Authentication Service configuration is written in YAML. The documentation can be found [here](https://element-hq.github.io/matrix-authentication-service/reference/configuration.html). diff --git a/newsfragments/1263.changed.md b/newsfragments/1263.changed.md new file mode 100644 index 000000000..621b8798a --- /dev/null +++ b/newsfragments/1263.changed.md @@ -0,0 +1,12 @@ +Report homeserver usage statistics by default. + +[Reporting Homeserver usage statistics](https://element-hq.github.io/synapse/latest/usage/administration/monitoring/reporting_homeserver_usage_statistics.html) documents what information is collected + +This can be opted out of with the below or `charts/matrix-stack/ci/fragments/synapse-disable-usage-statistics.yaml`: +```yaml +synapse: + additional: + disable-usage-statistics.yaml: + config: | + report_stats: false +```