Getting Started Server Web App Mobile Apps Redux Desktop App Mattermost Dev Talks Mattermost Contributors MVP

Edit on GitHub

Install and setup Docker.
- If you are using Windows 10 Pro or Enterprise, you can use Docker for Windows: https://docs.docker.com/docker-for-windows/
- For other Windows versions, or if you prefer to use VirtualBox, use Docker Toolbox: https://docs.docker.com/toolbox/toolbox_install_windows/
Note: MM-9791 introduced using docker-compose to manage containers. To preserve your data on upgrade, execute the following steps.

First, backup from any existing containers:
```
mysqldump -h 127.0.0.1 --column-statistics=0 -u mmuser -p mattermost_test > mm_mysql_backup.sql
pg_dump -U mmuser -W -d mattermost_test -h 127.0.0.1 > mm_postgres_backup.bak
```
Then after upgrading and starting the new docker-compose managed containers, restore the data:
```
mysql -u mmuser -p -h 127.0.0.1 mattermost_test < mm_mysql_backup.sql
psql -U mmuser -W -h 127.0.0.1 -f mm_postgres_backup.bak mattermost_test
```
If you don’t migrate your data, the new, docker-compose-managed containers will start out empty. To remove the old containers – destroying any existing data – use make clean-old-docker.
Download and install Go from https://golang.org/dl/
Install and setup babun from http://babun.github.io/

Setup the following environment variables (change the paths accordingly):

export PATH="/c/Program Files/go/bin":$PATH
export PATH="/c/Program Files/nodejs":$PATH
export PATH="/c/Program Files/Git/bin":$PATH
export GOROOT="c:\\Program Files\\go"
export GOPATH="c:\\User\\{user-name}\\go"
export PATH="/c/Program Files/Docker Toolbox":$PATH # change the path accordingly if you are using Docker for Windows
eval $(docker-machine env default) # skip this line if you are using Docker for Windows

Fork https://github.com/mattermost/mattermost-server

Clone the Mattermost source code from your fork:

git clone https://github.com/YOUR_GITHUB_USERNAME/mattermost-server.git

Start the server and test your environment:
```
cd mattermost-server
make run-server
curl http://localhost:8065/api/v4/system/ping
make stop-server
```
If successful, the curl step will return a JSON object containing "status":"OK".

Note: Browsing directly to http://localhost:8065/ will display a 404 Not Found until the web app is configured. See Web App Developer Setup and Mobile App Developer Setup for additional setup.

The stop-server make target does not stop all the docker containers started by run-server. To stop the running docker containers:
```
make stop-docker
```