summary refs log tree commit diff
path: root/docs/sample_config.yaml
diff options
context:
space:
mode:
authorJason Robinson <jasonr@element.io>2022-01-12 18:09:36 +0200
committerGitHub <noreply@github.com>2022-01-12 16:09:36 +0000
commit2560b1b6b2f74b5724253396c0e3665fa1f7968c (patch)
treefca16f002a9b0b287afab75dc7e0a35deb23087f /docs/sample_config.yaml
parentFix documentation of supported PostgreSQL version (#11725) (diff)
downloadsynapse-2560b1b6b2f74b5724253396c0e3665fa1f7968c.tar.xz
Allow tracking puppeted users for MAU (#11561)
Currently when puppeting another user, the user doing the puppeting is
tracked for client IPs and MAU (if configured).

When tracking MAU is important, it becomes necessary to be possible to
also track the client IPs and MAU of puppeted users. As an example a
client that manages user creation and creation of tokens via the Synapse
admin API, passing those tokens for the client to use.

This PR adds optional configuration to enable tracking of puppeted users
into monthly active users. The default behaviour stays the same.

Signed-off-by: Jason Robinson <jasonr@matrix.org>
Diffstat (limited to 'docs/sample_config.yaml')
-rw-r--r--docs/sample_config.yaml6
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/sample_config.yaml b/docs/sample_config.yaml
index 810a14b077..26894fae34 100644
--- a/docs/sample_config.yaml
+++ b/docs/sample_config.yaml
@@ -1503,6 +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
+
 
 # A list of application service config files to use
 #