Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deployment Section Restructure [WIP] #7816

Open
wants to merge 17 commits into
base: master
Choose a base branch
from
Open

Deployment Section Restructure [WIP] #7816

wants to merge 17 commits into from

Conversation

DSchalla
Copy link
Member

Summary

  • Created a new deployment section structure with improved organization
  • Moved and reorganized existing documentation into logical subdirectories
  • Added new overview and architecture documentation
  • Combine available installation guides into tabs on the same page and deprecate others.

(NOTE: This is still a work in progress, with the same placeholders in place and content missing from the previous structure that must be carried over.)

Copy link

Newest code from mattermost has been published to preview environment for Git SHA 7d972f9

Copy link

Newest code from mattermost has been published to preview environment for Git SHA 53ed7b9

Copy link

Newest code from mattermost has been published to preview environment for Git SHA 3156681

Copy link

Newest code from mattermost has been published to preview environment for Git SHA 17dac6e

Copy link

Newest code from mattermost has been published to preview environment for Git SHA 749e62b

Copy link
Contributor

@hanzei hanzei left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work! I like the guided approach to helping admins choose the right deployment method for their use case.


**System Extensions**

Mattermost is not only a collaboration tool but also a platform designed for extensibility. Key extensibility features include:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we mention SAML and LDAP here? For most enterprises, these are keen system to integrate.

ALTER DATABASE mattermost OWNER TO mmuser;
GRANT USAGE, CREATE ON SCHEMA PUBLIC TO mmuser;

3. Configure PostgreSQL for remote connections (if database is on a separate server):
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if we should make it more clear that this only needs to be done if the DB is not on the same server.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are you looking for something more than just:

(if database is on a separate server)


.. code-block:: sh

sudo chown -R mattermost:mattermost /opt/mattermost/data
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did the admin already create the mattermost account by this point in the guide?

Comment on lines +159 to +161
- Application ports: 80/443 (TCP) for HTTP/HTTPS
- Database port: 5432 (TCP) for PostgreSQL
- SMTP port: 10025 (TCP/UDP) for outbound email
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we make it clearer which are outgoing and which are incoming connections?

.. important::
This deployment method is not recommended for production environments. If you're looking to deploy a production Mattermost instance, we recommend using managed container services like AWS ECS, Azure Container Apps, or Google Cloud Run. These services provide better scalability, reliability, and maintenance features suited for production workloads.
- This deployment method isn't recommended for production environments.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What are the downsides of a docker deployment vs a tarball one? As a matter of fact, there are a lot of Docker deployments out there.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


The Mattermost desktop application is available for Windows, macOS, and Linux operating systems. Learn about installation, configuration, and management options for deploying the desktop app in your environment.

This documentation provides guidance on deploying and managing the Mattermost Desktop application across your organization.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All these detailed guides are great, but I wonder if we also should have a "vanilla" one.

What should an admin do if they want to roll out the desktop in their org? What installers exists?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree

Comment on lines +163 to +172
System requirements
--------------------

Ensure your system meets these minimum requirements:

- Operating System: 64-bit Linux distribution
- Hardware: 1 vCPU/core with 2GB RAM (supports up to 1,000 users)
- Storage: Minimum 10GB available space
- Database: PostgreSQL v13+
- Network: Reliable internet connection with sufficient bandwidth
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we have more detailed guidelines on the system requirements in the new docs? In the old version, there was a handy page with the suggested resources (https://docs.mattermost.com/scale/scaling-for-enterprise.html). Does that still exist?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It does still exist, yes. And I agree that we'll need to connect our deployment guidance to our scaling guidance

@cwarnermm
Copy link
Member

@nickmisasi - Can I get your help answering @hanzei's inline questions, please?

@nickmisasi
Copy link
Contributor

@cwarnermm I have answered what I can. @DSchalla will probably be better to answer the rest as he's got a more holistic view of the changes in this PR

Copy link

Newest code from mattermost has been published to preview environment for Git SHA 24604f8

Copy link

Newest code from mattermost has been published to preview environment for Git SHA e52224c

Copy link

Newest code from mattermost has been published to preview environment for Git SHA ed05ee4

Copy link

Newest code from mattermost has been published to preview environment for Git SHA 76cdd88

Copy link

Newest code from mattermost has been published to preview environment for Git SHA 4c8b30b

Copy link

Newest code from mattermost has been published to preview environment for Git SHA 946d2c8

Copy link

Newest code from mattermost has been published to preview environment for Git SHA 8ac664a

Copy link

Newest code from mattermost has been published to preview environment for Git SHA b7699ac

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants