Matrix-Mirrors/synapse-product
1
0
Fork 0
mirror of https://git.anonymousland.org/anonymousland/synapse-product.git synced 2024-12-17 05:44:22 -05:00
Code Issues Packages Projects Releases Wiki Activity

Fix up docs for track_puppeted_user_ips (again) (#11757)

Browse Source 
Fixes #11741
This commit is contained in:
Richard van der Hoff 2022-01-17 14:55:30 +00:00 committed by GitHub
parent b0352f9c08
commit 86615aa965
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 27 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
changelog.d/11561.feature
View File

@ -1 +1 @@
Add `track_puppeted_user_ips` config flag to track puppeted user IP addresses. This also includes them in monthly active user counts. 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.

2
changelog.d/11749.feature
View File

@ -1 +1 @@
Add `track_puppeted_user_ips` config flag to track puppeted user IP addresses. This also includes them in monthly active user counts. 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.

1
changelog.d/11757.feature Normal file
View File

@ -0,0 +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.

16
docs/sample_config.yaml
View File

@ -1503,10 +1503,18 @@ room_prejoin_state:
#additional_event_types: #additional_event_types:
# - org.example.custom.event.type # - org.example.custom.event.type
# By default when puppeting another user, the user who has created the # We record the IP address of clients used to access the API for various
# access token for puppeting is tracked. If this is enabled, both # reasons, including displaying it to the user in the "Where you're signed in"
# requests are tracked. Implicitly enables MAU tracking for puppeted users. # dialog.
# Uncomment to also track puppeted user IP's. #
# 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 #track_puppeted_user_ips: true

16
synapse/config/api.py
View File

@ -61,10 +61,18 @@ class ApiConfig(Config):
#additional_event_types: #additional_event_types:
# - org.example.custom.event.type # - org.example.custom.event.type
# By default when puppeting another user, the user who has created the # We record the IP address of clients used to access the API for various
# access token for puppeting is tracked. If this is enabled, both # reasons, including displaying it to the user in the "Where you're signed in"
# requests are tracked. Implicitly enables MAU tracking for puppeted users. # dialog.
# Uncomment to also track puppeted user IP's. #
# 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 #track_puppeted_user_ips: true
""" % { """ % {