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

Commit 86615aa

Browse files
authored
Fix up docs for track_puppeted_user_ips (again) (#11757)
Fixes #11741
1 parent b0352f9 commit 86615aa

File tree

5 files changed

+27
-10
lines changed

5 files changed

+27
-10
lines changed

changelog.d/11561.feature

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
Add `track_puppeted_user_ips` config flag to track puppeted user IP addresses. This also includes them in monthly active user counts.
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.

changelog.d/11749.feature

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
Add `track_puppeted_user_ips` config flag to track puppeted user IP addresses. This also includes them in monthly active user counts.
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.

changelog.d/11757.feature

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
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.

docs/sample_config.yaml

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1503,10 +1503,18 @@ room_prejoin_state:
15031503
#additional_event_types:
15041504
# - org.example.custom.event.type
15051505

1506-
# By default when puppeting another user, the user who has created the
1507-
# access token for puppeting is tracked. If this is enabled, both
1508-
# requests are tracked. Implicitly enables MAU tracking for puppeted users.
1509-
# Uncomment to also track puppeted user IP's.
1506+
# We record the IP address of clients used to access the API for various
1507+
# reasons, including displaying it to the user in the "Where you're signed in"
1508+
# dialog.
1509+
#
1510+
# By default, when puppeting another user via the admin API, the client IP
1511+
# address is recorded against the user who created the access token (ie, the
1512+
# admin user), and *not* the puppeted user.
1513+
#
1514+
# Uncomment the following to also record the IP address against the puppeted
1515+
# user. (This also means that the puppeted user will count as an "active" user
1516+
# for the purpose of monthly active user tracking - see 'limit_usage_by_mau' etc
1517+
# above.)
15101518
#
15111519
#track_puppeted_user_ips: true
15121520

synapse/config/api.py

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -61,10 +61,18 @@ def generate_config_section(cls, **kwargs) -> str:
6161
#additional_event_types:
6262
# - org.example.custom.event.type
6363
64-
# By default when puppeting another user, the user who has created the
65-
# access token for puppeting is tracked. If this is enabled, both
66-
# requests are tracked. Implicitly enables MAU tracking for puppeted users.
67-
# Uncomment to also track puppeted user IP's.
64+
# We record the IP address of clients used to access the API for various
65+
# reasons, including displaying it to the user in the "Where you're signed in"
66+
# dialog.
67+
#
68+
# By default, when puppeting another user via the admin API, the client IP
69+
# address is recorded against the user who created the access token (ie, the
70+
# admin user), and *not* the puppeted user.
71+
#
72+
# Uncomment the following to also record the IP address against the puppeted
73+
# user. (This also means that the puppeted user will count as an "active" user
74+
# for the purpose of monthly active user tracking - see 'limit_usage_by_mau' etc
75+
# above.)
6876
#
6977
#track_puppeted_user_ips: true
7078
""" % {

0 commit comments

Comments
 (0)