diff options
| author | Richard van der Hoff <1389908+richvdh@users.noreply.github.com> | 2022-01-17 14:55:30 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-01-17 14:55:30 +0000 |
| commit | 86615aa965a04dc4c16ff28ee5b82cbe65a83530 (patch) | |
| tree | c3316e3c3c54c206c9510fa78451731426e1030e /docs | |
| parent | Update documentation for configuring facebook login (#11755) (diff) | |
| download | synapse-86615aa965a04dc4c16ff28ee5b82cbe65a83530.tar.xz | |
Fix up docs for `track_puppeted_user_ips` (again) (#11757)
Fixes #11741
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/sample_config.yaml | 16 |
1 files changed, 12 insertions, 4 deletions
diff --git a/docs/sample_config.yaml b/docs/sample_config.yaml index 4d4f6a6948..5908f262e5 100644 --- a/docs/sample_config.yaml +++ b/docs/sample_config.yaml @@ -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 |