From a6c68daef94dbe5f943892f62d82e8edcd734533 Mon Sep 17 00:00:00 2001 From: it33 Date: Fri, 3 Feb 2017 20:33:53 -0800 Subject: [PATCH 01/13] Maintenance info page Drafting maintenance info page to server as a template for other open source projects --- MAINTENANCE.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 MAINTENANCE.md diff --git a/MAINTENANCE.md b/MAINTENANCE.md new file mode 100644 index 0000000..61630a1 --- /dev/null +++ b/MAINTENANCE.md @@ -0,0 +1,47 @@ +# Maintenance + +[Project Name](https://docs.mattermost.com/guides/orchestration.html#branding) +- Multi-Node Docker image for Mattermost by the Mattermost open source project + + +## Maintainers + +| Current Maintainer(s) | Start Date | +|:-----------------------|:--------------| +| Pan Luo - @xcompass | 2015-11-30 | + + + +| Sponsoring Organization | Start Date | +|:-------------------------------|:--------------| +| Mattermost Open Source Project | 2015-11-30 | + + +## Getting Started + +1. Subscribe to [Mattermost Security Update Mailing List](http://mattermost.us11.list-manage.com/subscribe?u=6cdba22349ae374e188e7ab8e&id=3a93eb6929) +2. Subscribe to [Mattermost Insiders Newsletter](http://mattermost.us11.list-manage.com/subscribe?u=6cdba22349ae374e188e7ab8e&id=2add1c8034) + +## Updating + +When a new security update or major version of Mattermost is released, update the version number of + +## Credits + +PREVIOUS MAINTAINERS + +- 2015-11-30 to 2015-11-30 @npcode + +| Creator | Start Date | End Date | +|:-----------------------|:--------------|:-----------| +| Yi EungJun - @npcode | 2015-11-30 | + + +CREATOR + +| Creator | Created Date | +|:-----------------------|:--------------| +| Yi EungJun - @npcode | 2015-11-30 | + + + From 062bfeafc73e819b9e94e66fad9032444a45a145 Mon Sep 17 00:00:00 2001 From: it33 Date: Fri, 3 Feb 2017 20:56:53 -0800 Subject: [PATCH 02/13] Update MAINTENANCE.md --- MAINTENANCE.md | 37 ++++++++++++++++++++++++------------- 1 file changed, 24 insertions(+), 13 deletions(-) diff --git a/MAINTENANCE.md b/MAINTENANCE.md index 61630a1..d987d98 100644 --- a/MAINTENANCE.md +++ b/MAINTENANCE.md @@ -1,40 +1,53 @@ # Maintenance -[Project Name](https://docs.mattermost.com/guides/orchestration.html#branding) -- Multi-Node Docker image for Mattermost by the Mattermost open source project +This file outlines the current maintainer(s) of this open source project and expectations. It also includes credits to past maintainers and the project creator. +## Project Name -## Maintainers +When reference externally, this project should be called: + +- Multi-node Docker image for Mattermost by the Mattermost open source project + +## Maintainer(s) + +The following people help to maintain this open source project: | Current Maintainer(s) | Start Date | |:-----------------------|:--------------| | Pan Luo - @xcompass | 2015-11-30 | - +In case something happens where a maintainer is unable to complete their responsibilies or find a new maintainer, the following sponsoring organization can help find a new maintainer: | Sponsoring Organization | Start Date | |:-------------------------------|:--------------| | Mattermost Open Source Project | 2015-11-30 | -## Getting Started +## Maintainer Guide -1. Subscribe to [Mattermost Security Update Mailing List](http://mattermost.us11.list-manage.com/subscribe?u=6cdba22349ae374e188e7ab8e&id=3a93eb6929) -2. Subscribe to [Mattermost Insiders Newsletter](http://mattermost.us11.list-manage.com/subscribe?u=6cdba22349ae374e188e7ab8e&id=2add1c8034) +The following is a guide for current and new maintainers of this open source project to get started and to understand on-going responsibilities: + +### Getting Started + +The following steps should be completed by a new maintainer + +1. **Add your name** - Create a pull request to add your name, GitHub username and start date to this document. +2. **Subscribe to mailings** - To be notified of new releases and security updates of Mattermost, subscribe to the [Mattermost Security Update Mailing List](http://mattermost.us11.list-manage.com/subscribe?u=6cdba22349ae374e188e7ab8e&id=3a93eb6929) and the [Mattermost Insiders Newsletter](http://mattermost.us11.list-manage.com/subscribe?u=6cdba22349ae374e188e7ab8e&id=2add1c8034) ## Updating -When a new security update or major version of Mattermost is released, update the version number of +When receive a mailing list email about a new security update or major version of Mattermost being released, update the version number of this project by doing the following: + +- Change the [version number](https://github.com/mattermost/mattermost-docker/blob/master/app/Dockerfile#L6) in the **master branch** to pull in the latest Mattermost Team Edition release +- Change the [version number](https://github.com/mattermost/mattermost-docker/blob/team-and-enterprise/app/Dockerfile#L6) in the **the team-and-enterprise branch** to pull in the latest Mattermost Enterprise Edition release ## Credits PREVIOUS MAINTAINERS -- 2015-11-30 to 2015-11-30 @npcode - | Creator | Start Date | End Date | |:-----------------------|:--------------|:-----------| -| Yi EungJun - @npcode | 2015-11-30 | +| Yi EungJun - @npcode | 2015-11-30 | 2015-11-30 | CREATOR @@ -43,5 +56,3 @@ CREATOR |:-----------------------|:--------------| | Yi EungJun - @npcode | 2015-11-30 | - - From b6c13555dc898a1ad8d001fb172ff5c86c7a7386 Mon Sep 17 00:00:00 2001 From: it33 Date: Fri, 3 Feb 2017 21:01:22 -0800 Subject: [PATCH 03/13] Update MAINTENANCE.md --- MAINTENANCE.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/MAINTENANCE.md b/MAINTENANCE.md index d987d98..f4ccda3 100644 --- a/MAINTENANCE.md +++ b/MAINTENANCE.md @@ -1,4 +1,4 @@ -# Maintenance +# Maintainer Guide This file outlines the current maintainer(s) of this open source project and expectations. It also includes credits to past maintainers and the project creator. @@ -25,7 +25,7 @@ In case something happens where a maintainer is unable to complete their respons ## Maintainer Guide -The following is a guide for current and new maintainers of this open source project to get started and to understand on-going responsibilities: +The following is a guide for current, new maintainers and prospective maintainers of this open source project to get started and to understand on-going responsibilities: ### Getting Started @@ -41,6 +41,10 @@ When receive a mailing list email about a new security update or major version o - Change the [version number](https://github.com/mattermost/mattermost-docker/blob/master/app/Dockerfile#L6) in the **master branch** to pull in the latest Mattermost Team Edition release - Change the [version number](https://github.com/mattermost/mattermost-docker/blob/team-and-enterprise/app/Dockerfile#L6) in the **the team-and-enterprise branch** to pull in the latest Mattermost Enterprise Edition release +## Issue and Pull Request Review + +Maintainer(s) should periodically review pull requests and issues submitted to provide feedback and to merge pull request changes when the maintainer feels the change would be appropriate. + ## Credits PREVIOUS MAINTAINERS From adca09354c16be17ef5d607785fbccf73bd4d1d7 Mon Sep 17 00:00:00 2001 From: it33 Date: Fri, 3 Feb 2017 21:35:32 -0800 Subject: [PATCH 04/13] Correcting dates --- MAINTENANCE.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/MAINTENANCE.md b/MAINTENANCE.md index f4ccda3..87ea8af 100644 --- a/MAINTENANCE.md +++ b/MAINTENANCE.md @@ -20,7 +20,7 @@ In case something happens where a maintainer is unable to complete their respons | Sponsoring Organization | Start Date | |:-------------------------------|:--------------| -| Mattermost Open Source Project | 2015-11-30 | +| Mattermost Open Source Project | 2016-04-12 | ## Maintainer Guide @@ -51,12 +51,12 @@ PREVIOUS MAINTAINERS | Creator | Start Date | End Date | |:-----------------------|:--------------|:-----------| -| Yi EungJun - @npcode | 2015-11-30 | 2015-11-30 | +| Yi EungJun - @npcode | 2015-11-30 | 2015-11-26 | CREATOR | Creator | Created Date | |:-----------------------|:--------------| -| Yi EungJun - @npcode | 2015-11-30 | +| Yi EungJun - @npcode | 2015-11-26 | From 3a9ae11c9bab846b71199464d189e14208f2e3c3 Mon Sep 17 00:00:00 2001 From: it33 Date: Fri, 3 Feb 2017 21:42:44 -0800 Subject: [PATCH 05/13] Minor formatting and naming changes --- MAINTENANCE.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/MAINTENANCE.md b/MAINTENANCE.md index 87ea8af..7c8addd 100644 --- a/MAINTENANCE.md +++ b/MAINTENANCE.md @@ -23,7 +23,7 @@ In case something happens where a maintainer is unable to complete their respons | Mattermost Open Source Project | 2016-04-12 | -## Maintainer Guide +## Activities The following is a guide for current, new maintainers and prospective maintainers of this open source project to get started and to understand on-going responsibilities: @@ -34,14 +34,14 @@ The following steps should be completed by a new maintainer 1. **Add your name** - Create a pull request to add your name, GitHub username and start date to this document. 2. **Subscribe to mailings** - To be notified of new releases and security updates of Mattermost, subscribe to the [Mattermost Security Update Mailing List](http://mattermost.us11.list-manage.com/subscribe?u=6cdba22349ae374e188e7ab8e&id=3a93eb6929) and the [Mattermost Insiders Newsletter](http://mattermost.us11.list-manage.com/subscribe?u=6cdba22349ae374e188e7ab8e&id=2add1c8034) -## Updating +### Updating When receive a mailing list email about a new security update or major version of Mattermost being released, update the version number of this project by doing the following: - Change the [version number](https://github.com/mattermost/mattermost-docker/blob/master/app/Dockerfile#L6) in the **master branch** to pull in the latest Mattermost Team Edition release - Change the [version number](https://github.com/mattermost/mattermost-docker/blob/team-and-enterprise/app/Dockerfile#L6) in the **the team-and-enterprise branch** to pull in the latest Mattermost Enterprise Edition release -## Issue and Pull Request Review +### Issue and Pull Request Review Maintainer(s) should periodically review pull requests and issues submitted to provide feedback and to merge pull request changes when the maintainer feels the change would be appropriate. From d40e9b19d8b98a44ba151a2b22c9a2af0c62f7c4 Mon Sep 17 00:00:00 2001 From: it33 Date: Fri, 3 Feb 2017 21:43:27 -0800 Subject: [PATCH 06/13] Fixing typo --- MAINTENANCE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/MAINTENANCE.md b/MAINTENANCE.md index 7c8addd..b176be5 100644 --- a/MAINTENANCE.md +++ b/MAINTENANCE.md @@ -49,7 +49,7 @@ Maintainer(s) should periodically review pull requests and issues submitted to p PREVIOUS MAINTAINERS -| Creator | Start Date | End Date | +| Maintainer | Start Date | End Date | |:-----------------------|:--------------|:-----------| | Yi EungJun - @npcode | 2015-11-30 | 2015-11-26 | From 37d6418c15be258c1400dfb4aeb610e21dc86198 Mon Sep 17 00:00:00 2001 From: it33 Date: Fri, 3 Feb 2017 21:52:37 -0800 Subject: [PATCH 07/13] Tweak to sound more polite --- MAINTENANCE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/MAINTENANCE.md b/MAINTENANCE.md index b176be5..f943ee8 100644 --- a/MAINTENANCE.md +++ b/MAINTENANCE.md @@ -4,7 +4,7 @@ This file outlines the current maintainer(s) of this open source project and exp ## Project Name -When reference externally, this project should be called: +When reference externally, please call this project: - Multi-node Docker image for Mattermost by the Mattermost open source project From d95d2a364530f07a4982340b808548b16c05ad18 Mon Sep 17 00:00:00 2001 From: it33 Date: Fri, 3 Feb 2017 22:07:23 -0800 Subject: [PATCH 08/13] Slight updates to README Slight updates to README --- README.md | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index e37b5bb..542f38a 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,22 @@ -Dockerfiles for Mattermost in production +# Production Docker deployment for Mattermost -See [README.aws.md](./README.aws.md) if you want to install it on AWS Elastic Beanstalk. +This project enables deployment of a Mattermost server in a multi-node production configuration using Docker. [![Build Status](https://travis-ci.org/mattermost/mattermost-docker.svg?branch=master)](https://travis-ci.org/mattermost/mattermost-docker) -## Requirements +Notes: +- To install this Docker project on AWS Elastic Beanstalk please see [AWS Elastic Beanstalk Guide](./README.aws.md). +- To install Mattermost without Docker directly onto a Linux-based operating systems, please see [Admin Guide](https://docs.mattermost.com/guides/administrator.html#installing-mattermost). + +## Installation using Docker Compose + +The following instructions deploy Mattermost in a production configuration using multi-node Docker Compose set up. + +### Requirements * [docker] * [docker-compose] -## Installation - -For the people who want to install Mattermost in a traditional way (without docker), please refer to the guide here: https://docs.mattermost.com/guides/administrator.html#installing-mattermost - ### Install with SSL certificate 1. Open docker-compose.yml and set `MATTERMOST_ENABLE_SSL` to true. @@ -110,7 +114,7 @@ See the [offical Upgrade Guide](http://docs.mattermost.com/administration/upgrad * Rarely 'app' container fails to start because of "connection refused" to database. Workaround: Restart the container. -## More informations +## More information If you want to know how to use docker-compose, see [the overview page](https://docs.docker.com/compose). From 50971b85299d85c5c1a62c818e02876a67fda82f Mon Sep 17 00:00:00 2001 From: it33 Date: Fri, 3 Feb 2017 22:08:11 -0800 Subject: [PATCH 09/13] Tweak name --- MAINTENANCE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/MAINTENANCE.md b/MAINTENANCE.md index f943ee8..f0b8deb 100644 --- a/MAINTENANCE.md +++ b/MAINTENANCE.md @@ -6,7 +6,7 @@ This file outlines the current maintainer(s) of this open source project and exp When reference externally, please call this project: -- Multi-node Docker image for Mattermost by the Mattermost open source project +- Production Docker deployment for Mattermost by the Mattermost open source project ## Maintainer(s) From b123e7276d0f21839c94115268e677553d4454f5 Mon Sep 17 00:00:00 2001 From: it33 Date: Fri, 3 Feb 2017 22:09:24 -0800 Subject: [PATCH 10/13] Adding short/long name --- MAINTENANCE.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/MAINTENANCE.md b/MAINTENANCE.md index f0b8deb..588c7ed 100644 --- a/MAINTENANCE.md +++ b/MAINTENANCE.md @@ -4,7 +4,11 @@ This file outlines the current maintainer(s) of this open source project and exp ## Project Name -When reference externally, please call this project: +When reference externally, please use this for the short name: + +- Production Docker deployment for Mattermost + +Please use this long name: - Production Docker deployment for Mattermost by the Mattermost open source project From 773568a8356d3b68600090d81bacb27b1d48d8e5 Mon Sep 17 00:00:00 2001 From: it33 Date: Fri, 3 Feb 2017 22:46:32 -0800 Subject: [PATCH 11/13] Update MAINTENANCE.md --- MAINTENANCE.md | 24 +++++++++++++++--------- 1 file changed, 15 insertions(+), 9 deletions(-) diff --git a/MAINTENANCE.md b/MAINTENANCE.md index 588c7ed..f276df2 100644 --- a/MAINTENANCE.md +++ b/MAINTENANCE.md @@ -18,13 +18,13 @@ The following people help to maintain this open source project: | Current Maintainer(s) | Start Date | |:-----------------------|:--------------| -| Pan Luo - @xcompass | 2015-11-30 | +| Pan Luo - @xcompass | NOV 30 2015 | In case something happens where a maintainer is unable to complete their responsibilies or find a new maintainer, the following sponsoring organization can help find a new maintainer: | Sponsoring Organization | Start Date | |:-------------------------------|:--------------| -| Mattermost Open Source Project | 2016-04-12 | +| Mattermost Open Source Project | DEC 04 2016 | ## Activities @@ -36,14 +36,20 @@ The following is a guide for current, new maintainers and prospective maintainer The following steps should be completed by a new maintainer 1. **Add your name** - Create a pull request to add your name, GitHub username and start date to this document. -2. **Subscribe to mailings** - To be notified of new releases and security updates of Mattermost, subscribe to the [Mattermost Security Update Mailing List](http://mattermost.us11.list-manage.com/subscribe?u=6cdba22349ae374e188e7ab8e&id=3a93eb6929) and the [Mattermost Insiders Newsletter](http://mattermost.us11.list-manage.com/subscribe?u=6cdba22349ae374e188e7ab8e&id=2add1c8034) +2. **Subscribe to mailing lists** - To be notified of new releases and security updates of Mattermost, subscribe to the [Mattermost Security Update Mailing List](http://mattermost.us11.list-manage.com/subscribe?u=6cdba22349ae374e188e7ab8e&id=3a93eb6929) and the [Mattermost Insiders Newsletter](http://mattermost.us11.list-manage.com/subscribe?u=6cdba22349ae374e188e7ab8e&id=2add1c8034) ### Updating When receive a mailing list email about a new security update or major version of Mattermost being released, update the version number of this project by doing the following: -- Change the [version number](https://github.com/mattermost/mattermost-docker/blob/master/app/Dockerfile#L6) in the **master branch** to pull in the latest Mattermost Team Edition release -- Change the [version number](https://github.com/mattermost/mattermost-docker/blob/team-and-enterprise/app/Dockerfile#L6) in the **the team-and-enterprise branch** to pull in the latest Mattermost Enterprise Edition release +1) In the **master branch** + +- Change the [version number](https://github.com/mattermost/mattermost-docker/blob/master/app/Dockerfile#L6) to the latest release +- Tag the repo + +2) In the **team-and-enterprise branch** + +- Change the [version number](https://github.com/mattermost/mattermost-docker/blob/team-and-enterprise/app/Dockerfile#L6) to the latest release ### Issue and Pull Request Review @@ -53,14 +59,14 @@ Maintainer(s) should periodically review pull requests and issues submitted to p PREVIOUS MAINTAINERS -| Maintainer | Start Date | End Date | -|:-----------------------|:--------------|:-----------| -| Yi EungJun - @npcode | 2015-11-30 | 2015-11-26 | +| Maintainer | Start Date | End Date | +|:-----------------------|:--------------|:------------| +| Yi EungJun - @npcode | NOV 26 2015 | NOV 30 2016 | CREATOR | Creator | Created Date | |:-----------------------|:--------------| -| Yi EungJun - @npcode | 2015-11-26 | +| Yi EungJun - @npcode | NOV 26 2015 | From 60b04f9a3f872c61e555a99e0b5dd6ffaa60592f Mon Sep 17 00:00:00 2001 From: it33 Date: Fri, 3 Feb 2017 22:54:14 -0800 Subject: [PATCH 12/13] Capitalization change --- MAINTENANCE.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/MAINTENANCE.md b/MAINTENANCE.md index f276df2..4150db8 100644 --- a/MAINTENANCE.md +++ b/MAINTENANCE.md @@ -18,13 +18,13 @@ The following people help to maintain this open source project: | Current Maintainer(s) | Start Date | |:-----------------------|:--------------| -| Pan Luo - @xcompass | NOV 30 2015 | +| Pan Luo - @xcompass | Nov 30 2015 | In case something happens where a maintainer is unable to complete their responsibilies or find a new maintainer, the following sponsoring organization can help find a new maintainer: | Sponsoring Organization | Start Date | |:-------------------------------|:--------------| -| Mattermost Open Source Project | DEC 04 2016 | +| Mattermost Open Source Project | Dec 04 2016 | ## Activities @@ -61,12 +61,12 @@ PREVIOUS MAINTAINERS | Maintainer | Start Date | End Date | |:-----------------------|:--------------|:------------| -| Yi EungJun - @npcode | NOV 26 2015 | NOV 30 2016 | +| Yi EungJun - @npcode | Nov 26 2015 | Nov 30 2016 | CREATOR | Creator | Created Date | |:-----------------------|:--------------| -| Yi EungJun - @npcode | NOV 26 2015 | +| Yi EungJun - @npcode | Nov 26 2015 | From 8d186bff8189d994d641eabe52fe2f576cd4a223 Mon Sep 17 00:00:00 2001 From: it33 Date: Sat, 4 Feb 2017 08:39:32 -0800 Subject: [PATCH 13/13] Updating based on xcompass feedback --- MAINTENANCE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/MAINTENANCE.md b/MAINTENANCE.md index 4150db8..f47c3c3 100644 --- a/MAINTENANCE.md +++ b/MAINTENANCE.md @@ -20,7 +20,7 @@ The following people help to maintain this open source project: |:-----------------------|:--------------| | Pan Luo - @xcompass | Nov 30 2015 | -In case something happens where a maintainer is unable to complete their responsibilies or find a new maintainer, the following sponsoring organization can help find a new maintainer: +In case something happens where no maintainers are able to complete their responsibilies, the following sponsoring organization can help find a new maintainer: | Sponsoring Organization | Start Date | |:-------------------------------|:--------------|