README
¶
Mattermost is an open source platform for secure collaboration across the entire software development lifecycle. This repo is the primary source for core development on the Mattermost platform; it's written in Go and React and runs as a single Linux binary with MySQL or PostgreSQL. A new compiled version is released under an MIT license every month on the 16th.
Useful Resources:
- Deployment Guide - Install, setup, and configure your own Mattermost instance.
- Admin and User Documentation - Learn how to run a Mattermost instance and take advantage of all the features.
- Developer Documentation - Contribute code to Mattermost or build an integration via APIs, Webhooks, slash commands, Apps, and plugins.
Table of Contents
- Try out Mattermost
- Install Mattermost
- Native Mobile and Desktop Apps
- Get Security Bulletins
- Get Involved
- Learn More
- Get the Latest News
- Contributing
Try out Mattermost
- Join the Mattermost Contributor's server to join community discussions about contributions, development and more
- Get started with Mattermost Cloud to try out Mattermost
Note: Heroku preview does not include email or persistent storage
Install Mattermost
- Deploy Guide - Deploy Mattermost in minutes via Docker, Ubuntu, or tar.
- Developer Machine Setup - Follow this guide if you want to write code for Mattermost
Other Install Guides:
- Deploy Mattermost on Docker
- Mattermost Omnibus
- Install Mattermost from Tar
- Ubuntu 20.04 LTS
- Kubernetes
- Helm
- Debian Buster
- RHEL 8
- More server install guides
Native Mobile and Desktop Apps
In addition to the web interface, you can also download Mattermost clients for Android, iOS, Windows PC, Mac OSX, and Linux.
Get Security Bulletins
Receive notifications of critical security updates. The sophistication of online attackers is perpetually increasing. If you are deploying Mattermost it is highly recommended you subscribe to the Mattermost Security Bulletin mailing list for updates on critical security releases.
Get Involved
- Contribute to Mattermost
- Find "Help Wanted" projects
- Join Developer Discussion on a Mattermost Server for contributors
- Get Help With Mattermost
Learn More
- API Options - webhooks, slash commands, drivers and web service
- See who's using Mattermost
- Browse over 700 Mattermost integrations
License
See the LICENSE file for license rights and limitations.
Get the Latest News
- Twitter - Follow Mattermost.
- Blog - Get the latest updates from the Mattermost blog.
- Facebook - Follow Mattermost.
- LinkedIn - Follow Mattermost.
- Email - Subscribe to our newsletter (1 or 2 per month).
- Mattermost - Join the ~contributors channel on the Mattermost Community Server.
- IRC - Join the #matterbridge channel on Freenode (thanks to matterircd).
Contributing
Please see CONTRIBUTING.md.
Any other questions, mail us at info@mattermost.com. We’d love to meet you!
Directories
¶
| Path | Synopsis |
|---|---|
|
Installing a managed plugin consists of copying the uploaded plugin (*.tar.gz) to the filestore, unpacking to the configured local directory (PluginSettings.Directory), and copying any webapp bundle therein to the configured local client directory (PluginSettings.ClientDirectory).
|
Installing a managed plugin consists of copying the uploaded plugin (*.tar.gz) to the filestore, unpacking to the configured local directory (PluginSettings.Directory), and copying any webapp bundle therein to the configured local client directory (PluginSettings.ClientDirectory). |
|
build
|
|
|
cmd
|
|
|
As part of the enterprise code integration machinery a go file is copied to this package, this file ensure the existence of the package anyway, allowing the rest of the code to import the package when enterprise code is there and when is not.
|
As part of the enterprise code integration machinery a go file is copied to this package, this file ensure the existence of the package anyway, allowing the rest of the code to import the package when enterprise code is there and when is not. |
|
The plugin package is used by Mattermost server plugins written in go.
|
The plugin package is used by Mattermost server plugins written in go. |
|
plugintest
The plugintest package provides mocks that can be used to test plugins.
|
The plugintest package provides mocks that can be used to test plugins. |
|
plugintest/mock
This package provides aliases for the contents of "github.com/stretchr/testify/mock".
|
This package provides aliases for the contents of "github.com/stretchr/testify/mock". |
|
scripts
|
|
|
services
|
|
|
shared
|
|
|
driver
package driver implements a DB driver that can be used by plugins to make SQL queries using RPC.
|
package driver implements a DB driver that can be used by plugins to make SQL queries using RPC. |
|
markdown
This package implements a parser for the subset of the CommonMark spec necessary for us to do server-side processing.
|
This package implements a parser for the subset of the CommonMark spec necessary for us to do server-side processing. |
|
mlog
Package mlog provides a simple wrapper around Logr.
|
Package mlog provides a simple wrapper around Logr. |
|
Package testlib exposes helper methods for running unit tests against a containerized test store.
|
Package testlib exposes helper methods for running unit tests against a containerized test store. |
Click to show internal directories.
Click to hide internal directories.