diff options
Diffstat (limited to 'doc/install')
| -rw-r--r-- | doc/install/Amazon-Elastic-Beanstalk.md (renamed from doc/install/aws-ebs-setup.md) | 6 | ||||
| -rw-r--r-- | doc/install/Docker-Single-Container.md (renamed from doc/install/single-container-install.md) | 12 | ||||
| -rw-r--r-- | doc/install/Production-Ubuntu.md (renamed from doc/install/prod-ubuntu.md) | 17 | ||||
| -rw-r--r-- | doc/install/Release-Numbering.md (renamed from doc/install/release-numbering.md) | 0 | ||||
| -rw-r--r-- | doc/install/Requirements.md (renamed from doc/install/requirements.md) | 0 | ||||
| -rw-r--r-- | doc/install/SMTP-Email-Setup.md | 41 | ||||
| -rw-r--r-- | doc/install/dev-setup.md | 82 |
7 files changed, 58 insertions, 100 deletions
diff --git a/doc/install/aws-ebs-setup.md b/doc/install/Amazon-Elastic-Beanstalk.md index e186fa9c1..0416b67ea 100644 --- a/doc/install/aws-ebs-setup.md +++ b/doc/install/Amazon-Elastic-Beanstalk.md @@ -1,14 +1,14 @@ ## AWS Elastic Beanstalk Setup (Docker) -1. Create a new Elastic Beanstalk Docker application using the [Dockerrun.aws.zip](/docker/0.7/Dockerrun.aws.zip) file provided. +1. Create a new Elastic Beanstalk Docker application using the [Dockerrun.aws.zip](https://github.com/mattermost/platform/raw/master/docker/1.0/Dockerrun.aws.zip) file provided. 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 an IAM role and instance profile and press next. 6. For predefined configuration select under Generic: Docker. For environment type select single instance. - 7. For application source, select upload your own and upload Dockerrun.aws.zip from [Dockerrun.aws.zip](/docker/0.7/Dockerrun.aws.zip). Everything else may be left at default. + 7. For application source, select upload your own and upload Dockerrun.aws.zip from [Dockerrun.aws.zip](https://github.com/mattermost/platform/raw/master/docker/1.0/Dockerrun.aws.zip). 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. @@ -24,4 +24,4 @@ ### (Recommended) Enable Email The default single-container Docker instance for Mattermost is designed for product evaluation, and sets `ByPassEmail=true` so the product can run without enabling email, when doing so maybe difficult. - To see the product's full functionality, [enabling SMTP email is recommended](doc/config/smtp-email-setup.md). + To see the product's full functionality, [enabling SMTP email is recommended](SMTP-Email-Setup.md). diff --git a/doc/install/single-container-install.md b/doc/install/Docker-Single-Container.md index 772f3becf..4b952cd71 100644 --- a/doc/install/single-container-install.md +++ b/doc/install/Docker-Single-Container.md @@ -4,11 +4,11 @@ The following install instructions are for single-container installs of Mattermo ### Mac OSX ### -1. Install Boot2Docker using instructions at: http://docs.docker.com/installation/mac/ - 1. Start Boot2Docker from the command line and run: `boot2docker init eval “$(boot2docker shellinit)”` -2. Get your Docker IP address with: `boot2docker ip` +1. Install Docker Toolbox using instructions at: http://docs.docker.com/installation/mac/ + 1. Start Docker Toolbox from the command line and run: `docker-machine create -d virtualbox dev` +2. Get your Docker IP address with: `docker-machine ip dev` 3. Use `sudo nano /etc/hosts` to add `<Docker IP> dockerhost` to your /etc/hosts file -4. Run: `boot2docker shellinit` and copy the export statements to your ~/.bash\_profile by running `sudo nano ~/.bash_profile`. Then run: `source ~/.bash_profile` +4. Run: `docker-machine env dev` and copy the export statements to your ~/.bash\_profile by running `sudo nano ~/.bash_profile`. Then run: `source ~/.bash_profile` 5. Run: `docker run --name mattermost-dev -d --publish 8065:80 mattermost/platform` 6. When docker is done fetching the image, open http://dockerhost:8065/ in your browser. @@ -75,7 +75,7 @@ The following install instructions are for single-container installs of Mattermo ## Configuration Settings -There are a few configuration settings you might want to adjust when setting up your instance of Mattermost. You can edit them in [config/config.json](config/config.json) or [docker/0.6/config_docker.json](docker/0.6/config_docker.json) if you're running a Docker instance. +There are a few configuration settings you might want to adjust when setting up your instance of Mattermost. You can edit them in `config.json` or `config_docker.json` if you're running a Docker instance. * *EmailSettings*:*ByPassEmail* - If this is set to true, then users on the system will not need to verify their email addresses when signing up. In addition, no emails will ever be sent. * *ServiceSettings*:*UseLocalStorage* - If this is set to true, then your Mattermost server will store uploaded files in the storage directory specified by *StorageDirectory*. *StorageDirectory* must be set if *UseLocalStorage* is set to true. @@ -86,7 +86,7 @@ There are a few configuration settings you might want to adjust when setting up The default single-container Docker instance for Mattermost is designed for product evaluation, and sets `ByPassEmail=true` so the product can run without enabling email, when doing so maybe difficult. -To see the product's full functionality, [enabling SMTP email is recommended](/doc/config/smtp-email-setup.md). +To see the product's full functionality, [enabling SMTP email is recommended](SMTP-Email-Setup.md). ## Upgrading Mattermost diff --git a/doc/install/prod-ubuntu.md b/doc/install/Production-Ubuntu.md index 866b1bdbe..d2490062d 100644 --- a/doc/install/prod-ubuntu.md +++ b/doc/install/Production-Ubuntu.md @@ -6,7 +6,7 @@ * ``` sudo apt-get update``` * ``` sudo apt-get upgrade``` -## Setup Database Server +## Set up Database Server 1. For the purposes of this guide we will assume this server has an IP address of 10.10.10.1 1. Install PostgreSQL 9.3+ (or MySQL 5.2+) * ``` sudo apt-get install postgresql postgresql-contrib``` @@ -25,13 +25,13 @@ 1. You can exit the postgres account by typing: * ``` exit``` -## Setup Mattermost Server +## Set up Mattermost Server 1. For the purposes of this guide we will assume this server has an IP address of 10.10.10.2 1. Download the latest Mattermost Server by typing: * ``` wget https://github.com/mattermost/platform/releases/download/v1.0.0/mattermost.tar.gz``` 1. Unzip the Mattermost Server by typing: * ``` tar -xvzf mattermost.tar.gz``` -1. For the sake of making this guide simple we located the files at `/home/ubuntu/mattermost`, in the future we will give guidance for storing under `/opt`. +1. For the sake of making this guide simple we located the files at `/home/ubuntu/mattermost`. In the future we will give guidance for storing under `/opt`. 1. We have also elected to run the Mattermost Server as the `ubuntu` account for simplicity. We recommend settings up and running the service under a `mattermost` user account with limited permissions. 1. Create the storage directory for files. We assume you will have attached a large drive for storage of images and files. For this setup we will assume the directory is located at `/mattermost/data`. * Create the directory by typing: @@ -70,7 +70,7 @@ exec bin/platform * You should see a page titles *Mattermost - Signup* * You can also stop the process by running the command ` sudo stop mattermost`, but we will skip this step for now. -## Setup Nginx Server +## Set up Nginx Server 1. For the purposes of this guide we will assume this server has an IP address of 10.10.10.3 1. We use Nginx for proxying request to the Mattermost Server. The main benefits are: * SSL termination @@ -90,8 +90,7 @@ exec bin/platform 1. Configure Nginx to proxy connections from the internet to the Mattermost Server * Create a configuration for Mattermost * ``` sudo touch /etc/nginx/sites-available/mattermost``` - * Below is a sample configuration with the minimum settings required to configure Mattermost. - * + * Below is a sample configuration with the minimum settings required to configure Mattermost ``` server { server_name mattermost.example.com; @@ -118,7 +117,7 @@ exec bin/platform * ``` curl http://localhost``` * You should see a page titles *Mattermost - Signup* -## Setup Nginx with SSL (Recommended) +## Set up Nginx with SSL (Recommended) 1. You will need a SSL cert from a certificate authority. 1. For simplicity we will generate a test certificate. * ``` mkdir ~/cert``` @@ -177,9 +176,9 @@ exec bin/platform * Save the Settings 1. Update File Settings * Change *Local Directory Location* from `./data/` to `/mattermost/data` -1. Update Log Settings +1. Update Log Settings. * Set *Log to The Console* to false -1. Update Rate Limit Settings +1. Update Rate Limit Settings. * Set *Vary By Remote Address* to false * Set *Vary By HTTP Header* to X-Real-IP 1. Feel free to modify other settings. diff --git a/doc/install/release-numbering.md b/doc/install/Release-Numbering.md index 71374f7ef..71374f7ef 100644 --- a/doc/install/release-numbering.md +++ b/doc/install/Release-Numbering.md diff --git a/doc/install/requirements.md b/doc/install/Requirements.md index 1e0a12fb9..1e0a12fb9 100644 --- a/doc/install/requirements.md +++ b/doc/install/Requirements.md diff --git a/doc/install/SMTP-Email-Setup.md b/doc/install/SMTP-Email-Setup.md new file mode 100644 index 000000000..86e2bb20e --- /dev/null +++ b/doc/install/SMTP-Email-Setup.md @@ -0,0 +1,41 @@ + +## SMTP Email Setup + +In some product evaluation setups email is intentionally bypassed using a `ByPassEmail=true` option. This option allows account creation and system operation without having to set up an email service (e.g. no email verification is required for account creation). This also means neither email notifications nor password reset by email are available. + +To enable email, turn this option off by setting `ByPassEmail=false` and configuring an SMTP email service as follows: + +1. **Set up an SMTP email sending service.** (If you already have credentials for a SMTP server you can skip this step.) + 1. [Setup Amazon Simple Email Service](https://console.aws.amazon.com/ses) + 2. From the `SMTP Settings` menu click `Create My SMTP Credentials` + 3. Copy the `Server Name`, `Port`, `SMTP Username`, and `SMTP Password` + 4. From the `Domains` menu setup and verify a new domain. It it also a good practice to enable `Generate DKIM Settings` for this domain. + 5. Choose an email address like `feedback@example.com` for Mattermost to send emails from. + 6. Test sending an email from `feedback@example.com` by clicking the `Send a Test Email` button and verify everything appears to be working correctly. +2. **Modify the Mattermost configuration file config.json or config_docker.json with the SMTP information.** + 1. If you're running Mattermost on Amazon Beanstalk you can shell into the instance with the following commands + 2. `ssh ec2-user@[domain for the docker instance]` + 3. `sudo gpasswd -a ec2-user docker` + 4. Retrieve the name of the container with `sudo docker ps` + 5. `sudo docker exec -ti container_name /bin/bash` +3. **Edit the config file `vi /config_docker.json` with the settings you captured from the step above.** + 1. See an example below and notice `ByPassEmail` has been set to `false` + ``` bash + "EmailSettings": { + "ByPassEmail" : false, + "SMTPUsername": "AKIADTOVBGERKLCBV", + "SMTPPassword": "jcuS8PuvcpGhpgHhlcpT1Mx42pnqMxQY", + "SMTPServer": "email-smtp.us-east-1.amazonaws.com:465", + "UseTLS": true, + "FeedbackEmail": "feedback@example.com", + "FeedbackName": "Feedback", + "ApplePushServer": "", + "ApplePushCertPublic": "", + "ApplePushCertPrivate": "" + } + ``` +4. **Restart Mattermost** + 1. Find the process id with `ps -A` and look for the process named `platform` + 2. Kill the process `kill pid` + 3. The service should restart automatically. Verify the Mattermost service is running with `ps -A` + 4. Current logged in users will not be affected, but upon logging out or session expiration users will be required to verify their email address. diff --git a/doc/install/dev-setup.md b/doc/install/dev-setup.md deleted file mode 100644 index b90b6a351..000000000 --- a/doc/install/dev-setup.md +++ /dev/null @@ -1,82 +0,0 @@ -Developer Machine Setup ------------------------------ - -### Mac OS X ### - -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 (version 1.4.2) 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. Run `ruby -v` and check the ruby version is 1.8.7 or higher - 2. `sudo gem install compass` -6. Download Mattermost - `cd ~/go` - `mkdir -p src/github.com/mattermost` - `cd src/github.com/mattermost` - `git clone https://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 - -### Ubuntu ### - -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 (version 1.4.2) 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 https://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 |