diff --git a/docs/config.md b/docs/config.md index d9a7ca3963..20c5b6b984 100644 --- a/docs/config.md +++ b/docs/config.md @@ -139,6 +139,11 @@ complete re-branding/private labeling, a more personalised experience can be ach to hide this dropdown. 16. `disable_guests`: When `false` (default), **enable** guest-related functionality (peeking/previewing rooms, etc) for unregistered users. Set to `true` to disable this functionality. +17. `user_notice`: Optional notice to show to the user, e.g. for sunsetting a deployment and pushing users to move in their own time. + Takes a configuration object as below: + 1. `title`: Required. Title to show at the top of the notice. + 2. `description`: Required. The description to use for the notice. + 3. `show_once`: Optional. If true then the notice will only be shown once per device. ### `desktop_builds` and `mobile_builds`