Mattermost Documentation Overview

Mattermost Operator

A Juju charm deploying and managing Mattermost on Kubernetes. Mattermost is an open-source, self-hostable online chat service with file sharing, search, and integrations.

This charm simplifies operations of Mattermost on Kubernetes, such as scaling the number of instances and clustering, access to S3 and more. It allows for deployment on many different Kubernetes platforms, from MicroK8s to Charmed Kubernetes to public cloud Kubernetes offerings.

For DevOps or SRE teams this charm will make operating Mattermost simple and straightforward through Juju’s clean interface.

In this documentation

Tutorials
Get started - a hands-on introduction to using the Charmed Mattermost operator for new users
How-to guides
Step-by-step guides covering key operations and common tasks
Reference
Technical information - specifications, APIs, architecture
Explanation
Concepts - discussion and clarification of key topics

Contributing to this documentation

Documentation is an important part of this project, and we take the same open-source approach to the documentation as the code. As such, we welcome community contributions, suggestions and constructive feedback on our documentation. Our documentation is hosted on the Charmhub forum to enable easy collaboration. Please use the “Help us improve this documentation” links on each documentation page to either directly change something you see that’s wrong, or ask a question, or make a suggestion about a potential change via the comments section.

If there’s a particular area of documentation that you’d like to see that’s missing, please file a bug.

Project and community

Charmed Mattermost is an open-source project that welcomes community contributions, suggestions, fixes and constructive feedback.

Navigation

Mapping table
Level Path Navlink
1 tutorial Tutorial
2 tutorial-deploy-the-mattermost-charm-for-the-first-time Deploy the Mattermost charm for the first time
1 how-to How to
2 authenticate Authenticate
2 contribute Contribute
2 handle-database-relations Handle Database Relations
2 configure-ingress-tls Configure Ingress & TLS
2 add-plugins-custom-images Add Plugins & Custom Images
2 scale-and-monitor-performance Scale & Monitor Performance
2 upgrade Upgrade
1 reference Reference
2 reference-actions Actions
2 reference-configurations Configurations
2 reference-integrations Integrations
1 explanation Explanation
2 architecture Architecture

Redirects

Mapping table
Path Location
/t/mattermost-docs-tutorial-getting-started/10901 /t/mattermost-docs-tutorial-deploy-the-mattermost-charm-for-the-first-time/10901
charmhub.io/mattermost-k8s/docs/tutorials-getting-started Charmhub | Deploy Mattermost using Charmhub - The Open Operator Collection
/t/mattermost-documentation-authentication/3761 /t/mattermost-documentation-authenticate/3761
/t/mattermost-documentation-contributing-hacking/3762 /t/mattermost-documentation-contribute/3762
/t/mattermost-documentation-database-relations/3759 /t/mattermost-documentation-handle-database-relations/3759
/t/mattermost-documentation-ingress-tls/3760 /t/mattermost-documentation-configure-ingress-tls/3760
/t/mattermost-documentation-plugins-custom-images/3763 /t/mattermost-documentation-add-plugins-custom-images/3763
/t/mattermost-documentation-scaling-performance-monitoring/3766 /t/mattermost-documentation-scale-monitor-performance/3766
/t/mattermost-documentation-upgrades/3764 /t/mattermost-documentation-upgrade/3764
charmhub.io/mattermost-k8s/docs/authentication Charmhub | Deploy Mattermost using Charmhub - The Open Operator Collection
charmhub.io/mattermost-k8s/docs/contributing-hacking Charmhub | Deploy Mattermost using Charmhub - The Open Operator Collection
charmhub.io/mattermost-k8s/docs/database-relations Charmhub | Deploy Mattermost using Charmhub - The Open Operator Collection
charmhub.io/mattermost-k8s/docs/ingress-tls Charmhub | Deploy Mattermost using Charmhub - The Open Operator Collection
charmhub.io/mattermost-k8s/docs/plugins-custom-images Charmhub | Deploy Mattermost using Charmhub - The Open Operator Collection
charmhub.io/mattermost-k8s/docs/scaling-performance-monitoring charmhub.io/mattermost-k8s/docs/scale-monitor-performance
charmhub.io/mattermost-k8s/docs/upgrades Charmhub | Deploy Mattermost using Charmhub - The Open Operator Collection
1 Like