Discourse Operator

A Juju charm deploying and managing Discourse on Kubernetes.

Discourse is an open-source software application used to create customer-friendly and community-friendly discussion platforms, forums, and mailing lists. This charm simplifies 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. This charm makes operating Discourse straightforward for DevOps and SRE teams who want to run community forums or support platforms on Kubernetes through Juju’s clean interface.

In this documentation

Get started

Deploy the Discourse charm

Deployment

Configure the hostname | Configure the container | Configure S3 | Configure SMTP | Configure SAML

Operations

Access the Rails console | Back up and restore | Upgrade | Integrations

Design

Charm architecture | Versioning | External access | Plugins

Security

Overview

How this documentation is organized

This documentation uses the Diátaxis documentation structure.

  • The Tutorial takes you step-by-step through your first deployment of the Discourse charm.

  • The How-to guides cover practical tasks for configuring, integrating, and maintaining your Discourse deployment.

  • Reference provides technical details on actions, configurations, plugins, integrations, and charm architecture.

  • Explanation includes context and overviews on key topics such as security.

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. See How to contribute for more information.

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.

Thinking about using the Discourse Operator for your next project? Get in touch!