From 86615aa965a04dc4c16ff28ee5b82cbe65a83530 Mon Sep 17 00:00:00 2001
From: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
Date: Mon, 17 Jan 2022 14:55:30 +0000
Subject: Fix up docs for `track_puppeted_user_ips` (again) (#11757)

Fixes #11741
---
 synapse/config/api.py | 16 ++++++++++++----
 1 file changed, 12 insertions(+), 4 deletions(-)

(limited to 'synapse/config/api.py')

diff --git a/synapse/config/api.py b/synapse/config/api.py
index f8e52150a2..8133b6b624 100644
--- a/synapse/config/api.py
+++ b/synapse/config/api.py
@@ -61,10 +61,18 @@ class ApiConfig(Config):
            #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
         """ % {
-- 
cgit 1.4.1