commit
83ed83237d
@ -1,67 +1,67 @@
|
|||||||
# Maintainer Guide
|
# 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.
|
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
|
## Project Name
|
||||||
|
|
||||||
When reference externally, please use this for the short name:
|
When reference externally, please use this for the short name:
|
||||||
|
|
||||||
- Production Docker deployment for Mattermost
|
- Production Docker deployment for Mattermost
|
||||||
|
|
||||||
Please use this long name:
|
Please use this long name:
|
||||||
|
|
||||||
- Production Docker deployment for Mattermost by the Mattermost open source project
|
- Production Docker deployment for Mattermost by the Mattermost open source project
|
||||||
|
|
||||||
## Maintainer(s)
|
## Maintainer(s)
|
||||||
|
|
||||||
The following people help to maintain this open source project:
|
The following people help to maintain this open source project:
|
||||||
|
|
||||||
| Current Maintainer(s) | Start Date |
|
| Current Maintainer(s) | Start Date |
|
||||||
|:-----------------------|:--------------|
|
|:-----------------------|:--------------|
|
||||||
| Pan Luo - @xcompass | Nov 30 2015 |
|
| Pan Luo - @xcompass | Nov 30 2015 |
|
||||||
| Kyâne Pichou - @pichouk| Jun 01 2017 |
|
| Kyâne Pichou - @pichouk| Jun 01 2017 |
|
||||||
|
|
||||||
In case something happens where no maintainers are able to complete their responsibilies, 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 |
|
| Sponsoring Organization | Start Date |
|
||||||
|:-------------------------------|:--------------|
|
|:-------------------------------|:--------------|
|
||||||
| Mattermost Open Source Project | Dec 04 2016 |
|
| Mattermost Open Source Project | Dec 04 2016 |
|
||||||
|
|
||||||
|
|
||||||
## Activities
|
## 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:
|
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
|
### Getting Started
|
||||||
|
|
||||||
The following steps should be completed by a new 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.
|
1. **Add your name** - Create a pull request to add your name, GitHub username and start date to this document.
|
||||||
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)
|
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
|
### 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:
|
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:
|
||||||
|
|
||||||
In the **master branch**
|
In the **master branch**
|
||||||
|
|
||||||
- Change the [version number](https://github.com/mattermost/mattermost-docker/blob/master/app/Dockerfile#L6) to the latest release
|
- Change the [version number](https://github.com/mattermost/mattermost-docker/blob/master/app/Dockerfile#L6) to the latest release
|
||||||
- Tag the repo
|
- Tag the repo
|
||||||
|
|
||||||
### 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.
|
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
|
## Credits
|
||||||
|
|
||||||
PREVIOUS MAINTAINERS
|
PREVIOUS MAINTAINERS
|
||||||
|
|
||||||
| Maintainer | Start Date | End Date |
|
| 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
|
||||||
|
|
||||||
| Creator | Created Date |
|
| Creator | Created Date |
|
||||||
|:-----------------------|:--------------|
|
|:-----------------------|:--------------|
|
||||||
|
10
README.md
10
README.md
@ -17,7 +17,7 @@ The following instructions deploy Mattermost in a production configuration using
|
|||||||
### Requirements
|
### Requirements
|
||||||
|
|
||||||
* [docker] (version `1.12+`)
|
* [docker] (version `1.12+`)
|
||||||
* [docker-compose] (version `1.10.0+` to support Compose file version `3.0`)
|
* [docker-compose] (version `1.10.0+` to support Compose file version `3.0`)
|
||||||
|
|
||||||
### Choose Edition to Install
|
### Choose Edition to Install
|
||||||
|
|
||||||
@ -84,13 +84,13 @@ applications:
|
|||||||
instances: 1
|
instances: 1
|
||||||
memory: 1G
|
memory: 1G
|
||||||
disk_quota: 256M
|
disk_quota: 256M
|
||||||
env:
|
env:
|
||||||
DB_HOST: database host address
|
DB_HOST: database host address
|
||||||
DB_PORT_NUMBER: database port
|
DB_PORT_NUMBER: database port
|
||||||
MM_DBNAME: database name
|
MM_DBNAME: database name
|
||||||
MM_USERNAME: database username
|
MM_USERNAME: database username
|
||||||
MM_PASSWORD: database password
|
MM_PASSWORD: database password
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### Web server container
|
### Web server container
|
||||||
@ -154,7 +154,7 @@ Your Docker image should now be on the latest Mattermost version.
|
|||||||
## Upgrading Mattermost to 4.9+
|
## Upgrading Mattermost to 4.9+
|
||||||
|
|
||||||
Docker images for `4.9.0` release introduce some important changes from [PR #241](https://github.com/mattermost/mattermost-docker/pull/241) to improve production use of Mattermost with Docker.
|
Docker images for `4.9.0` release introduce some important changes from [PR #241](https://github.com/mattermost/mattermost-docker/pull/241) to improve production use of Mattermost with Docker.
|
||||||
**There are 2 important changes for existing installations**
|
**There are 2 important changes for existing installations**
|
||||||
|
|
||||||
One important change is that we don't use `root` user by default to run the Mattermost application. So, as explained on [the README](https://github.com/mattermost/mattermost-docker#start), if you use host mounted volume you have to be sure that files on your host server have the correct UID/GID (by default those values are `2000`). In practice, you should just run following commands :
|
One important change is that we don't use `root` user by default to run the Mattermost application. So, as explained on [the README](https://github.com/mattermost/mattermost-docker#start), if you use host mounted volume you have to be sure that files on your host server have the correct UID/GID (by default those values are `2000`). In practice, you should just run following commands :
|
||||||
```
|
```
|
||||||
@ -162,7 +162,7 @@ mkdir -p ./volumes/app/mattermost/{data,logs,config,plugins}
|
|||||||
chown -R 2000:2000 ./volumes/app/mattermost/
|
chown -R 2000:2000 ./volumes/app/mattermost/
|
||||||
```
|
```
|
||||||
|
|
||||||
The second important change is the port used by Mattermost application container. The default port is now `8000`, and existing installations that use port `80` will not work without a little configuration change. You have to open your Mattermost configuration file (`./volumes/app/mattermost/config/config.json` by default) and change the key `ServiceSettings.ListenAddress` to `:8000`.
|
The second important change is the port used by Mattermost application container. The default port is now `8000`, and existing installations that use port `80` will not work without a little configuration change. You have to open your Mattermost configuration file (`./volumes/app/mattermost/config/config.json` by default) and change the key `ServiceSettings.ListenAddress` to `:8000`.
|
||||||
Also if you use your own web-server/reverse-proxy you need to change its configuration to reach port `8000` of the Mattermost container.
|
Also if you use your own web-server/reverse-proxy you need to change its configuration to reach port `8000` of the Mattermost container.
|
||||||
|
|
||||||
|
|
||||||
|
@ -2,7 +2,7 @@ FROM alpine:3.6
|
|||||||
|
|
||||||
# Some ENV variables
|
# Some ENV variables
|
||||||
ENV PATH="/mattermost/bin:${PATH}"
|
ENV PATH="/mattermost/bin:${PATH}"
|
||||||
ENV MM_VERSION=5.2.0
|
ENV MM_VERSION=5.2.1
|
||||||
|
|
||||||
# Build argument to set Mattermost edition
|
# Build argument to set Mattermost edition
|
||||||
ARG edition=enterprise
|
ARG edition=enterprise
|
||||||
@ -33,9 +33,9 @@ RUN mkdir -p /mattermost/data \
|
|||||||
# Get ready for production
|
# Get ready for production
|
||||||
RUN addgroup -g ${PGID} mattermost \
|
RUN addgroup -g ${PGID} mattermost \
|
||||||
&& adduser -D -u ${PUID} -G mattermost -h /mattermost -D mattermost \
|
&& adduser -D -u ${PUID} -G mattermost -h /mattermost -D mattermost \
|
||||||
&& chown -R mattermost:mattermost /mattermost /config.json.save
|
&& chown -R mattermost:mattermost /mattermost /config.json.save
|
||||||
|
|
||||||
USER mattermost
|
USER mattermost
|
||||||
|
|
||||||
#Healthcheck to make sure container is ready
|
#Healthcheck to make sure container is ready
|
||||||
HEALTHCHECK CMD curl --fail http://localhost:8000 || exit 1
|
HEALTHCHECK CMD curl --fail http://localhost:8000 || exit 1
|
||||||
|
@ -17,7 +17,7 @@ spec:
|
|||||||
spec:
|
spec:
|
||||||
containers:
|
containers:
|
||||||
- name: mattermost-app
|
- name: mattermost-app
|
||||||
image: "mattermost/mattermost-prod-app:4.7.0"
|
image: "mattermost/mattermost-prod-app:5.2.1"
|
||||||
env:
|
env:
|
||||||
- name: DB_HOST
|
- name: DB_HOST
|
||||||
valueFrom:
|
valueFrom:
|
||||||
|
Reference in New Issue
Block a user