Skip to content

Commit

Permalink
Added redirects, editorial pass
Browse files Browse the repository at this point in the history
  • Loading branch information
cwarnermm committed Feb 18, 2025
1 parent d3f229e commit 9bf8a5a
Show file tree
Hide file tree
Showing 4 changed files with 104 additions and 85 deletions.
11 changes: 11 additions & 0 deletions source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -2545,6 +2545,17 @@ def setup(_: Sphinx):
"https://docs.mattermost.com/install/install-rhel.html#remove-mattermost",
"install/install-rhel-8.html#frequently-asked-questions":
"https://docs.mattermost.com/install/install-rhel.html#frequently-asked-questions",
"install/install-rhel-8.html#set-the-correct-contexts-for-opt-mattermost":
"https://docs.mattermost.com/install/install-rhel.html#set-bin-contexts-for-opt-mattermost-bin",
"install/install-kubernetes.html#install-mattermost-on-kubernetes":
"https://docs.mattermost.com/install/install-kubernetes.html#intended-outcome-and-deployment-recommendations",
"install/install-kubernetes.html#install-the-operators":
"https://docs.mattermost.com/install/install-kubernetes.html#installation-steps",
"install/install-kubernetes.html#mattermost-cloudnative-bootstrapper-sneak-peek":
"https://docs.mattermost.com/install/install-kubernetes.html",
"install/install-kubernetes.html#does-the-mattermost-operator-replace-the-mattermost-helm-chart":
"https://docs.mattermost.com/install/install-kubernetes.html#frequently-asked-questions",


# Integrations redirects.
# The integrations directory and its contents have been archived in FY23 Q2 and all applicable content has been moved from docs.mm.com to developers.mm.com.
Expand Down
2 changes: 1 addition & 1 deletion source/configure/calls-deployment.rst
Original file line number Diff line number Diff line change
Expand Up @@ -449,7 +449,7 @@ This is a sample diagram showing how the ``rtcd`` standalone service can be depl
.. image:: ../images/calls-deployment-kubernetes.png
:alt: A diagram of calls deployed in a Kubernetes cluster.

If Mattermost isn't deployed in a Kubernetes cluster, and you want to use this deployment type, visit the :ref:`Kubernetes operator guide <install/install-kubernetes:mattermost operator>`.
If Mattermost isn't deployed in a Kubernetes cluster, and you want to use this deployment type, see the :doc:`Deploy Mattermost on Kubernetes </install/install-kubernetes>` documentation.

Helm Charts
~~~~~~~~~~~
Expand Down
37 changes: 17 additions & 20 deletions source/install/install-docker.rst
Original file line number Diff line number Diff line change
Expand Up @@ -98,16 +98,16 @@ To deploy Mattermost on Docker:

.. code-block:: sh
mkdir -p ./volumes/web/cert
cp <PATH-TO-PRE-EXISTING-CERT>.pem ./volumes/web/cert/cert.pem
cp <PATH-TO-PRE-EXISTING-KEY>.pem ./volumes/web/cert/key-no-password.pem
mkdir -p ./volumes/web/cert
cp <PATH-TO-PRE-EXISTING-CERT>.pem ./volumes/web/cert/cert.pem
cp <PATH-TO-PRE-EXISTING-KEY>.pem ./volumes/web/cert/key-no-password.pem
To include the certificate and key, ensure the following lines in your ``.env`` file points to the appropriate files.

.. code-block:: sh
CERT_PATH=./volumes/web/cert/cert.pem
KEY_PATH=./volumes/web/cert/key-no-password.pem
CERT_PATH=./volumes/web/cert/cert.pem
KEY_PATH=./volumes/web/cert/key-no-password.pem
6. Deploy Mattermost.

Expand Down Expand Up @@ -176,56 +176,53 @@ The production deployment solution is designed to deploy Mattermost on Docker in
- ``POSTGRES_HOST``

.. important::

At a minimum, you must edit the ``DOMAIN`` value in the ``.env`` file to correspond to the domain for your Mattermost server.

.. note::
We recommend configuring the `Support Email <https://docs.mattermost.com/administration/config-settings.html#support-email>`_ via ``MM_SUPPORTSETTINGS_SUPPORTEMAIL``. This is the email address your users will contact when they need help.
- At a minimum, you must edit the ``DOMAIN`` value in the ``.env`` file to correspond to the domain for your Mattermost server.
- We recommend configuring the `Support Email <https://docs.mattermost.com/administration/config-settings.html#support-email>`_ via ``MM_SUPPORTSETTINGS_SUPPORTEMAIL``. This is the email address your users will contact when they need help.

3. Create the required directories and set their permissions.

.. important::

If you're using an external storage solution, you'll need to mount the storage to the ``volumes`` directory now.

.. code-block:: sh
mkdir -p ./volumes/app/mattermost/{config,data,logs,plugins,client/plugins,bleve-indexes}
sudo chown -R 2000:2000 ./volumes/app/mattermost
4. Deploy Mattermost.

.. code-block:: sh
sudo docker compose -f docker-compose.yml up -d
To access your new Mattermost deployment, navigate to ``http://<YOUR_MM_DOMAIN>:8065/`` in your browser.

To shut down your deployment:

.. code-block:: sh
sudo docker compose -f docker-compose.yml down
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:

.. code-block:: sh
.. code-block:: sh
#GITLAB_PKI_CHAIN_PATH=<path_to_your_gitlab_pki>/pki_chain.pem
#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:

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

0 comments on commit 9bf8a5a

Please sign in to comment.