Fix sample_config.yaml in regards track_puppeted_user_ips (#11749)

* Fix sample_config.yaml in regards track_puppeted_user_ips

Closes #11741

Signed-off-by: Jason Robinson <jasonr@matrix.org>

1 files changed, 6 insertions, 5 deletions

diff --git a/synapse/config/api.py b/synapse/config/api.py

index bdbe9f0fa2..f8e52150a2 100644
--- a/synapse/config/api.py
+++ b/synapse/config/api.py
@@ -61,11 +61,12 @@ class ApiConfig(Config):
            #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
         }