Skip to content

Commit a77022b

Browse files
committed
Fixed build warnings & errors
1 parent 39bb3de commit a77022b

File tree

7 files changed

+30
-29
lines changed

7 files changed

+30
-29
lines changed

source/guides/deployment.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Learn how to install, deploy, and scale Mattermost for teams and organizations o
4040
* :doc:`Migrate from MySQL to PostgreSQL </deploy/postgres-migration>` - Learn how to migrate from MySQL to PostgreSQL.
4141
* :doc:`Prepare your Mattermost database </install/prepare-mattermost-database>` - Learn how to prepare and configure a database for Mattermost.
4242
* :doc:`Deploy on Ubuntu </install/install-ubuntu>` - Signed packages direct from Mattermost featuring a single command for install and upgrades.
43-
* :ref:`Deploy using Docker <install/install-docker>` - The fastest way to try Mattermost and a great single server installation option.
43+
* :doc:`Deploy using Docker </install/install-docker>` - The fastest way to try Mattermost and a great single server installation option.
4444
* :doc:`Deploy with a tarball </install/install-tar>` - Support for any Linux distribution.
4545
* :doc:`Deploy using Omnibus </install/installing-mattermost-omnibus>` - An entire Mattermost installation on a single server.
4646
* :doc:`Deploy using Kubernetes </install/install-kubernetes>` - Install using the Mattermost Helm Chart or Operator and simplified updates.

source/install/common-omnibus-tip.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,5 @@
33

44
.. tip::
55

6-
- If you are running the Mattermost Server and database on a single system, we recommend the :doc:`Mattermost Omnibus install method </install/installing-mattermost-omnibus>` as this greatly reduces setup and ongoing maintenance.
6+
If you are running the Mattermost Server and database on a single system, we recommend the :doc:`Mattermost Omnibus install method </install/installing-mattermost-omnibus>` as this greatly reduces setup and ongoing maintenance.
77

source/install/common-postgres-database-important.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@
33

44
.. important::
55

6-
- You need a PostgreSQL database. See the :doc:`database preparation </install/prepare-mattermost-database>` documentation for details on this prerequisite.
6+
You need a PostgreSQL database. See the :doc:`database preparation </install/prepare-mattermost-database>` documentation for details on this prerequisite.

source/install/install-docker.rst

Lines changed: 24 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,11 @@ If you don't have Docker installed, follow the instructions below based on your
1919

2020
.. tab:: Ubuntu
2121

22-
Follow the `Install Docker Engine on Ubuntu <https://docs.docker.com/engine/install/ubuntu/>`_ documentation:
22+
Follow the `Install Docker Engine on Ubuntu <https://docs.docker.com/engine/install/ubuntu/>`_ documentation.
2323

2424
.. tab:: Fedora
2525

26-
Follow the `Install Docker Engine on Fedora <https://docs.docker.com/engine/install/fedora/>`_ documentation:
26+
Follow the `Install Docker Engine on Fedora <https://docs.docker.com/engine/install/fedora/>`_ documentation.
2727

2828
.. _Deploy Mattermost on Docker:
2929

@@ -32,21 +32,22 @@ Before you begin
3232

3333
Mattermost's Docker deployment solution is one of the best ways to get started with Mattermost. Before you get begin, think about what type of Mattermost deployment you want to create as the instructions below are designed for different use cases.
3434

35-
- If you're simply looking to try Mattermost out, see the :ref:`Deploy Mattermost on Docker (Quick Start) <install-docker:deploy-mattermost-on-docker-quick-start>` section below.
36-
- If you're looking to deploy Mattermost on Docker in production, see the :ref:`Deploy Mattermost on Docker for production use <install-docker:deploy-mattermost-on-docker-for-production-use>` section below.
35+
- If you're looking to try out Mattermost, see the `Docker (Quick Start) <#deploy-mattermost-on-docker-quick-start>`__ section below.
36+
- If you're looking to deploy Mattermost on Docker in production, see the `Docker for production use <#deploy-mattermost-on-docker-for-production-use>`__ section below.
3737

3838
.. note::
3939

40-
- Intending to deploy Mattermost for production use, with more than 100 users? Consider :ref:`deploying Mattermost on Kubernetes <install/deploy-mattermost-on-kubernetes>` instead.
40+
Intending to deploy a production Mattermost instance for more than 100 users? Consider :doc:`deploying Mattermost on Kubernetes </install/install-kubernetes>` instead.
4141

4242
Deploy Mattermost on Docker (Quick Start)
4343
-----------------------------------------
4444

45-
This section provides a quick start guide for deploying Mattermost on Docker. Leveraging docker-compose, this deployment solution is designed to get Mattermost up and running quickly. This deployment solution is not recommended for production use. If you are looking to deploy Mattermost on Docker in production, see the :ref:`Deploy Mattermost on Docker for production use <install-docker:deploy-mattermost-on-docker-for-production-use>` section below.
45+
This section provides a quick start guide for deploying Mattermost on Docker. Leveraging `Docker Compose <https://docs.docker.com/compose/install/>`_, this deployment solution is designed to get Mattermost up and running quickly.
4646

4747
.. important::
4848

49-
- The quick-start configuration results in two separate containers: one for the database and one for the application. An optional third container results when using NGINX for reverse proxy.
49+
- This deployment solution is not recommended for production use. See the `Docker for production use <#deploy-mattermost-on-docker-for-production-use>`__ section instead.
50+
- The quick-start configuration results in two separate containers: a container for the database and a container for the application. An optional third container results when using NGINX for reverse proxy.
5051
- Encountering issues with your Docker deployment? See the :ref:`Docker deployment troubleshooting <install/troubleshooting:docker deployments>` documentation for details.
5152

5253
To deploy Mattermost on Docker:
@@ -75,7 +76,7 @@ To deploy Mattermost on Docker:
7576
mkdir -p ./volumes/app/mattermost/{config,data,logs,plugins,client/plugins,bleve-indexes}
7677
sudo chown -R 2000:2000 ./volumes/app/mattermost
7778
78-
4. Configure TLS for NGINX *(optional)*. If you're not using the included NGINX reverse proxy, you can skip this step.
79+
4. *(Optional)* Configure TLS for NGINX. If you're not using the included NGINX reverse proxy, you can skip this step.
7980

8081
**If creating a new certificate and key:**
8182

@@ -105,8 +106,6 @@ To deploy Mattermost on Docker:
105106
CERT_PATH=./volumes/web/cert/cert.pem
106107
KEY_PATH=./volumes/web/cert/key-no-password.pem
107108
108-
109-
110109
6. Deploy Mattermost.
111110

112111
**Without using the included NGINX:**
@@ -140,17 +139,17 @@ To deploy Mattermost on Docker:
140139
7. Create your first Mattermost system admin user, :doc:`invite more users </collaborate/manage-channel-members>`, and explore the Mattermost platform.
141140

142141
Deploy Mattermost on Docker (Production)
143-
----------------------------------------------
142+
-----------------------------------------
143+
144+
The production deployment solution is designed to deploy Mattermost on Docker in a production environment. This deployment solution only deploys a single application container for Mattermost, and expects an external database and reverse proxy.
144145

145146
.. important::
146147

147-
- Mattermost recommends the use of an external, managed PostgreSQL database like AWS RDS, Google Cloud SQL, or Azure Database for production deployments. See the :doc:`Database preparation <install/prepare-mattermost-database>` documentation for details.
148+
- Mattermost recommends the use of an external, managed PostgreSQL database like AWS RDS, Google Cloud SQL, or Azure Database for production deployments. See the :doc:`Database preparation </install/prepare-mattermost-database>` documentation for details.
148149
- Mattermost recommends the use of an external storage solution like AWS S3, Google Cloud Storage, or Azure Blob Storage for production deployments.
149150
- Mattermost recommends the use of an external reverse proxy for production deployments.
150151
- Encountering issues with your Docker deployment? See the :ref:`Docker deployment troubleshooting <install/troubleshooting:docker deployments>` documentation for details.
151152

152-
The Production deployment solution is designed to deploy Mattermost on Docker in a production environment. This deployment solution differs from the :ref:`Deploy Mattermost on Docker (Quick Start) <install-docker:deploy-mattermost-on-docker-quick-start>` section above in that it will deploy a single application container for Mattermost only, expecting an external database, and reverse proxy.
153-
154153
1. In a terminal window, clone the repository and enter the directory.
155154

156155
.. code-block:: sh
@@ -164,7 +163,7 @@ The Production deployment solution is designed to deploy Mattermost on Docker in
164163
165164
cp env.example .env
166165
167-
If you're using an external database as is recommended for production deployments, ensure you've followed the :doc:`Database preparation <install/prepare-mattermost-database>` documentation. When completed you'll need to set the following environment variables in your ``.env`` file:
166+
If you're using an external database as is recommended for production deployments, ensure you've followed the :doc:`database preparation </install/prepare-mattermost-database>` documentation. When completed you'll need to set the following environment variables in your ``.env`` file:
168167

169168
- ``POSTGRES_USER``
170169
- ``POSTGRES_PASSWORD``
@@ -205,34 +204,37 @@ The Production deployment solution is designed to deploy Mattermost on Docker in
205204
5. Create your first Mattermost system admin user, :doc:`invite more users </collaborate/manage-channel-members>`, and explore the Mattermost platform.
206205

207206

208-
Configure SSO With Gitlab (Optional)
207+
Configure SSO With GitLab (Optional)
209208
-------------------------------------
210209

211210
If you want to use SSO with GitLab, and you're using a self-signed certificate, you have to add the PKI chain for your authority. This is required to avoid the ``Token request failed: certificate signed by unknown authority`` error.
212211

213-
To add the PKI chain, uncomment this line in your ``.env`` file, and ensure it points to your ``pki_chain.pem`` file:
212+
To add the PKI chain, uncomment this line in your ``.env`` file, and ensure it points to your ``pki_chain.pem`` file:
214213

215214
.. code-block:: sh
216-
215+
217216
#GITLAB_PKI_CHAIN_PATH=<path_to_your_gitlab_pki>/pki_chain.pem
218217
219-
Then uncomment this line in your ``docker-compose.yml`` file, and ensure it points to the same ``pki_chain.pem`` file:
218+
Then uncomment this line in your ``docker-compose.yml`` file, and ensure it points to the same ``pki_chain.pem`` file:
220219

221220
.. code-block:: sh
222221
223222
# - ${GITLAB_PKI_CHAIN_PATH}:/etc/ssl/certs/pki_chain.pem:ro
224223
225-
226224
Upgrade from ``mattermost-docker``
227225
-----------------------------------
228226

229-
The `mattermost-docker <https://github.com/mattermost/mattermost-docker>`__ GitHub repository is deprecated. Visit the `mattermost/docker <https://github.com/mattermost/docker>`_ GitHub repository to access the official Docker deployment solution for Mattermost.
227+
Visit the `mattermost/docker <https://github.com/mattermost/docker>`_ GitHub repository to access the official Docker deployment solution for Mattermost.
228+
229+
.. note::
230+
231+
The `mattermost-docker <https://github.com/mattermost/mattermost-docker>`__ GitHub repository is deprecated.
230232

231233
To migrate from an existing ``mattermost/mattermost-prod-app`` image, we recommend migrating to either ``mattermost/mattermost-enterprise-edition`` or ``mattermost/mattermost-team-edition`` images, which are the official images supported by Mattermost. These images support PostgreSQL 11+ databases, which we know has been a long-running challenge for the community, and you will not lose any features or functionality by moving to these new images.
232234

233235
For additional help or questions, please refer to `this issue <https://github.com/mattermost/mattermost-docker/issues/489>`__.
234236

235-
Installing a different version of Mattermost
237+
Install a different version of Mattermost
236238
--------------------------------------------
237239

238240
1. Shut down your deployment.

source/install/installing-mattermost-omnibus.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ In a terminal window, run the following repository setup command:
5353
curl -o- https://deb.packages.mattermost.com/repo-setup.sh | sudo bash
5454
5555
This command sets up all required repositories and configures:
56+
5657
- PostgreSQL database
5758
- NGINX web server as a proxy
5859
- Certbot for SSL certificate management

source/install/troubleshooting.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,14 +25,12 @@ Deployment troubleshooting
2525
Docker deployments
2626
~~~~~~~~~~~~~~~~~~
2727

28-
If you're deploying the Mattermost server using Docker on an M1 Mac and encountering permission issues in the Docker container, :ref:`re-create the required directories and set their permissions <install/install-docker:deploy mattermost on docker for production use>`, then skip the following command:
28+
If you're deploying the Mattermost server using Docker on an M1 Mac and encountering permission issues in the Docker container, :ref:`re-create the required directories and set their permissions <install/install-docker:deploy mattermost on docker (production)>`, then skip the following command because it causes the deploy to stop working.
2929

3030
.. code-block:: sh
3131
3232
sudo chown -R 2000:2000 ./volumes/app/mattermost
3333
34-
On M1 systems, this permission change causes the deploy to stop working, so we recommend skipping this step altogether.
35-
3634
If you're experiencing issues deploying on Docker generally, ensure the docker daemon is enabled and running:
3735

3836
.. code-block:: sh

source/preferences/manage-your-plugin-preferences.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Microsoft Teams plugin preferences
1414

1515
Select **MS Teams** to connect your Mattermost and Microsoft Teams accounts, and manage notification preferences for Microsoft Teams chats and group chats.
1616

17-
See the :ref:`connect your account <collaborate/collaborate-within-connected-microsoft-teams:connect your mattermost account to your microsoft teams account>` and :ref:`enable notifications <collaborate/collaborate-within-connected-microsoft-teams:enable notifications>` documentation for details.
17+
See the :ref:`manage notifications <collaborate/collaborate-within-connected-microsoft-teams:manage notification settings>` documentation for details.
1818

1919
.. tip::
2020

0 commit comments

Comments
 (0)