Installing Developer Components on Mac OS X

Set up your development environment for building, running, and testing Mattermost.

1. If you are developing with the Docker container, install and configure Docker CE:

1. Follow the Docker installation instructions at https://docs.docker.com/docker-for-mac/.
2. Edit your /etc/hosts file to include the following line:

127.0.0.1     dockerhost

2. Download and install Brew, which you’ll use for installing dependencies. Follow the Brew installation instructions at https://brew.sh/
3. Install Node.js, Yarn, libpng, and Go:

brew install node yarn libpng go

4. Set up your Go workspace:

1. mkdir ~/go
2. Add the following lines to your ~/.bashprofile file:

export GOPATH=$HOME/go
export PATH=$PATH:$GOPATH/bin
export PATH=$PATH:/usr/local/go/bin
ulimit -n 8096

3. Reload your bash configuration.

source ~/.bashprofile

5. Fork Mattermost on GitHub from https://github.com/mattermost/platform.
6. Download the Mattermost code from your forked repository:

1. Create the directory for the code.

mkdir -p ~/go/src/github.com/mattermost

2. Change to the directory that you created.

cd ~/go/src/github.com/mattermost

3. Clone your Mattermost fork. In the following command, replace {username} with your GitHub username.

git clone https://github.com/{username}/platform.git

Now that everything is set up, you are ready to compile and run Mattermost. See Compiling Mattermost.