Fix readme
This commit is contained in:
PICHOU Kyâne
parent
41c022a80b
commit
c50cdfd6a0
55
README.md
55
README.md
@ -7,6 +7,7 @@ This project enables deployment of a Mattermost server in a multi-node productio
|
||||
Notes:
|
||||
- The default Mattermost edition for this repo has changed from team edition to enterprise edition. Please see [Choose Edition](#choose-edition-to-install) section.
|
||||
- To install this Docker project on AWS Elastic Beanstalk please see [AWS Elastic Beanstalk Guide](./contrib/awd/README.md).
|
||||
- To run Mattermost on Kubernetes you can start with the [manifest examples in the kubernetes folder](contrib/kubernetes/README.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
|
||||
@ -23,7 +24,6 @@ The following instructions deploy Mattermost in a production configuration using
|
||||
If you want to install enterprise edition, you can skip this section.
|
||||
|
||||
To install the team edition, comment out the following line in docker-compose.yaml file:
|
||||
|
||||
```
|
||||
dockerfile: Dockerfile-enterprise
|
||||
```
|
||||
@ -39,7 +39,6 @@ Make sure to set the appropriate values for `MM_USERNAME`, `MM_PASSWORD` and `MM
|
||||
them you may generate a self-signed SSL certificate.
|
||||
|
||||
2. Build and run mattermost
|
||||
|
||||
```
|
||||
docker-compose up -d
|
||||
```
|
||||
@ -49,7 +48,6 @@ Make sure to set the appropriate values for `MM_USERNAME`, `MM_PASSWORD` and `MM
|
||||
### Install without SSL certificate
|
||||
|
||||
1. Build and run mattermost
|
||||
|
||||
```
|
||||
docker-compose up -d
|
||||
```
|
||||
@ -59,31 +57,36 @@ Make sure to set the appropriate values for `MM_USERNAME`, `MM_PASSWORD` and `MM
|
||||
## Starting/Stopping
|
||||
|
||||
### Start
|
||||
|
||||
```
|
||||
docker-compose start
|
||||
```
|
||||
|
||||
### Stop
|
||||
|
||||
```
|
||||
docker-compose stop
|
||||
```
|
||||
|
||||
### Update
|
||||
|
||||
Make sure to backup Mattermost data before proceeding.
|
||||
|
||||
```
|
||||
docker-compose down
|
||||
git pull
|
||||
docker-compose build
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
## Removing
|
||||
|
||||
### Remove the containers
|
||||
|
||||
```
|
||||
docker-compose stop && docker-compose rm
|
||||
```
|
||||
|
||||
### Remove the data and settings of your mattermost instance
|
||||
|
||||
```
|
||||
sudo rm -rf volumes
|
||||
```
|
||||
|
||||
## Database Backup
|
||||
|
||||
@ -116,38 +119,38 @@ Customization can be done through environment variables.
|
||||
|
||||
### Mattermost App Image
|
||||
|
||||
* MM_USERNAME: database username, must be the same as one in DB image
|
||||
* MM_PASSWORD: database password, must be the same as one in DB image
|
||||
* MM_DBNAME: database name, must be the same as one in DB image
|
||||
* DB_HOST: database host address
|
||||
* DB_PORT_5432_TCP_PORT: database port
|
||||
* MM_CONFIG: configuration file location. It can be used when config is mounted in a different location.
|
||||
* `MM_USERNAME`: database username, must be the same as one in DB image
|
||||
* `MM_PASSWORD`: database password, must be the same as one in DB image
|
||||
* `MM_DBNAME`: database name, must be the same as one in DB image
|
||||
* `DB_HOST`: database host address
|
||||
* `DB_PORT_5432_TCP_PORT`: database port
|
||||
* `MM_CONFIG`: configuration file location. It can be used when config is mounted in a different location.
|
||||
|
||||
### Mattermost DB Image
|
||||
|
||||
* MM_USERNAME: database username, must be the same as on in App image
|
||||
* MM_PASSWORD: database password, must be the same as on in App image
|
||||
* MM_DBNAME: database name, must be the same as on in App image
|
||||
* AWS_ACCESS_KEY_ID: aws access key, used for db backup
|
||||
* AWS_SECRET_ACCESS_KEY: aws secret, used for db backup
|
||||
* WALE_S3_PREFIX: aws s3 bucket name, used for db backup
|
||||
* AWS_REGION: aws region, used for db backup
|
||||
* `MM_USERNAME`: database username, must be the same as on in App image
|
||||
* `MM_PASSWORD`: database password, must be the same as on in App image
|
||||
* `MM_DBNAME`: database name, must be the same as on in App image
|
||||
* `AWS_ACCESS_KEY_ID`: aws access key, used for db backup
|
||||
* `AWS_SECRET_ACCESS_KEY`: aws secret, used for db backup
|
||||
* `WALE_S3_PREFIX`: aws s3 bucket name, used for db backup
|
||||
* `AWS_REGION`: aws region, used for db backup
|
||||
|
||||
### Mattermost Web Image
|
||||
|
||||
* MATTERMOST_ENABLE_SSL: whether to enable SSL
|
||||
* PLATFORM_PORT_80_TCP_PORT: port that Mattermost image is listening on
|
||||
* `MATTERMOST_ENABLE_SSL`: whether to enable SSL
|
||||
* `PLATFORM_PORT_80_TCP_PORT`: port that Mattermost image is listening on
|
||||
|
||||
## Upgrading to Team Edition 3.0.x from 2.x
|
||||
|
||||
You need to migrate your database before upgrading mattermost to 3.0.x from
|
||||
2.x. Run these commands in the latest mattermost-docker directory.
|
||||
|
||||
```
|
||||
docker-compose rm -f app
|
||||
docker-compose build app
|
||||
docker-compose run app -upgrade_db_30
|
||||
docker-compose up -d
|
||||
|
||||
```
|
||||
See the [offical Upgrade Guide](http://docs.mattermost.com/administration/upgrade.html) for more details.
|
||||
|
||||
## Known Issues
|
||||
@ -161,8 +164,6 @@ See the [offical Upgrade Guide](http://docs.mattermost.com/administration/upgrad
|
||||
If you want to know how to use docker-compose, see [the overview
|
||||
page](https://docs.docker.com/compose).
|
||||
|
||||
If you want to run Mattermost on Kubernetes you can start with the [manifest examples in the kubernetes folder](contrib/kubernetes/README.md)
|
||||
|
||||
For the server configurations, see [prod-ubuntu.rst] of mattermost.
|
||||
|
||||
[docker]: http://docs.docker.com/engine/installation/
|
||||
|
||||
Reference in New Issue
Block a user