diff options
| author | Will Hunt <will@half-shot.uk> | 2022-05-04 19:33:26 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-05-04 19:33:26 +0100 |
| commit | 2d74a8c17876ed235249b1423d63c920c614a530 (patch) | |
| tree | 49cfa324c04e10ca0fba48d6b2f756f119f8d903 /docs | |
| parent | Use `getClientAddress` instead of `getClientIP`. (#12599) (diff) | |
| download | synapse-2d74a8c17876ed235249b1423d63c920c614a530.tar.xz | |
Add `mau_appservice_trial_days` config (#12619)
* Add mau_appservice_trial_days * Add a test * Tweaks * changelog * Ensure we sync after the delay * Fix types * Add config statement * Fix test * Reinstate logging that got removed * Fix feature name
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/sample_config.yaml | 7 | ||||
| -rw-r--r-- | docs/usage/configuration/config_documentation.md | 14 |
2 files changed, 21 insertions, 0 deletions
diff --git a/docs/sample_config.yaml b/docs/sample_config.yaml index 5eba0fcf3d..a803b8261d 100644 --- a/docs/sample_config.yaml +++ b/docs/sample_config.yaml @@ -407,6 +407,11 @@ manhole_settings: # sign up in a short space of time never to return after their initial # session. # +# The option `mau_appservice_trial_days` is similar to `mau_trial_days`, but +# applies a different trial number if the user was registered by an appservice. +# A value of 0 means no trial days are applied. Appservices not listed in this +# dictionary use the value of `mau_trial_days` instead. +# # 'mau_limit_alerting' is a means of limiting client side alerting # should the mau limit be reached. This is useful for small instances # where the admin has 5 mau seats (say) for 5 specific people and no @@ -417,6 +422,8 @@ manhole_settings: #max_mau_value: 50 #mau_trial_days: 2 #mau_limit_alerting: false +#mau_appservice_trial_days: +# "appservice-id": 1 # If enabled, the metrics for the number of monthly active users will # be populated, however no one will be limited. If limit_usage_by_mau diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md index 36db649467..21dad0ac41 100644 --- a/docs/usage/configuration/config_documentation.md +++ b/docs/usage/configuration/config_documentation.md @@ -627,6 +627,20 @@ Example configuration: mau_trial_days: 5 ``` --- +Config option: `mau_appservice_trial_days` + +The option `mau_appservice_trial_days` is similar to `mau_trial_days`, but applies a different +trial number if the user was registered by an appservice. A value +of 0 means no trial days are applied. Appservices not listed in this dictionary +use the value of `mau_trial_days` instead. + +Example configuration: +```yaml +mau_appservice_trial_days: + my_appservice_id: 3 + another_appservice_id: 6 +``` +--- Config option: `mau_limit_alerting` The option `mau_limit_alerting` is a means of limiting client-side alerting |