Skip to content

Commit

Permalink
Fixed build warnings & errors
Browse files Browse the repository at this point in the history
  • Loading branch information
cwarnermm committed Feb 10, 2025
1 parent 39bb3de commit a77022b
Show file tree
Hide file tree
Showing 7 changed files with 30 additions and 29 deletions.
2 changes: 1 addition & 1 deletion source/guides/deployment.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Learn how to install, deploy, and scale Mattermost for teams and organizations o
* :doc:`Migrate from MySQL to PostgreSQL </deploy/postgres-migration>` - Learn how to migrate from MySQL to PostgreSQL.
* :doc:`Prepare your Mattermost database </install/prepare-mattermost-database>` - Learn how to prepare and configure a database for Mattermost.
* :doc:`Deploy on Ubuntu </install/install-ubuntu>` - Signed packages direct from Mattermost featuring a single command for install and upgrades.
* :ref:`Deploy using Docker <install/install-docker>` - The fastest way to try Mattermost and a great single server installation option.
* :doc:`Deploy using Docker </install/install-docker>` - The fastest way to try Mattermost and a great single server installation option.
* :doc:`Deploy with a tarball </install/install-tar>` - Support for any Linux distribution.
* :doc:`Deploy using Omnibus </install/installing-mattermost-omnibus>` - An entire Mattermost installation on a single server.
* :doc:`Deploy using Kubernetes </install/install-kubernetes>` - Install using the Mattermost Helm Chart or Operator and simplified updates.
Expand Down
2 changes: 1 addition & 1 deletion source/install/common-omnibus-tip.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@

.. tip::

- 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.
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.

2 changes: 1 addition & 1 deletion source/install/common-postgres-database-important.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@

.. important::

- You need a PostgreSQL database. See the :doc:`database preparation </install/prepare-mattermost-database>` documentation for details on this prerequisite.
You need a PostgreSQL database. See the :doc:`database preparation </install/prepare-mattermost-database>` documentation for details on this prerequisite.
46 changes: 24 additions & 22 deletions source/install/install-docker.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@ If you don't have Docker installed, follow the instructions below based on your

.. tab:: Ubuntu

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

.. tab:: Fedora

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

.. _Deploy Mattermost on Docker:

Expand All @@ -32,21 +32,22 @@ Before you begin

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.

- 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.
- 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.
- If you're looking to try out Mattermost, see the `Docker (Quick Start) <#deploy-mattermost-on-docker-quick-start>`__ section below.
- 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.

.. note::

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

Deploy Mattermost on Docker (Quick Start)
-----------------------------------------

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.
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.

.. important::

- 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.
- This deployment solution is not recommended for production use. See the `Docker for production use <#deploy-mattermost-on-docker-for-production-use>`__ section instead.
- 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.
- Encountering issues with your Docker deployment? See the :ref:`Docker deployment troubleshooting <install/troubleshooting:docker deployments>` documentation for details.

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

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

Expand Down Expand Up @@ -105,8 +106,6 @@ To deploy Mattermost on Docker:
CERT_PATH=./volumes/web/cert/cert.pem
KEY_PATH=./volumes/web/cert/key-no-password.pem
6. Deploy Mattermost.

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

Deploy Mattermost on Docker (Production)
----------------------------------------------
-----------------------------------------

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.

.. important::

- 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.
- 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.
- Mattermost recommends the use of an external storage solution like AWS S3, Google Cloud Storage, or Azure Blob Storage for production deployments.
- Mattermost recommends the use of an external reverse proxy for production deployments.
- Encountering issues with your Docker deployment? See the :ref:`Docker deployment troubleshooting <install/troubleshooting:docker deployments>` documentation for details.

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.

1. In a terminal window, clone the repository and enter the directory.

.. code-block:: sh
Expand All @@ -164,7 +163,7 @@ The Production deployment solution is designed to deploy Mattermost on Docker in
cp env.example .env
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:
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:

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


Configure SSO With Gitlab (Optional)
Configure SSO With GitLab (Optional)
-------------------------------------

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.

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

.. code-block:: sh
#GITLAB_PKI_CHAIN_PATH=<path_to_your_gitlab_pki>/pki_chain.pem
Then uncomment this line in your ``docker-compose.yml`` file, and ensure it points to the same ``pki_chain.pem`` file:
Then uncomment this line in your ``docker-compose.yml`` file, and ensure it points to the same ``pki_chain.pem`` file:

.. code-block:: sh
# - ${GITLAB_PKI_CHAIN_PATH}:/etc/ssl/certs/pki_chain.pem:ro
Upgrade from ``mattermost-docker``
-----------------------------------

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.
Visit the `mattermost/docker <https://github.com/mattermost/docker>`_ GitHub repository to access the official Docker deployment solution for Mattermost.

.. note::

The `mattermost-docker <https://github.com/mattermost/mattermost-docker>`__ GitHub repository is deprecated.

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.

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

Installing a different version of Mattermost
Install a different version of Mattermost
--------------------------------------------

1. Shut down your deployment.
Expand Down
1 change: 1 addition & 0 deletions source/install/installing-mattermost-omnibus.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ In a terminal window, run the following repository setup command:
curl -o- https://deb.packages.mattermost.com/repo-setup.sh | sudo bash
This command sets up all required repositories and configures:

- PostgreSQL database
- NGINX web server as a proxy
- Certbot for SSL certificate management
Expand Down
4 changes: 1 addition & 3 deletions source/install/troubleshooting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,12 @@ Deployment troubleshooting
Docker deployments
~~~~~~~~~~~~~~~~~~

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:
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.

.. code-block:: sh
sudo chown -R 2000:2000 ./volumes/app/mattermost
On M1 systems, this permission change causes the deploy to stop working, so we recommend skipping this step altogether.

If you're experiencing issues deploying on Docker generally, ensure the docker daemon is enabled and running:

.. code-block:: sh
Expand Down
2 changes: 1 addition & 1 deletion source/preferences/manage-your-plugin-preferences.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Microsoft Teams plugin preferences

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

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.
See the :ref:`manage notifications <collaborate/collaborate-within-connected-microsoft-teams:manage notification settings>` documentation for details.

.. tip::

Expand Down

0 comments on commit a77022b

Please sign in to comment.