Skip to content

Default homeserver usage statistics to on #1263

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
benbz wants to merge 1 commit into
base: main
Choose a base branch
from
+36 −1
Draft

Default homeserver usage statistics to on #1263

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions charts/matrix-stack/ci/fragments/synapse-disable-usage-statistics.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion charts/matrix-stack/configs/synapse/synapse-01-shared-underrides.yaml.tpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
14 changes: 14 additions & 0 deletions docs/advanced.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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).
Expand Down
12 changes: 12 additions & 0 deletions newsfragments/1263.changed.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
```
Loading