diff options
| author | JoramWilander <jwawilander@gmail.com> | 2015-07-30 12:59:29 -0400 |
|---|---|---|
| committer | JoramWilander <jwawilander@gmail.com> | 2015-07-30 12:59:29 -0400 |
| commit | b1993dc02c5db182e314c2e3c910e6942cbb024f (patch) | |
| tree | 4e64a46613c9a37f3b860e585ec1dc1868f8b887 /README.md | |
| parent | c09beaa655789ff3b60418af784f2ca75d0c268d (diff) | |
| download | chat-b1993dc02c5db182e314c2e3c910e6942cbb024f.tar.gz chat-b1993dc02c5db182e314c2e3c910e6942cbb024f.tar.bz2 chat-b1993dc02c5db182e314c2e3c910e6942cbb024f.zip | |
update readme with basic config settings setup information
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 28 |
1 files changed, 19 insertions, 9 deletions
@@ -1,5 +1,5 @@ -**Mattermost Alpha** -**Team Communication Service** +**Mattermost Alpha** +**Team Communication Service** **Development Build** @@ -22,9 +22,9 @@ Learn More Installing Mattermost ===================== -You're installing "Mattermost Alpha", a pre-released 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 production release. +You're installing "Mattermost Alpha", a pre-released 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 production release. -That said, any issues at all, please let us know on the Mattermost forum at: http://forum.mattermost.org +That said, any issues at all, please let us know on the Mattermost forum at: http://forum.mattermost.org Local Machine Setup (Docker) ----------------------------- @@ -77,7 +77,7 @@ Local Machine Setup (Docker) ### Notes ### If your ISP blocks port 25 then you may install locally but email will not be sent. -If you want to work with the latest bits in the repo you can run the cmd +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 @@ -113,10 +113,20 @@ AWS Elastic Beanstalk Setup (Docker) 14. Wait for beanstalk to update the environment. 15. Try it out by entering the domain of the form \*.elasticbeanstalk.com found at the top of the dashboard into your browser. You can also map your own domain if you wish. -Contributing ------------- - -To contribute to this open source project please review the Mattermost Contribution Guidelines at http://www.mattermost.org/contribute-to-mattermost/. +Configuration Settings +---------------------- + +There are a few configuration settings you might want to fiddle with when setting up your instance of Mattermost. You can edit them in ./config/config.json or ./config/config/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. + +Contributing +------------ + +To contribute to this open source project please review the Mattermost Contribution Guidelines at http://www.mattermost.org/contribute-to-mattermost/. License ------- |