Push notification server configuration settings

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 table. Changes to configuration settings in this section require a server restart before taking effect.

Tip

Each configuration value below includes a JSON path to access the value programmatically in the config.json file using a JSON-aware tool. For example, the SiteURL value is under ServiceSettings.

  • If using a tool such as jq, you’d enter: cat config/config.json | jq '.ServiceSettings.SiteURL'

  • When working with the config.json file manually, look for the key ServiceSettings, then within that object, find the key SiteURL.

Enable push notifications

Available in Mattermost Free and Starter subscription plans. Available for Mattermost Self-Hosted deployments.

Available in legacy Enterprise Edition E10/E20

You can disable Mattermost push notifications.

  • true: (Default) Your Mattermost server sends mobile push notifications to the server specified.

  • false: Mobile push notifications are disabled.

  • System Config path: Environment > Push Notification Server

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

  • Environment variable: MM_EMAILSETTINGS_SENDPUSHNOTIFICATIONS

Push notification server

Available in Mattermost Free and Starter subscription plans. Available for Mattermost Self-Hosted deployments.

Available in legacy Enterprise Edition E10/E20

Location of Mattermost Push Notification Service (MPNS), which re-sends push notifications from Mattermost to services like Apple Push Notification Service (APNS) and Google Cloud Messaging (GCM).

  • Customers running a Professional or Enterprise Edition workspace should enter https://push.mattermost.com for the push notification server hosted in the United States.

  • If you prefer to use a push notification server hosted in Germany, enter https://hpns-de.mattermost.com/.

  • Team Edition customers should enter https://push-test.mattermost.com.

  • System Config path: Environment > Push Notification Server

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

  • Environment variable: MM_EMAILSETTINGS_PUSHNOTIFICATIONSERVER

Notes:

  • The TPNS is provided for testing push notifications prior to compiling your own service. 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.

Maximum notifications per channel

Available in Mattermost Free and Starter subscription plans. Available for Mattermost Self-Hosted deployments.

Available in legacy Enterprise Edition E10/E20

Maximum total number of users in a channel before @all, @here, and @channel no longer send 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.