summaryrefslogtreecommitdiffstats
path: root/doc/README.md
blob: 5f4ee879cef3241e16906da18f56461795950d6e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
# Mattermost Documentation 

## Installation 

#### Preview Installation
See what Mattermost has to offer in a Docker-based preview install

Local Machine: 
- [One-line Docker Install](install/Docker-Single-Container.md#one-line-docker-install)
- [Mac OS X install](install/Docker-Single-Container.md#mac-osx)
- [Ubuntu Install](install/Docker-Single-Container.md#ubuntu)
- [Arch Install](install/Docker-Single-Container.md#arch)

Service Based: 
- [AWS Elastic Beanstalk Setup](install/Amazon-Elastic-Beanstalk.md)

Optional:
- [SMTP Email Setup](install/SMTP-Email-Setup.md)
- [System Console Settings](install/Configuration-Settings.md)

#### Production Installation
Set up Mattermost in your data center using compiled binaries
- [Software and Hardware Requirements](install/Requirements.md)
- [Production Ubuntu Setup](install/Production-Ubuntu.md)
- [SMTP Email Setup](install/SMTP-Email-Setup.md)
- [System Console Settings](install/Configuration-Settings.md)
- [Trouble Shooting Guide](install/Troubleshooting.md)

Optional
- [Community Guide for Production Debian Setup](install/Production-Debian.md)

#### Configuration and Management 
- [System Console Settings](install/Configuration-Settings.md)
  - [GitLab SSO Configuration](integrations/Single-Sign-On/Gitlab.md) 
- [Mattermost Release Numbering and Schedule](install/Release-Numbering.md)

#### System Upgrades
Procedures for upgrading the Mattermost server
- [Mattermost Release Numbering and Schedule](install/Release-Numbering.md)
- [Upgrade Guide](install/Upgrade-Guide.md)

## Developer Documentation 

- [Code Contribution Guidelines](https://github.com/mattermost/platform/blob/master/CONTRIBUTING.md)
- [Developer Machine Setup](developer/Setup.md)
- [Mattermost Style Guide](developer/Style-Guide.md)
- [API Overview](developer/API.md)
 - [Incoming Webhooks](integrations/webhooks/Incoming-Webhooks.md) 
 - [Outgoing Webhooks](integrations/webhooks/Outgoing-Webhooks.md) 
 - [Web Service API](developer/API-Web-Service.md)

## Help

_Note: End user help documentation is a new feature being completed for the v1.2 release. The materials below are work in progress._

- Getting Started
   - [Sign-in](help/Sign-in.md)

- User Interface
   - Main Menu
     - Team Settings 
        - [General Settings](help/team-settings/General-Settings.md) 
        - [Slack Import](help/team-settings/Slack-Import.md)
     - [Manage Members](help/Manage-Members.md)
   - Messaging
     - [Mattermost Markdown Formatting](usage/Markdown.md)
   - [Search](help/Search.md)
     
- System Console
  - Team
    - [Team Statistics](help/system-console/Team-Statistics.md)