diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 67 |
1 files changed, 53 insertions, 14 deletions
@@ -60,7 +60,7 @@ Local Machine Setup (Docker) 3. When docker is done fetching the image, open http://localhost:8065/ in your browser. ### Arch ### -1. Install docker using the following commands: +1. Install Docker using the following commands: ``` bash pacman -S docker @@ -70,13 +70,13 @@ Local Machine Setup (Docker) newgrp docker ``` -2. Start docker container: +2. Start Docker container: ``` bash docker run --name mattermost-dev -d --publish 8065:80 mattermost/platform ``` -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. ### Additional Notes ### - If you want to work with the latest master from the repository (i.e. not a stable release) you can run the cmd: @@ -85,7 +85,7 @@ Local Machine Setup (Docker) docker run --name mattermost-dev -d --publish 8065:80 mattermost/platform:dev ``` -- Instructions on how to update your docker image are found below. +- Instructions on how to update your Docker image are found below. - If you wish to remove mattermost-dev use: @@ -103,7 +103,7 @@ Local Machine Setup (Docker) AWS Elastic Beanstalk Setup (Docker) ------------------------------------ -1. Create a new elastic beanstalk docker application using the [Dockerrun.aws.json](docker/0.6/Dockerrun.aws.json) file provided. +1. Create a new Elastic Beanstalk Docker application using the [Dockerrun.aws.json](docker/0.6/Dockerrun.aws.json) 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. @@ -125,41 +125,80 @@ AWS Elastic Beanstalk Setup (Docker) 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/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. * *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. * *ServiceSettings*:*StorageDirectory* - The file path where files will be stored locally if *UseLocalStorage* is set to true. The operating system user that is running the Mattermost application must have read and write privileges to this directory. * *AWSSettings*:*S3*\* - If *UseLocalStorage* is set to false, and the S3 settings are configured here, then Mattermost will store files in the provided S3 bucket. -Upgrading Mattermost ---------------------- +Email Setup (Optional) +---------------------- + +1. Setup an 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` +2. Edit the config file `vi /config_docker.json` with the settings you captured from the step above. 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": "" +} +``` + +3. 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. + +Upgrading Mattermost Preview +---------------------------- ### Docker ### -To upgrade your docker image to the latest release (NOTE: this will destroy all data in the docker container): +To upgrade your Docker image to a preview of the latest stable release (NOTE: this will erase all data in the Docker container, including the database): -1. Stop your docker container by running: +1. Stop your Docker container by running: ``` bash docker stop mattermost-dev ``` -2. Delete your docker container by running: +2. Delete your Docker container by running: ``` bash docker rm mattermost-dev ``` -3. Update your docker image by running: +3. Update your Docker image by running: ``` bash docker pull mattermost/platform ``` -4. Start your docker container by running: +4. Start your Docker container by running: ``` bash docker run --name mattermost-dev -d --publish 8065:80 mattermost/platform ``` -To upgrade to the latest master from the repository replace `mattermost/platform` with `mattermost/platform:dev` in the above instructions. +To upgrade to the latest development build on master from the repository replace `mattermost/platform` with `mattermost/platform:dev` in the instructions 3) and 4) above. Contributing ------------ |