Skip to content

Commit 95296f9

Browse files
committed
Default homeserver usage statistics to on
1 parent 5fe5577 commit 95296f9

4 files changed

Lines changed: 36 additions & 1 deletion

File tree

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Copyright 2026 Element Creations Ltd
2+
#
3+
# SPDX-License-Identifier: AGPL-3.0-only
4+
5+
synapse:
6+
additional:
7+
disable-usage-statistics.yaml:
8+
config: |
9+
report_stats: false

charts/matrix-stack/configs/synapse/synapse-01-shared-underrides.yaml.tpl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ SPDX-License-Identifier: AGPL-3.0-only
1010
web_client_location: https://{{ $root.Values.elementWeb.ingress.host }}/
1111
{{- end }}
1212

13-
report_stats: false
13+
report_stats: true
1414

1515
require_auth_for_profile_requests: true
1616

docs/advanced.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ SPDX-License-Identifier: AGPL-3.0-only
1616
- [Configuring Element Web](#configuring-element-web)
1717
- [Configuring Hookshot](#configuring-hookshot)
1818
- [Configuring Synapse](#configuring-synapse)
19+
- [Worked example: disabling homeserver usage statistics](#worked-example-disabling-homeserver-usage-statistics)
1920
- [Configuring Matrix Authentication Service](#configuring-matrix-authentication-service)
2021
- [Configuring Matrix RTC](#configuring-matrix-rtc)
2122
- [Networking](#networking)
@@ -169,6 +170,19 @@ One common Synapse configuration option that can't be set by this mechanism is `
169170
This is controlled by `synapse.media.maxUploadSize`.
170171
This is so that Ingress controller specific annotations can be adjusted to match.
171172

173+
#### Worked example: disabling homeserver usage statistics
174+
175+
By default ESS Community submits [homeserver usage statistics](https://element-hq.github.io/synapse/latest/usage/administration/monitoring/reporting_homeserver_usage_statistics.html).
176+
[`charts/matrix-stack/ci/fragments/synapse-disable-usage-statistics.yaml`] or below show how these can be disabled:
177+
178+
```yml
179+
synapse:
180+
additional:
181+
disable-usage-statistics.yaml:
182+
config: |
183+
report_stats: false
184+
```
185+
172186
### Configuring Matrix Authentication Service
173187

174188
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).

newsfragments/1263.changed.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
Report homeserver usage statistics by default.
2+
3+
[Reporting Homeserver usage statistics](https://element-hq.github.io/synapse/latest/usage/administration/monitoring/reporting_homeserver_usage_statistics.html) documents what information is collected
4+
5+
This can be opted out of with the below or `charts/matrix-stack/ci/fragments/synapse-disable-usage-statistics.yaml`:
6+
```yaml
7+
synapse:
8+
additional:
9+
disable-usage-statistics.yaml:
10+
config: |
11+
report_stats: false
12+
```

0 commit comments

Comments
 (0)