This charm simplifies initial deployment and “day N” operations of Discourse on Kubernetes, such as scaling the number of instances, integration with SSO, access to S3 for redundant file storage and more. It allows for deployment on many different Kubernetes platforms, from MicroK8s or Charmed Kubernetes to public cloud Kubernetes offerings.
Discourse is an open-source software application used to create customer-friendly and community-friendly discussion platforms, forums, and mailing lists. It’s designed to work as a discussion platform for various topics and is widely used by numerous organizations and individuals to build communities, provide customer support, and facilitate conversations. The platform is built with a focus on simplicity, user-friendliness, and responsiveness, making it accessible from both desktops and mobile devices. Discourse provides various moderation and administration tools, enabling community managers to maintain a healthy and constructive environment.
In this documentation
| Tutorials Get started - a hands-on introduction to using the Charmed Discourse 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, 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
The Discourse Operator is a member of the Ubuntu family. It’s an open source project that warmly welcomes community projects, contributions, suggestions, fixes and constructive feedback.
Navigation
| Level | Path | Navlink |
|---|---|---|
| 1 | explanation | Explanation |
| 2 | explanation-charm-architecture | Charm architecture |
| 1 | how-to | How To |
| 2 | how-to-access–the-rails-console | Access the Rails console |
| 2 | how-to-backup-and-restore | Backup and restore |
| 2 | how-to-configure-container | Configure the container |
| 2 | how-to-configure-hostname | Configure the hostname |
| 2 | how-to-configure-s3 | Configure S3 |
| 2 | how-to-configure-saml | Configure SAML |
| 2 | how-to-configure-smtp | Configure SMTP |
| 2 | how-to-contribute | Contribute |
| 2 | how-to-upgrade | Upgrade |
| 1 | reference | Reference |
| 2 | reference-actions | Actions |
| 2 | reference-configurations | Configurations |
| 2 | reference-external-access | External Access |
| 2 | reference-integrations | Integrations |
| 2 | reference-plugins | Plugins |
| 1 | tutorial | Getting started |