Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Fix sample_config.yaml in regards track_puppeted_user_ips #11749

Merged
merged 5 commits into from
Jan 14, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions changelog.d/11749.feature
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Add `track_puppeted_user_ips` config flag to track puppeted user IP addresses. This also includes them in monthly active user counts.
11 changes: 6 additions & 5 deletions docs/sample_config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1503,11 +1503,12 @@ room_prejoin_state:
#additional_event_types:
# - org.example.custom.event.type

# If enabled, puppeted user IP's can also be tracked. By default when
# puppeting another user, the user who has created the access token
# for puppeting is tracked. If this is enabled, both requests are tracked.
# Implicitly enables MAU tracking for puppeted users.
#track_puppeted_user_ips: false
# By default when puppeting another user, the user who has created the
# access token for puppeting is tracked. If this is enabled, both
# requests are tracked. Implicitly enables MAU tracking for puppeted users.
# Uncomment to also track puppeted user IP's.
#
#track_puppeted_user_ips: true


# A list of application service config files to use
Expand Down
11 changes: 6 additions & 5 deletions synapse/config/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -61,11 +61,12 @@ def generate_config_section(cls, **kwargs) -> str:
#additional_event_types:
# - org.example.custom.event.type

# If enabled, puppeted user IP's can also be tracked. By default when
# puppeting another user, the user who has created the access token
# for puppeting is tracked. If this is enabled, both requests are tracked.
# Implicitly enables MAU tracking for puppeted users.
#track_puppeted_user_ips: false
# By default when puppeting another user, the user who has created the
# access token for puppeting is tracked. If this is enabled, both
# requests are tracked. Implicitly enables MAU tracking for puppeted users.
# Uncomment to also track puppeted user IP's.
#
#track_puppeted_user_ips: true
""" % {
"formatted_default_state_types": formatted_default_state_types
}
Expand Down