mirror of
https://github.com/mattermost/mattermost.git
synced 2026-08-26 21:27:40 -05:00
Merge pull request #300 from hmhealey/ubuntudev
Updated developer setup instructions for Ubuntu
This commit is contained in:
Corey Hulen
+73
-33
@@ -1,42 +1,82 @@
|
||||
Developer Machine Setup (Mac)
|
||||
Developer Machine Setup
|
||||
-----------------------------
|
||||
|
||||
DOCKER SETUP
|
||||
### Mac OS X ###
|
||||
|
||||
1. Follow the instructions at http://docs.docker.com/installation/mac/
|
||||
1. Use the Boot2Docker command-line utility
|
||||
2. If you do command-line setup use: `boot2docker init eval “$(boot2docker shellinit)”`
|
||||
2. Get your Docker IP address with `boot2docker ip`
|
||||
3. Add a line to your /etc/hosts that goes `<Docker IP> dockerhost`
|
||||
4. Run `boot2docker shellinit` and copy the export statements to your ~/.bash_profile
|
||||
1. Download and set up Boot2Docker
|
||||
1. Follow the instructions at http://docs.docker.com/installation/mac/
|
||||
1. Use the Boot2Docker command-line utility
|
||||
2. If you do command-line setup use: `boot2docker init eval “$(boot2docker shellinit)”`
|
||||
2. Get your Docker IP address with `boot2docker ip`
|
||||
3. Add a line to your /etc/hosts that goes `<Docker IP> dockerhost`
|
||||
4. Run `boot2docker shellinit` and copy the export statements to your ~/.bash_profile
|
||||
2. Download Go from http://golang.org/dl/
|
||||
3. Set up your Go workspace
|
||||
1. `mkdir ~/go`
|
||||
2. Add the following to your ~/.bash_profile
|
||||
`export GOPATH=$HOME/go`
|
||||
`export PATH=$PATH:$GOPATH/bin`
|
||||
3. Reload your bash profile
|
||||
`source ~/.bash_profile`
|
||||
4. Install Node.js using Homebrew
|
||||
1. Download Homebrew from http://brew.sh/
|
||||
2. `brew install node`
|
||||
5. Install Compass
|
||||
1. Make sure you have the latest verison of Ruby
|
||||
2. `gem install compass`
|
||||
6. Download Mattermost
|
||||
`cd ~/go`
|
||||
`mkdir -p src/github.com/mattermost`
|
||||
`cd src/github.com/mattermost`
|
||||
`git clone github.com/mattermost/platform.git`
|
||||
`cd platform`
|
||||
7. Run unit tests on Mattermost using `make test` to make sure the installation was successful
|
||||
8. If tests passed, you can now run Mattermost using `make run`
|
||||
|
||||
Any issues? Please let us know on our forums at: http://forum.mattermost.org
|
||||
|
||||
GO SETUP
|
||||
### Ubuntu ###
|
||||
|
||||
1. Download Go from http://golang.org/dl/
|
||||
|
||||
NODE.JS SETUP
|
||||
|
||||
1. Install homebrew from http://brew.sh
|
||||
2. `brew install node`
|
||||
|
||||
COMPASS SETUP
|
||||
|
||||
1. Make sure you have the latest version of Ruby
|
||||
2. `gem install compass`
|
||||
|
||||
MATTERMOST SETUP
|
||||
|
||||
1. Make a project directory for Mattermost, which we'll call **$PROJECT** for the rest of these instructions
|
||||
2. Make a `go` directory in your $PROJECT directory
|
||||
3. Open or create your ~/.bash_profile and add the following lines:
|
||||
`export GOPATH=$PROJECT/go`
|
||||
`export PATH=$PATH:$GOPATH/bin`
|
||||
then refresh your bash profile with `source ~/.bash_profile`
|
||||
4. Then use `cd $GOPATH` and `mkdir -p src/github.com/mattermost` then cd into this directory and run `git clone github.com/mattermost/platform.git`
|
||||
5. If you do not have Mercurial, download it with: `brew install mercurial`
|
||||
6. Then do `cd platform` and `make test`. Provided the test runs fine, you now have a complete build environment.
|
||||
7. Use `make run` to run your code
|
||||
1. Download Docker
|
||||
1. Follow the instructions at https://docs.docker.com/installation/ubuntulinux/ or use the summary below:
|
||||
`sudo apt-get update`
|
||||
`sudo apt-get install wget`
|
||||
`wget -qO- https://get.docker.com/ | sh`
|
||||
`sudo usermod -aG docker <username>`
|
||||
`sudo service docker start`
|
||||
`newgrp docker`
|
||||
2. Set up your dockerhost address
|
||||
1. Edit your /etc/hosts file to include the following line
|
||||
`127.0.0.1 dockerhost`
|
||||
3. Install build essentials
|
||||
1. `apt-get install build-essential`
|
||||
4. Download Go from http://golang.org/dl/
|
||||
5. Set up your Go workspace and add Go to the PATH
|
||||
1. `mkdir ~/go`
|
||||
2. Add the following to your ~/.bashrc
|
||||
`export GOPATH=$HOME/go`
|
||||
`export GOROOT=/usr/local/go`
|
||||
`export PATH=$PATH:$GOROOT/bin`
|
||||
3. Reload your bashrc
|
||||
`source ~/.bashrc`
|
||||
6. Install Node.js
|
||||
1. Download the newest version of the Node.js sources from https://nodejs.org/download/
|
||||
2. Extract the contents of the package and cd into the extracted files
|
||||
3. Compile and install Node.js
|
||||
`./configure`
|
||||
`make`
|
||||
`make install`
|
||||
7. Install Ruby and Compass
|
||||
`apt-get install ruby`
|
||||
`apt-get install ruby-dev`
|
||||
`gem install compass`
|
||||
8. Download Mattermost
|
||||
`cd ~/go`
|
||||
`mkdir -p src/github.com/mattermost`
|
||||
`cd src/github.com/mattermost`
|
||||
`git clone github.com/mattermost/platform.git`
|
||||
`cd platform`
|
||||
9. Run unit tests on Mattermost using `make test` to make sure the installation was successful
|
||||
10. If tests passed, you can now run Mattermost using `make run`
|
||||
|
||||
Any issues? Please let us know on our forums at: http://forum.mattermost.org
|
||||
|
||||
Reference in New Issue
Block a user