Configure Mattermost to enable push notifications to Mattermost clients by going to System Console > Environment > Push Notification Server, or by editing the config.json file as described in the following tables. Changes to configuration settings in this section require a server restart before taking effect.

Enable push notifications#

Also available in legacy Mattermost Enterprise Edition E10 or E20

Enable or disable Mattermost push notifications.

  • Do not send push notifications: Mobile push notifications are disabled.

  • Use HPNS connection with uptime SLA to send notifications to iOS and Android apps: (Default) Use Mattermost’s hosted push notification service.

  • Use TPNS connection to send notifications to iOS and Android apps: Use Mattermost’s test push notification service.

  • Manually enter Push Notification Service location: When building your own custom mobile apps, you must host your own mobile push proxy service, and specify that URL in the Push Notification Server field.

  • System Config path: Environment > Push Notification Server

  • config.json setting: ".EmailSettings.SendPushNotifications": true",

  • Environment variable: MM_EMAILSETTINGS_SENDPUSHNOTIFICATIONS

Notes:

  • Mattermost Enterprise, Professional, and Cloud customers can use Mattermost’s SLA-bound Hosted Push Notification Service (HPNS) in one of two of two locations, including the United States and Germany. Mattermost Team Edition customers can use Mattermost’s Test Push Notification server (TPNS).

  • The TPNS is provided for testing push notifications prior to compiling your own service, and isn’t available for Mattermost Cloud deployments. Ensure you’re familiar with its limitations.

  • Review the mobile push notifications and mobile apps documentation, including guidance on compiling your own mobile apps and MPNS, before deploying to production.

  • To confirm push notifications are working, connect to the Mattermost iOS App available on the App Store, or the Mattermost Android App available on Google Play.

Push notification server location#

Also available in legacy Mattermost Enterprise Edition E10 or E20

The physical location of the Mattermost Hosted Push Notification Service (HPNS) server.

Select from US (Default) or Germany to automatically populate the Push Notification Server field server URL.

  • System Config path: Environment > Push Notification Server

  • config.json setting: ".EmailSettings.PushNotificationServer",

  • Environment variable: MM_EMAILSETTINGS_PUSHNOTIFICATIONSERVER

Maximum notifications per channel#

Also available in legacy Mattermost Enterprise Edition E10 or E20

The maximum total number of users in a channel before @all, @here, and @channel no longer send desktop, email, or mobile push notifications to maximize performance.

Numerical input. Default is 1000.

  • System Config path: Environment > Push Notification Server

  • config.json setting: ".TeamSettings.MaxNotificationsPerChannel: 1000",

  • Environment variable: MM_EMAILSETTINGS_MAXNOTIFICATIONSPERCHANNEL

Note: We recommend increasing this value a little at a time, monitoring system health by tracking performance monitoring metrics, and only increasing this value if large channels have restricted permissions controlling who can post to the channel, such as a read-only Town Square channel.