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

Commit

Permalink
Fix up docs for track_puppeted_user_ips (again) (#11757)
Browse files Browse the repository at this point in the history
Fixes #11741
  • Loading branch information
richvdh authored Jan 17, 2022
1 parent b0352f9 commit 86615aa
Show file tree
Hide file tree
Showing 5 changed files with 27 additions and 10 deletions.
2 changes: 1 addition & 1 deletion changelog.d/11561.feature
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Add `track_puppeted_user_ips` config flag to track puppeted user IP addresses. This also includes them in monthly active user counts.
Add `track_puppeted_user_ips` config flag to record client IP addresses against puppeted users, and include the puppeted users in monthly active user counts.
2 changes: 1 addition & 1 deletion changelog.d/11749.feature
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Add `track_puppeted_user_ips` config flag to track puppeted user IP addresses. This also includes them in monthly active user counts.
Add `track_puppeted_user_ips` config flag to record client IP addresses against puppeted users, and include the puppeted users in monthly active user counts.
1 change: 1 addition & 0 deletions changelog.d/11757.feature
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Add `track_puppeted_user_ips` config flag to record client IP addresses against puppeted users, and include the puppeted users in monthly active user counts.
16 changes: 12 additions & 4 deletions docs/sample_config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1503,10 +1503,18 @@ room_prejoin_state:
#additional_event_types:
# - org.example.custom.event.type

# 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.
# We record the IP address of clients used to access the API for various
# reasons, including displaying it to the user in the "Where you're signed in"
# dialog.
#
# By default, when puppeting another user via the admin API, the client IP
# address is recorded against the user who created the access token (ie, the
# admin user), and *not* the puppeted user.
#
# Uncomment the following to also record the IP address against the puppeted
# user. (This also means that the puppeted user will count as an "active" user
# for the purpose of monthly active user tracking - see 'limit_usage_by_mau' etc
# above.)
#
#track_puppeted_user_ips: true

Expand Down
16 changes: 12 additions & 4 deletions synapse/config/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -61,10 +61,18 @@ def generate_config_section(cls, **kwargs) -> str:
#additional_event_types:
# - org.example.custom.event.type
# 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.
# We record the IP address of clients used to access the API for various
# reasons, including displaying it to the user in the "Where you're signed in"
# dialog.
#
# By default, when puppeting another user via the admin API, the client IP
# address is recorded against the user who created the access token (ie, the
# admin user), and *not* the puppeted user.
#
# Uncomment the following to also record the IP address against the puppeted
# user. (This also means that the puppeted user will count as an "active" user
# for the purpose of monthly active user tracking - see 'limit_usage_by_mau' etc
# above.)
#
#track_puppeted_user_ips: true
""" % {
Expand Down

0 comments on commit 86615aa

Please sign in to comment.