×
Hacktoberfest is here! Contribute, collaborate & earn rewards.
  • Platform

    Platform

    • Overview
    • Channels
    • Playbooks
    • Integrations
    • Mobile
    • Security
    • Trust Center

    Interoperability

    • MS Teams
    • Atlassian
    • GitLab

    Flexible Deployment

    • On-Premise
    • Cloud
  • Solutions

    Use Cases

    • Purpose-Built Collaboration Hub
    • Self-Sovereign Collaboration
    • Mission-Critical ChatOps
    • Real-Time DevSecOps Collaboration
    • Integrated Security Operations
    • Out-of-Band Incident Response

    Industries

    • Critical Infrastructure
    • Defense
    • Technology
    • Global Public Sector
    • Financial Services
    • Energy and Utilities
    • Manufacturing
  • Customers

    Customers

    • USAF
    • Fujitsu
    • RTE
    • CERN
    • NRI
    • Pramacom
    • Crossover Health
    • Netfoundry
    See more customer stories »
  • Pricing
  • Partners

    Partners

    • Become a Partner
    • Partner Program
    • Deal Registration
  • Resources

    Resources

    • Resource Library
    • Blog
    • Demos
    • Events

    Documentation

    • Academy
    • Channels Guide
    • Playbooks Guide
    • Admin
    • Docs
    • API Reference
    • Release Notes

    Community

    • Join Community
    • Contribute
    • Deploy
    • Integrate
    • Download
  • Login

    Login

    • My Workspace
    • Admin Portal
    • Apps
    • Support
  • Contact Sales
Contents Menu Expand Light mode Dark mode Auto light/dark mode
Mattermost documentation
Mattermost documentation
  • About Mattermost
    • Mattermost overview
    • Use cases
      • Maximize your Microsoft investment
      • Secure command and control
      • DevOps collaboration
      • Incident response collaboration
    • Security overview
    • Integrations overview
    • Subscription overview
      • Cloud subscriptions
        • Cloud Dedicated
        • Cloud Shared
        • Cloud VPC Private Connectivity
      • Self-hosted subscriptions
      • Non-profit subscriptions
      • Editions and offerings
    • Zero Trust with Mattermost
    • Releases and life cycle
      • Release policy
      • Server
        • Server releases
        • v10 changelog
        • v9 changelog
        • Unsupported legacy releases
        • Version archive
      • Desktop
        • Desktop releases
        • Desktop app changelog
      • Mobile
        • Mobile releases
        • Mobile apps changelog
      • Removed and deprecated features
    • Corporate directory integration
    • Certifications and compliance overview
    • Accessibility compliance policy
    • Frequently asked questions (FAQ)
      • General questions
      • Community questions
      • Notifications questions
      • Video, audio, and screen sharing questions
      • Enterprise questions
      • License questions
      • Mattermost source available iicense questions
      • Integration questions
      • Use cases
      • Product questions
      • High trust questions
      • Design decision questions
      • Business questions
      • Illicit use questions
  • User Guide
    • Connect and collaborate
      • Access your Mattermost workspace
        • Install the desktop app
        • Install the iOS mobile app
        • Install the Android mobile app
        • Log out of Mattermost
      • Organize using teams
        • Team settings
        • Team keyboard shortcuts
      • Organize using custom user groups
      • Invite people
      • Learn about Mattermost roles
      • Collaborate with audio and video
      • Collaborate within channels
        • Channel types
        • Channel naming conventions
        • Communicate a channel's focus and scope
        • Create channels
        • Rename channels
        • Convert public channels to private channels
        • Convert group messages to private channels
        • Join and leave channels
        • Make calls in Mattermost
        • Manage channel members
        • Browse channels
        • Navigate between channels
        • Mark channels as favorites
        • Manage channel bookmarks
        • Mark channels as unread
        • Archive and unarchive channels
      • Communicate with messages and threads
        • Send messages
        • Reply to messages
        • React with emojis and GIFs
        • Organize conversations
        • Mark messages as unread
        • Forward messages
        • Share links to channels and messages
        • Save and pin messages
        • Set message reminders
        • Search for messages
        • Schedule messages
        • Format messages
        • Set message priority
        • Mention people
        • Share files in messages
      • Collaborate within Microsoft Teams
      • Chat with Copilot
        • Copilot Context Management
      • Keyboard shortcuts
        • Keyboard accessibility
        • Run slash commands
        • Built-in-slash-commands
      • Extend Mattermost with integrations
    • Build repeatable processes
      • Learn about collaborative playbooks
      • Work with collaborative playbooks
      • Work with runs
      • Work with tasks
      • Work with notifications and updates
      • Work with metrics and goals
      • Share and collaborate
      • Interact with collaborative playbooks
    • Customize your preferences
      • Manage your notifications
        • Troubleshoot notifications
        • Manage your web notifications
        • Manage your desktop notifications
        • Manage your mobile notifications
        • Manage your thread reply notifications
        • Manage your @mention & keyword notifications
        • Manage your channel-specific notifications
      • Customize your Mattermost theme
      • Customize your channel sidebar
      • Manage your profile
      • Manage your security preferences
      • Set your status & availability
      • Manage your display options
      • Manage your sidebar options
      • Manage advanced options
      • Manage your plugin preferences
      • Customize your desktop app experience
      • Connect to multiple workspaces
  • Deployment Guide
    • Application Architecture
    • Server Deployment
      • Preparations
        • Review software and hardware requirements
        • (Recommended) Set up an NGINX proxy
        • (Recommended) Configure Mattermost Calls
        • (Recommended) Enable Mattermost Copilot
        • (Optional) Set up TLS
        • (Optional) Use an image proxy
        • (Optional) Configure CloudFront to host Mattermost static assets
        • (Optional) Use an outbound proxy
        • (Optional) Use sockets to set up the database
      • Deploy with Kubernetes
      • Deploy with Containers
      • Deploy with Linux
      • Architecture reference
      • Scale for enterprise
        • Scale up to 200 users
        • Scale up to 2000 users
        • Scale up to 15000 users
        • Scale up to 30000 users
        • Scale up to 50000 users
        • Scale up to 80000 users
        • Scale up to 90000 users
        • Scale up to 100000 users
        • Scale up to 200000 users
    • Desktop App Deployment
      • Install desktop app on Linux
      • Distribute a custom desktop app
      • Silent Windows desktop distribution
      • Desktop MSI installer and group policy guide
      • Desktop App custom dictionaries
      • Desktop managed resources
    • Mobile App Deployment
      • Deploy using an EMM provider
      • Distribute a custom mobile app
      • Host your own push proxy service
      • Mobile VPN options
      • Mobile apps FAQ
    • Deployment Troubleshooting
      • General deployment troubleshooting
      • Docker deployment troubleshooting
      • Desktop app troubleshooting
      • Mobile app troubleshooting
      • PostgreSQL installation troubleshooting
      • MySQL installation troubleshooting
  • Administration Guide
    • Self-hosted billing
    • Cloud workspace management
      • Workspace migration
      • Cloud data residency
      • Cloud IP Filtering
      • Cloud Bring Your Own Key (BYOK)
    • Server maintenance
      • Install a license key
      • Generate a support packet
      • Backup and disaster recovery
      • Upgrade Mattermost server
        • Important upgrade notes
        • Prepare to upgrade Mattermost
        • Communicate scheduled maintenance best practices
        • Upgrade Mattermost Server
        • Enterprise install and upgrade
        • Administrator onboarding tasks
        • Enterprise roll-out-checklist
        • Welcome email to end users
        • Downgrade Mattermost Server
        • Open source components
      • Secure Mattermost
        • Encryption options
        • Transport encryption
        • Multi-factor authentication
        • Delegated granular administration
        • Custom terms of service
        • User and group provisioning via AD/LDAP
        • SAML-based SSO
          • Okta SAML Configuration
          • Generate self-signed certificates
          • OneLogin SAML Configuration
          • Microsoft ADFS SAML Configuration for Windows Server 2012
          • Microsoft ADFS SAML Configuration for Windows Server 2016
          • Keycloak SAML Configuration
        • SAML SSO techical documentation
        • Certificate-based authentication
      • Scale your deployment
        • Scale for Enterprise
          • Scale up to 200 users
          • Scale up to 2000 users
          • Scale up to 15000 users
          • Scale up to 30000 users
          • Scale up to 50000 users
          • Scale up to 80000 users
          • Scale up to 90000 users
          • Scale up to 100000 users
          • Scale up to 200000 users
        • Scale up to 200 users
        • Scale up to 2000 users
        • Scale up to 15000 users
        • Scale up to 30000 users
        • Scale up to 50000 users
        • Scale up to 80000 users
        • Scale up to 90000 users
        • Scale up to 100000 users
        • Scale up to 200000 users
      • Mattermost error codes
      • mmctl
      • CLI
      • Feature labels
    • Server configuration
      • Elasticsearch
      • High availability
      • Store configuration in your database
      • Server configuration options
        • Self-hosted workspace edition and license settings
        • Cloud workspace subscription, billing, and account settings
        • Reporting configuration settings
        • User management configuration settings
        • Environment configuration settings
        • Site configuration settings
        • Authentication configuration settings
        • Plugins configuration settings
        • Integrations configuration settings
        • Compliance configuration settings
        • Experimental configuration settings
        • Deprecated configuration settings
        • Bleve search
      • Environment variables
      • Customize the server
        • Customize Mattermost
        • Custom branding tools
        • Code signing custom builds
      • SMTP email setup
      • Email templates
      • Chinese, Japanese, and Korean search
      • SSL client certificate setup
      • Connected workspaces
      • Telemetry
    • User provisioning
      • Provisioning workflows
      • AD/LDAP setup
      • AD/LDAP manage team or private channel membership
      • GitLab SSO
      • OpenID Connect SSO
      • Google SSO
      • Entra ID SSO
      • Convert OAuth 2.0 providers to OpenID
    • User management
      • Permissions
      • Manage team and channel configuration
      • Advanced permissions infrastructure
      • Guest accounts
    • Monitoring and performance
      • Optimize your Mattermost workspace
      • Collect performance metrics
      • Deploy Prometheus and Grafana for performance monitoring
      • Performance monitoring metrics
      • Push notification health targets
      • Performance alerting guide
      • Ensuring releases perform at scale
      • Manage user surveys
      • User satisfaction surveys
      • Notify admin
      • System-wide notifications
      • Statistics
      • In-product notices
      • Health checks
      • Health check probes
      • Product limits
    • Compliance
      • Compliance export
      • Compliance monitoring
      • Electronic discovery
      • Data retention
      • Logging
      • Export channel data
      • Legal Hold
      • JSON audit log schema
    • Migration
      • Migrate from MySQL to PostgreSQL
        • Automate PostgreSQL migration
        • Manually migrate to PostgreSQL
      • Server migration guide
      • Migrate from Slack
      • Bulk export tool
      • Bulk loading tool
      • Migration announcement email template
  • Integrate and extend
    • GitHub interoperability
    • GitLab interoperability
    • Jira interoperability
    • Community for Mattermost for Microsoft 365
    • Mattermost Playbooks for Microsoft Teams
    • Microsoft Calendar interoperability
    • Microsoft Teams interoperability
    • Microsoft Teams Meetings interoperability
    • ServiceNow interoperability
    • Zoom interoperability
  • Develop with Mattermost
  • Get help with Mattermost
  • Join our community
  • Learn how we work
  • Contribute to this documentation
Back to top
Edit this page

(Recommended) Enable Copilot#

plans-img Available on all plans

deployment-img Cloud and self-hosted deployments

Signficantly increase team productivity and decision-making speed by enhancing your real-time collaboration capabilities with instant access to AI-generated information, discussion summaries, and contextually-aware action recommendations with Mattermost’s Copilot. Your users can interact with AI capabilities directly within their daily communication channels without needing to switch between multiple tools or platforms.

Tip

  • Looking for a Mattermost Copilot demo? Try it yourself!

  • Watch this AI-Enhanced Collaboration on-demand webinar to learn how Copilot can enhance your mission-critical workflows.

  • Download the Mattermost Copilot datasheet to learn more about integrating with industry-leading large language models (LLMs).

  • See the Copilot context management documentation to learn how Copilot manages LLM context and how to ensure data privacy.

Mattermost Academy Learn about setting up and configuring Mattermost Copilot with multiple LLMs

Setup#

You must be a Mattermost system admin to enable and configure it using the System Console.

From Mattermost v10.3#

From Mattermost v10.3, Copilot is installed automatically and ready for you to configure a large language model (LLM). When no LLMs are configured, the Copilot panel prompts users to configure one.

From Mattermost v9.7#

From Mattermost v9.7, you can install Mattermost Copilot from the in-product Mattermost Marketplace by selecting the Product Navigate between Channels and collaborative playbooks using the product menu icon. icon and selecting App Marketplace. Search for Copilot and select Install, then configure an LLM.

Mattermost v9.6 or earlier#

Important

For an optimized user experience and compatibility, we recommend using Mattermost Copilot with Mattermost v9.7 and later.

If you’re running Mattermost Server v9.6 or earlier, AI Copilot must be installed using the latest binary available for download from the plugin repository.

Copilot is compatible with the following Mattermost Server versions:

  • v9.6 or later

  • v9.5.2+ (Extended Support Release - ESR)

  • v9.4.4+

  • v9.3.3+

  • v8.1.11+ (Extended Support Release - ESR)

Enable#

From Mattermost v10.3#

From Mattermost v10.3, Copilot is enabled automatically and is ready for LLM configuration.

From Mattermost v9.6#

From Mattermost v9.6, you must Copilot by going to System Console > Plugins > Copilot and setting Enable Plugin to True, then complete configuration in the System Console.

Mattermost configuration#

With extensive customization and extensibility options, you can tailor Copilot to meet your specific needs, whether it’s integrating with internal systems, customizing AI responses based on the team or project needs, or developing new capabilities that are unique to your operational requirements. You can also create custom integrations, workflows, and bots that leverage AI to meet your unique business needs.

Configure an LLM for your Copilot integration by going to System Console > Plugins > Copilot and selecting Add an AI Bot. Mattermost supports the following LLMs:

  • OpenAI

  • Anthropic (Claude)

  • Azure OpenAI

  • OpenAI-compatible (e.g., LocalAI)

Note

The ability to define multiple LLMs for your Copilot integration requires a Mattermost Enterprise license.

  1. Obtain an OpenAI API key.

  2. Select OpenAI in the Service dropdown.

  3. Enter your OpenAI API key in the API Key field.

  4. Enter a model name in the Default Model field corresponding with the model’s label in the API, such as gpt-4o or gpt-3.5-turbo.

  5. (Optional) If your API key belongs to an OpenAI organization, specify your Organization ID.

  1. Obtain an Anthropic API key.

  2. Select Anthropic in the Service dropdown.

  3. Enter your Anthropic API key in the API Key field.

  4. Specify a model name in the Default Model field corresponding with the model’s label in the API, such as claude-3-5-sonnet-20240620.

For more details about integrating with Microsoft Azure’s OpenAI services, see the official Azure OpenAI documentation.

  1. Provision sufficient access to Azure OpenAI for your organization and access your Azure portal.

  2. If you do not already have one, deploy an Azure AI Hub resource within Azure AI Studio

  3. Once the deployment is complete, navigate to the resource and select Launch Azure AI Studio.

  4. In the side navigation pane, select Deployments under Shared resources.

  5. Select Deploy model then Deploy base model.

  6. Select your model, such as gpt-4o and select Confirm.

  7. Select Deploy to start your model.

  8. In Mattermost, select OpenAI Compatible in the Service dropdown.

  9. In the Endpoint panel for your new model deployment, copy the base URI of the Target URI (everything up to and including .com) and paste it in the API URL field in Mattermost.

  10. In the Endpoint panel for your new model deployment, copy the Key and paste it in the API Key field in Mattermost.

  11. In the Deployment panel for your new model deployment, copy the Model name and paste it in the Default Model field in Mattermost.

The OpenAI Compatible option allows integration with any OpenAI-compatible LLM provider, such as Ollama:

  1. Deploy your model, for example, on Ollama.

  2. Select OpenAI Compatible in the AI Service dropdown.

  3. Enter the URL to your AI service from your Mattermost deployment in the API URL field. Be sure to include the port, and append /v1 to the end of the URL if using Ollama. (e.g., http://localhost:11434/v1 for Ollama, otherwise http://localhost:11434/)

  4. If using Ollama, leave the API Key field blank.

  5. Specify your model name in the Default Model field.

Custom instructions#

Text input here is included in the prompt for every request. Use this to give your bots extra context or instructions. For example, you could list all of your organization’s specific acronyms so the bot knows your vernacular and users can ask for definitions. Or you could give it specialized instructions such as adopting a specific personality or following a certain workflow. By customizing the instructions for each individual bot, you can create a more tailored AI experience for your specific needs.

Enable vision (Beta)#

Enabling vision allows images that are attached to posts to be sent to the upstream LLM for analysis. This requires that your upstream LLM supports these features. Only available with OpenAI and OpenAI-compatable services.

Disable tools (Beta)#

Disabling tools will prevent the LLM from making function calls. This is useful when a model technically supports tool usage but you want to prevent it from being used within Mattermost. Try toggling this feature if you encounter unpredictable tool-related behavior with your model.

Copilot plugin metrics#

Metrics for Copilot are exposed through the /plugins/mattermost-ai/metrics subpath under the existing Mattermost server metrics endpoint. This is controlled by the Listen address for performance configuration setting. It defaults to port 8067, and the following metrics are available:

  • copilot_system_plugin_start_timestamp_seconds: The time the plugin started.

  • copilot_system_plugin_info: The plugin version and installation ID.

  • copilot_api_time_seconds: How long to execute API.

  • copilot_http_requests_total: The total number of API requests.

  • copilot_http_errors_total: The total number of http API errors.

  • copilot_llm_requests_total: The total number of requests to upstream LLMs.

Integrations#

Currently integrations are limited to direct messages between users and the bots. The integrations won’t operate from within public, private, or group message channels.

Jira#

Issues with public Jira instances can be fetched. No configuration is required for this integration.

GitHub#

If you have the Mattermost GitHub plugin enabled, you can use the integration to fetch issues and PRs from your public and private GitHub repositories. The user must be logged in to their GitHub account through the Mattermost GitHub plugin.

Upgrade#

We recommend updating this integration as new versions are released. Generally, updates are seamless and don’t interrupt the user experience in Mattermost.

Visit the Releases page for the latest release, available releases, and compatibiilty considerations.

Usage#

When Copilot is configured, notify your teams that they can use the Copilot in any Mattermost team or channel, and direct users to the chat with Copilot documentation for details on using Copilot to overcome information overload and streamline communication and collaboration.

Tell us more!

Your feedback helps us improve the Mattermost product documentation.

How can we make this page more helpful?

0/186

Have a feature request? Share it here.

Having issues? Join our Community server.

×
Thank you!

We appreciate your feedback.

Did you find what you were looking for?

😀

Yes

😐

Mostly

🙁

No!

Next
(Optional) Set up TLS
Previous
Calls self-hosted deployment
Copyright © 2015-2025 Mattermost
Made with Sphinx and @pradyunsg's Furo
On this page
  • (Recommended) Enable Copilot
    • Setup
      • From Mattermost v10.3
      • From Mattermost v9.7
      • Mattermost v9.6 or earlier
    • Enable
      • From Mattermost v10.3
      • From Mattermost v9.6
    • Mattermost configuration
    • Custom instructions
      • Enable vision (Beta)
      • Disable tools (Beta)
    • Copilot plugin metrics
    • Integrations
      • Jira
      • GitHub
    • Upgrade
    • Usage