diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 62 |
1 files changed, 35 insertions, 27 deletions
@@ -16,7 +16,7 @@ Installing the Mattermost You're installing "Mattermost Preview", a pre-released 0.50 version intended for an early look at what we're building. While SpinPunch runs this version internally, it's not recommended for production deployments since we can't guarantee API stability or backwards compatibility until our 1.0 version release. -That said, any issues at all, please let us know on the Mattermost forum at: http://bit.ly/1MY1kul +That said, any issues at all, please let us know on the Mattermost forum at: http://discourse.mattermost.org Local Machine Setup (Docker) ----------------------------- @@ -33,38 +33,38 @@ Local Machine Setup (Docker) 6. When docker is done fetching the image, open http://dockerhost:8065/ in your browser ### Ubuntu ### -1. Follow the instructions at https://docs.docker.com/installation/ubuntulinux/ or use the summery 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. Run `docker run --name mattermost-dev -d --publish 8065:80 mattermost/platform:helium +1. Follow the instructions at https://docs.docker.com/installation/ubuntulinux/ or use the summary below. + + ``` bash + 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. Run `docker run --name mattermost-dev -d --publish 8065:80 mattermost/platform:helium` 3. When docker is done fetching the image, open http://localhost:8065/ in your browser ### Arch ### -1. Install docker using the following commands - -`pacman -S docker` - -`systemctl enable docker.service` +1. Install docker using the following commands: -`systemctl start docker.service` + ``` bash + pacman -S docker + systemctl enable docker.service + systemctl start docker.service + gpasswd -a <username> docker + newgrp docker + ``` -`gpasswd -a <username> docker` +2. Start docker container: -`newgrp docker` + ``` bash + docker run --name mattermost-dev -d --publish 8065:80 mattermost/platform:helium + ``` -2. docker run --name mattermost-dev -d --publish 8065:80 mattermost/platform:helium -3. When docker is done fetching the image, open http://localhost:8065/ in your browser +3. When docker is done fetching the image, open http://localhost:8065/ in your browser. ### Notes ### If your ISP blocks port 25 then you may install locally but email will not be sent. @@ -80,6 +80,8 @@ If you wish to remove mattermost-dev use the following commands 1. `docker stop mattermost-dev` 2. `docker rm -v mattermost-dev` +If you wish to gain access to the container use the following commands +1. `docker exec -ti mattermost-dev /bin/bash` AWS Elastic Beanstalk Setup (Docker) ------------------------------------ @@ -107,7 +109,7 @@ AWS Elastic Beanstalk Setup (Docker) 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 1.13. 19. Save the record set -3. Set the enviroment variable "MATTERMOST\_DOMAIN" to the domain you mapped above (example.com not www.example.com) +3. Set the environment variable "MATTERMOST\_DOMAIN" to the domain you mapped above (example.com not www.example.com) 20. Return the Elastic Beanstalk from the AWS console. 21. Select the environment you created. 22. Select configuration from the sidebar. @@ -119,6 +121,11 @@ AWS Elastic Beanstalk Setup (Docker) 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. +Contributing +------------ + +To contribute to this open source project please review the Mattermost Contribution Guidelines at http://www.mattermost.org/contribute-to-mattermost/. + License ------- @@ -126,3 +133,4 @@ Most Mattermost source files are made available under the terms of the GNU Affer As an exception, Admin Tools and Configuration Files are are made available under the terms of the Apache License, version 2.0. See LICENSE.txt for more information. + |