Set up your development environment for building, running, and testing Mattermost.
Increase the number of available file descriptors. Update your shell’s initialization script (e.g.
.zshrc), and add the following:
ulimit -n 8096
Install NVM and use it to install the required version of Node.js:
First, install NVM by following these instructions.
Then, use NVM to install the correct version of Node.js for the Mattermost web app:
If you don’t have it already, install libpng with your preferred package manager.
Clone the Mattermost source code from your fork:
git clone https://github.com/YOUR_GITHUB_USERNAME/mattermost-server.git
Start the server:
cd server make run-server
Test your environment:
If successful, the
curl step will return a JSON object:
Run the webapp and watch:
Stop the server:
stop-server make target does not stop all the docker containers started by
run-server. To stop the running docker containers:
Set your options:
Some behaviors can be customized such as running the server in the foreground as described in the
config.mk file in the server directory. See that file for details.
Your feedback helps us improve the Mattermost developer documentation.
Have a feature request? Share it here.
Having issues? Join our Community server.