From 0377d68335b38b09c0693e5b2833ddecfb3e4dc6 Mon Sep 17 00:00:00 2001 From: =Corey Hulen Date: Thu, 18 Jun 2015 23:14:43 -0800 Subject: Updating readme --- README.md | 97 +++++++++++++++++++++++++++++---------------------- scripts/README_DEV.md | 42 ++++++++++++++++++++++ 2 files changed, 97 insertions(+), 42 deletions(-) create mode 100644 scripts/README_DEV.md diff --git a/README.md b/README.md index c3e844f61..f8d269f9a 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ -**Mattermost Preview
** -**Team Communication Service
** +**Mattermost Preview** +**Team Communication Service** **Version 0.40** What matters most to your team? =============================== -Words have power.
-Mattermost serves teams who use words to shape the future.
+Words have power. +Mattermost serves teams who use words to shape the future. The words you choose are up to you. *- SpinPunch* @@ -18,49 +18,62 @@ You're installing "Mattermost Preview", a pre-released 0.40 version intended for That said, any issues at all, please let us know on the Mattermost forum at: http://bit.ly/1MY1kul -Developer Machine Setup (Mac) ------------------------------ +Developer Machine Setup (Docker/Mac) +------------------------------------ -DOCKER SETUP - -1. Follow the instructions at http://docs.docker.com/installation/mac/ -
a) Use the Boot2Docker command-line utility -
b) If you do command-line setup use: `boot2docker init eval “$(boot2docker shellinit)”` +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 ` dockerhost` -4. Run `boot2docker shellinit` and copy the export statements to your ~/.bash_profile - -Any issues? Please let us know on our forums at: http://bit.ly/1MY1kul - -GO SETUP - -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 - -Any issues? Please let us know on our forums at: http://bit.ly/1MY1kul +3. Add a line to your /etc/hosts that goes ` dockerhost` +4. Run `boot2docker shellinit` and copy the export statements to your ~/.bash_profile +5. Run `docker run --name mattermost-dev -d --publish 8065:80 mattermost/platform:helium` +6. When docker is done fetching the image, open http://dockerhost:8065/ in your browser + +If you want to work with the latest bits in the repo you can run the cmd `docker run --name mattermost-dev -d --publish 8065:80 mattermost/platform:latest` +You can update to the latest bits by running `docker pull mattermost/platform:latest` + +If you wish to remove mattermost-dev use the following commands +1. docker stop mattermost-dev +2. docker rm -v mattermost-dev + +AWS Elastic Beanstalk Setup (Docker) +------------------------------------ + +1. From the AWS console select Elastic Beanstalk +2. Select "Create New Application" from the top right. +3. Name the application and press next +4. Select "Create a web server" environment. +5. If asked, select create and AIM role and instance profile and press next. +6. For predefined configuration select docker. Environment type may be left at default. +7. For application source, select upload your own and upload Dockerrun.aws.json from docker/Dockerrun.aws.json. Everything else may be left at default. +8. Select an environment name, this is how you will refer to your environment. Make sure the URL is available then press next. +9. The options on the additional resources page may be left at default unless you wish to change them. Press Next. +10. On the configuration details place. Select an instance type of t2.small or larger. +11. You can set the configuration details as you please but they may be left at their defaults. When you are done press next. +12. Environment tags my be left blank. Press next. +13. You will be asked to review your information. Press Launch. +14. Up near the top of the dashboard you will see a domain of the form \*.elasticbeanstalk.com copy this as you will need it later. + +15. From the AWS console select route 53 +16. From the sidebar select Hosted Zones +17. Select the domain you want to use or create a new one. +18. Modify an existing CNAME record set or create a new one with the name * and the value of the domain you copied in step 13. +19. Save the record set + +20. Return the Elastic Beanstalk from the AWS console. +21. Select the environment you created. +22. Select configuration from the sidebar. +23. Click the gear beside software configuration. +24. Add an environment property with the name “MATTERMOST\_DOMAIN” and a value of the domain you mapped in route 53. For example if your domain is \*.example.com you would enter example.com not www.example.com. +25. Select apply. +26. Return to the dashboard on the sidebar and wait for beanstalk update the environment. +27. Try it out by entering the domain you mapped into your browser. License ------- -This software uses the Apache 2.0 open source license. For more details see: http://bit.ly/1Lc25Sv
+This software uses the Apache 2.0 open source license. For more details see: http://bit.ly/1Lc25Sv + **XXXXXX TODO: Test install procedures** diff --git a/scripts/README_DEV.md b/scripts/README_DEV.md new file mode 100644 index 000000000..6a2dfc54d --- /dev/null +++ b/scripts/README_DEV.md @@ -0,0 +1,42 @@ +Developer Machine Setup (Mac) +----------------------------- + +DOCKER SETUP + +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 ` dockerhost` +4. Run `boot2docker shellinit` and copy the export statements to your ~/.bash_profile + +Any issues? Please let us know on our forums at: http://bit.ly/1MY1kul + +GO SETUP + +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 + +Any issues? Please let us know on our forums at: http://bit.ly/1MY1kul \ No newline at end of file -- cgit v1.2.3-1-g7c22