README.md 6.58 KB
Newer Older
1
# [![Mattermost](https://user-images.githubusercontent.com/7205829/137170381-fe86eef0-bccc-4fdd-8e92-b258884ebdd7.png)](https://mattermost.com)
it33's avatar
it33 committed
2

Agniva De Sarker's avatar
Agniva De Sarker committed
3
[Mattermost](https://mattermost.com) 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.
it33's avatar
it33 committed
4

5
<img width="1006" alt="mattermost-hero" src="https://user-images.githubusercontent.com/7205829/136107976-7a894c9e-290a-490d-8501-e5fdbfc3785a.png">
it33's avatar
it33 committed
6

7
Useful Resources:
it33's avatar
it33 committed
8

9
10
11
- [Deployment Guide](https://docs.mattermost.com/guides/deployment.html) - Install, setup, and configure your own Mattermost instance.
- [Admin and User Documentation](http://docs.mattermost.com/) - Learn how to run a Mattermost instance and take advantage of all the features.
- [Developer Documentation](http://developers.mattermost.com/) - Contribute code to Mattermost or build an integration via APIs, Webhooks, slash commands, Apps, and plugins.
amyblais's avatar
amyblais committed
12

Mohan Sha's avatar
Mohan Sha committed
13
14
15
16
Table of Contents
=================

  * [Try out Mattermost](#try-out-mattermost)
17
  * [Install Mattermost](#install-mattermost)
Mohan Sha's avatar
Mohan Sha committed
18
19
20
21
22
  * [Native Mobile and Desktop Apps](#native-mobile-and-desktop-apps)
  * [Get Security Bulletins](#get-security-bulletins)
  * [Get Involved](#get-involved)
  * [Learn More](#learn-more)
  * [Get the Latest News](#get-the-latest-news)
rishabh710's avatar
rishabh710 committed
23
  * [Contributing](#contributing)
Mohan Sha's avatar
Mohan Sha committed
24

amyblais's avatar
amyblais committed
25
## Try out Mattermost
26

Amy Blais's avatar
Amy Blais committed
27
28
- [Join the Mattermost Contributor's server](https://community.mattermost.com/signup_user_complete/?id=codoy5s743rq5mk18i7u5ksz7e) to join community discussions about contributions, development and more
- [Get started with Mattermost Cloud](https://customers.mattermost.com/cloud/signup) to try out Mattermost
29
30
31
32
33

[![Deploy a Preview](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/mattermost/mattermost-heroku)

_Note: Heroku preview does not include email or persistent storage_

34
## Install Mattermost
amyblais's avatar
amyblais committed
35

36
37
38
- [Quick Install Guide](https://docs.mattermost.com/getting-started/light-install.html) - Deploy in minutes via Mattermost Omnibus on Ubuntu.
- [Run Mattermost via Docker](https://docs.mattermost.com/install/setting-up-local-machine-using-docker.html) - Launch a Mattermost server instantly to test functionality and build integrations.
- [Developer Machine Setup](https://developers.mattermost.com/contribute/server/developer-setup) - Follow this guide if you want to write code for Mattermost.
39

40
41
42
43
44
45
46
Other Install Guides:
- [Ubuntu 20.04 LTS](https://docs.mattermost.com/install/installing-ubuntu-2004-LTS.html)
- [Kubernetes](https://docs.mattermost.com/install/install-kubernetes.html)
- [Helm](https://docs.mattermost.com/install/install-kubernetes.html#installing-the-operators-via-helm)
- [Debian Buster](https://docs.mattermost.com/install/install-debian.html)
- [RHEL 8](https://docs.mattermost.com/install/install-rhel-8.html)
- [More server install guides](https://docs.mattermost.com/guides/deployment.html)
it33's avatar
it33 committed
47

amyblais's avatar
amyblais committed
48
49
## Native Mobile and Desktop Apps

Matthew Stodolnic's avatar
Matthew Stodolnic committed
50
In addition to the web interface, you can also download Mattermost clients for [Android](https://play.google.com/store/apps/details?id=com.mattermost.rn), [iOS](https://itunes.apple.com/us/app/mattermost/id1257222717?mt=8), [Windows PC](https://docs.mattermost.com/install/desktop.html#windows-10-windows-8-1-windows-7), [Mac OSX](https://docs.mattermost.com/install/desktop.html#macos-10-9), and [Linux](https://docs.mattermost.com/install/desktop.html#linux).
amyblais's avatar
amyblais committed
51

Matthew Stodolnic's avatar
Matthew Stodolnic committed
52
[![Google Play](https://user-images.githubusercontent.com/33878967/33095356-39b6fbf8-ceb8-11e7-8a61-c3a18fa5e658.png)](https://play.google.com/store/apps/details?id=com.mattermost.rn)  [![App Store](https://user-images.githubusercontent.com/33878967/33095353-397e69b4-ceb8-11e7-8175-f95a97d5274f.png)](https://itunes.apple.com/us/app/mattermost/id1257222717?mt=8)  [![Windows PC](https://user-images.githubusercontent.com/33878967/33095357-39cab8d2-ceb8-11e7-89a6-67dccc571ca3.png)](https://docs.mattermost.com/install/desktop.html#windows-10-windows-8-1-windows-7)  [![Mac OSX](https://user-images.githubusercontent.com/33878967/33095355-39a36f2a-ceb8-11e7-9b33-73d4f6d5d6c1.png)](https://docs.mattermost.com/install/desktop.html#macos-10-9)  [![Linux](https://user-images.githubusercontent.com/33878967/33095354-3990e256-ceb8-11e7-965d-b00a16e578de.png)](https://docs.mattermost.com/install/desktop.html#linux)
amyblais's avatar
amyblais committed
53
54
55
56

## 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.
57

58
[Subscribe here](https://mattermost.com/security-updates/#sign-up)
amyblais's avatar
amyblais committed
59
60

## Get Involved
it33's avatar
it33 committed
61

62
- [Contribute to Mattermost](https://handbook.mattermost.com/contributors/contributors/ways-to-contribute)
Conor O'Callaghan's avatar
Conor O'Callaghan committed
63
- [Find "Help Wanted" projects](https://github.com/mattermost/mattermost-server/issues?page=1&q=is%3Aissue+is%3Aopen+%22Help+Wanted%22&utf8=%E2%9C%93)
64
- [Join Developer Discussion on a Mattermost Server for contributors](https://community.mattermost.com/signup_user_complete/?id=f1924a8db44ff3bb41c96424cdc20676)
65
- [Get Help With Mattermost](https://docs.mattermost.com/guides/get-help.html)
it33's avatar
it33 committed
66

amyblais's avatar
amyblais committed
67
## Learn More
68

Conor O'Callaghan's avatar
Conor O'Callaghan committed
69
- [API Options - webhooks, slash commands, drivers and web service](https://api.mattermost.com/)
Matthew Stodolnic's avatar
Matthew Stodolnic committed
70
71
- [See who's using Mattermost](https://mattermost.com/blog/category/customer-stories/)
- [Browse over 700 Mattermost integrations](https://integrations.mattermost.com/)
lfbrock's avatar
lfbrock committed
72

73
74
75
76
## License

See the [LICENSE file](LICENSE.txt) for license rights and limitations.

amyblais's avatar
amyblais committed
77
## Get the Latest News
lfbrock's avatar
lfbrock committed
78

79
- **Twitter** - Follow [Mattermost](https://twitter.com/mattermost).
Matthew Stodolnic's avatar
Matthew Stodolnic committed
80
- **Blog** - Get the latest updates from the [Mattermost blog](https://mattermost.com/blog/).
81
82
83
- **Facebook** - Follow [Mattermost](https://www.facebook.com/MattermostHQ).
- **LinkedIn** - Follow [Mattermost](https://www.linkedin.com/company/mattermost/).
- **Email** - Subscribe to our [newsletter](http://mattermost.us11.list-manage.com/subscribe?u=6cdba22349ae374e188e7ab8e&id=2add1c8034) (1 or 2 per month).
84
- **Mattermost** - Join the ~contributors channel on [the Mattermost Community Server](https://community.mattermost.com). 
85
- **IRC** - Join the #matterbridge channel on [Freenode](https://freenode.net/) (thanks to [matterircd](https://github.com/42wim/matterircd)).
86

rishabh710's avatar
rishabh710 committed
87
88
89
## Contributing
Please see [CONTRIBUTING.md](./CONTRIBUTING.md).

it33's avatar
it33 committed
90
Any other questions, mail us at info@mattermost.com. We’d love to meet you!