From 3f781fdaf977e3103b12deb266ef39a8df64bff0 Mon Sep 17 00:00:00 2001 From: it33 Date: Thu, 30 Jul 2015 08:36:13 -0700 Subject: Removing unnecessary "the" --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index f0857e99d..4ba3de128 100644 --- a/README.md +++ b/README.md @@ -19,8 +19,8 @@ Learn More
  • Make a pull request: http://www.mattermost.org/contribute-to-mattermost/
  • -Installing the Mattermost -========================= +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. -- cgit v1.2.3-1-g7c22 From b1993dc02c5db182e314c2e3c910e6942cbb024f Mon Sep 17 00:00:00 2001 From: JoramWilander Date: Thu, 30 Jul 2015 12:59:29 -0400 Subject: update readme with basic config settings setup information --- README.md | 28 +++++++++++++++++++--------- 1 file changed, 19 insertions(+), 9 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 4ba3de128..7093f9902 100644 --- a/README.md +++ b/README.md @@ -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 ------- -- cgit v1.2.3-1-g7c22 From 70669c51103a1ff040e9482b6686d7fc8ff5fad8 Mon Sep 17 00:00:00 2001 From: JoramWilander Date: Fri, 31 Jul 2015 13:22:32 -0400 Subject: replaced 'fiddle' with 'adjust' to be more clear --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 7093f9902..55be7bbaf 100644 --- a/README.md +++ b/README.md @@ -116,7 +116,7 @@ AWS Elastic Beanstalk Setup (Docker) 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. +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 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. -- cgit v1.2.3-1-g7c22 From d39e10c16bd1920a6869a43fca956904f4d950f3 Mon Sep 17 00:00:00 2001 From: it33 Date: Fri, 31 Jul 2015 21:49:10 -0700 Subject: Update to give credit to MongoDB on licensing --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 55be7bbaf..55d1383a8 100644 --- a/README.md +++ b/README.md @@ -131,5 +131,5 @@ To contribute to this open source project please review the Mattermost Contribut License ------- -Mattermost is licensed under an "Apache-wrapped AGPL" model, which means you can run and link to the system using Configuration Files and Admin Tools licensed under Apache, version 2.0, as described in the LICENSE file, as an explicit exception to the terms of the GNU Affero General Public License (AGPL) that applies to most of the remaining source files. See individual files for details. +Mattermost is licensed under an "Apache-wrapped AGPL" model inspired by MongoDB. Similar to MongoDB, you can run and link to the system using Configuration Files and Admin Tools licensed under Apache, version 2.0, as described in the LICENSE file, as an explicit exception to the terms of the GNU Affero General Public License (AGPL) that applies to most of the remaining source files. See individual files for details. -- cgit v1.2.3-1-g7c22