Image proxy configuration settings

An image proxy is used by Mattermost apps to prevent them from connecting directly to remote self-hosted servers. Configure an image proxy by going to System Console > Environment > Image Proxy, or by editing the config.json file as described in the following table.

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.

Enables image proxy

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

Available in legacy Enterprise Edition E10/E20

An image proxy anonymizes Mattermost app connections and prevents them from accessing insecure content.

  • true: (Default) Enables an image proxy for loading external images.

  • false: Disables the image proxy.

  • System Config path: Environment > Image Proxy

  • config.json setting: ".ImageProxySettings.Enable": true",

  • Environment variable: MM_IMAGEPROXYSETTINGS_ENABLE

See the image proxy documentation to learn more.

Image proxy type

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

Available in legacy Enterprise Edition E10/E20

The type of image proxy used by Mattermost.

  • local: (Default) The Mattermost server itself acts as the image proxy.

  • atmos/camo: An external atmos/camo image proxy is used.

  • System Config path: Environment > Image Proxy

  • config.json setting: ".ImageProxySettings.ImageProxyType": "local",

  • Environment variable: MM_IMAGEPROXYSETTINGS_IMAGEPROXYTYPE

See the image proxy documentation to learn more.

Remote image proxy URL

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

Available in legacy Enterprise Edition E10/E20

The URL of the atmos/camo proxy. This setting isn’t needed when using the local image proxy.

  • System Config path: Environment > Image Proxy

  • config.json setting: ".ImageProxySettings.RemoteImageProxyURL",

  • Environment variable: MM_IMAGEPROXYSETTINGS_REMOTEIMAGEPROXYURL

Remote image proxy options

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

Available in legacy Enterprise Edition E10/E20

The URL signing key passed to an atmos/camo image proxy. This setting isn’t needed when using the local image proxy type.

  • System Config path: Environment > Image Proxy

  • config.json setting: ".ImageProxySettings.RemoteImageProxyOptions",

  • Environment variable: MM_IMAGEPROXYSETTINGS_REMOTEIMAGEPROXYOPTIONS

See the image proxy documentation to learn more.