root

README

Mattermost AI Copilot Plugin

Mattermost plugin for local and third-party LLMs

Table of Contents

• Background
• Install
• Usage
• Contributing
• License

Background

The Mattermost AI Copilot Plugin adds functionality for local (self-hosted) and third-party (vendor-hosted) LLMs within Mattermost v9.6 and above.

This plugin is currently experimental. Contributions and suggestions are welcome. See the Contributing section for more details!

Join the discussion in the ~AI-Exchange channel and explore the Discourse forum. 💬

Install

We recommend using Mattermost Server v9.6 or later for the best experience. Compatible Mattermost server versions include:

• v9.6 or later
• v9.5.2+ (ESR)
• v9.4.4+
• v9.3.3+
• v8.1.11+ (ESR)

These installation instructions assume you already have Mattermost Server installed and configured with PostgreSQL:

1. Download the latest release of the Mattermost AI Copilot Plugin
2. Log in to Mattermost as an administrator
3. Upload the *.tar.gz to your server via System Console ➡️ Plugin Management. See this documentation for help.
4. Enable the Mattermost AI Copilot Plugin via System Console ➡️ Mattermost AI Copilot Plugin.
5. Follow the configuration guide to set up the Mattermost AI Copilot Plugin

Usage

After following the configuration guide to connect your LLM to Mattermost, there many ways to integrate AI into your collaboration workflows. To help you get started, check out the examples in the Usage documentation. 🚀

Contributing

Interested in contributing to our open source project? Start by reviewing the contributor guidelines for this repository.

License

This repository is licensed under Apache-2, except for the server/enterprise directory which is licensed under the Mattermost Source Available License. See Mattermost Source Available License to learn more.

Documentation

Index

• Variables

Variables

var Manifest model.Manifest