You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: source/install/common-omnibus-tip.rst
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,5 +3,5 @@
3
3
4
4
.. tip::
5
5
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.
Copy file name to clipboardExpand all lines: source/install/common-postgres-database-important.rst
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,4 +3,4 @@
3
3
4
4
.. important::
5
5
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.
Copy file name to clipboardExpand all lines: source/install/install-docker.rst
+24-22Lines changed: 24 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,11 +19,11 @@ If you don't have Docker installed, follow the instructions below based on your
19
19
20
20
.. tab:: Ubuntu
21
21
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.
23
23
24
24
.. tab:: Fedora
25
25
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.
27
27
28
28
.. _Deploy Mattermost on Docker:
29
29
@@ -32,21 +32,22 @@ Before you begin
32
32
33
33
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.
34
34
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.
37
37
38
38
.. note::
39
39
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.
41
41
42
42
Deploy Mattermost on Docker (Quick Start)
43
43
-----------------------------------------
44
44
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.
46
46
47
47
.. important::
48
48
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.
50
51
- Encountering issues with your Docker deployment? See the :ref:`Docker deployment troubleshooting <install/troubleshooting:docker deployments>` documentation for details.
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.
79
80
80
81
**If creating a new certificate and key:**
81
82
@@ -105,8 +106,6 @@ To deploy Mattermost on Docker:
105
106
CERT_PATH=./volumes/web/cert/cert.pem
106
107
KEY_PATH=./volumes/web/cert/key-no-password.pem
107
108
108
-
109
-
110
109
6. Deploy Mattermost.
111
110
112
111
**Without using the included NGINX:**
@@ -140,17 +139,17 @@ To deploy Mattermost on Docker:
140
139
7. Create your first Mattermost system admin user, :doc:`invite more users </collaborate/manage-channel-members>`, and explore the Mattermost platform.
141
140
142
141
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.
144
145
145
146
.. important::
146
147
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.
148
149
- Mattermost recommends the use of an external storage solution like AWS S3, Google Cloud Storage, or Azure Blob Storage for production deployments.
149
150
- Mattermost recommends the use of an external reverse proxy for production deployments.
150
151
- Encountering issues with your Docker deployment? See the :ref:`Docker deployment troubleshooting <install/troubleshooting:docker deployments>` documentation for details.
151
152
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
-
154
153
1. In a terminal window, clone the repository and enter the directory.
155
154
156
155
.. code-block:: sh
@@ -164,7 +163,7 @@ The Production deployment solution is designed to deploy Mattermost on Docker in
164
163
165
164
cp env.example .env
166
165
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:
168
167
169
168
- ``POSTGRES_USER``
170
169
- ``POSTGRES_PASSWORD``
@@ -205,34 +204,37 @@ The Production deployment solution is designed to deploy Mattermost on Docker in
205
204
5. Create your first Mattermost system admin user, :doc:`invite more users </collaborate/manage-channel-members>`, and explore the Mattermost platform.
206
205
207
206
208
-
Configure SSO With Gitlab (Optional)
207
+
Configure SSO With GitLab (Optional)
209
208
-------------------------------------
210
209
211
210
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.
212
211
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:
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.
230
232
231
233
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.
232
234
233
235
For additional help or questions, please refer to `this issue <https://github.com/mattermost/mattermost-docker/issues/489>`__.
Copy file name to clipboardExpand all lines: source/install/troubleshooting.rst
+1-3Lines changed: 1 addition & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,14 +25,12 @@ Deployment troubleshooting
25
25
Docker deployments
26
26
~~~~~~~~~~~~~~~~~~
27
27
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.
29
29
30
30
.. code-block:: sh
31
31
32
32
sudo chown -R 2000:2000 ./volumes/app/mattermost
33
33
34
-
On M1 systems, this permission change causes the deploy to stop working, so we recommend skipping this step altogether.
35
-
36
34
If you're experiencing issues deploying on Docker generally, ensure the docker daemon is enabled and running:
Copy file name to clipboardExpand all lines: source/preferences/manage-your-plugin-preferences.rst
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ Microsoft Teams plugin preferences
14
14
15
15
Select **MS Teams** to connect your Mattermost and Microsoft Teams accounts, and manage notification preferences for Microsoft Teams chats and group chats.
16
16
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.
0 commit comments