<!-- vale Canonical.007-Headings-sentence-case = NO -->
<!-- "Operator" is part of the name -->

# Discourse Operator

<!-- vale Canonical.007-Headings-sentence-case = YES -->

A [Juju](https://canonical.com/juju/docs/juju-cli/3.6/reference/juju/#juju) [charm](https://canonical.com/juju/docs/juju-cli/3.6/reference/charm/#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](https://canonical.com/microk8s) or [Charmed Kubernetes](https://ubuntu.com/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](https://canonical.com/juju/docs/discourse-k8s-charm/latest/tutorial/index.html.md#tutorial)                                                                                                                                                                                                                                                                                                                                                                                |
| **Deployment**  | [Configure the hostname](https://canonical.com/juju/docs/discourse-k8s-charm/latest/how-to/configure-hostname/index.html.md#how-to-configure-hostname) | [Configure the container](https://canonical.com/juju/docs/discourse-k8s-charm/latest/how-to/configure-container/index.html.md#how-to-configure-container) | [Configure S3](https://canonical.com/juju/docs/discourse-k8s-charm/latest/how-to/configure-s3/index.html.md#how-to-configure-s3) | [Configure SMTP](https://canonical.com/juju/docs/discourse-k8s-charm/latest/how-to/configure-smtp/index.html.md#how-to-configure-smtp) | [Configure SAML](https://canonical.com/juju/docs/discourse-k8s-charm/latest/how-to/configure-saml/index.html.md#how-to-configure-saml) |
| **Operations**  | [Access the Rails console](https://canonical.com/juju/docs/discourse-k8s-charm/latest/how-to/access--the-rails-console/index.html.md#how-to-access-the-rails-console) | [Back up and restore](https://canonical.com/juju/docs/discourse-k8s-charm/latest/how-to/backup-and-restore/index.html.md#how-to-backup-and-restore) | [Upgrade](https://canonical.com/juju/docs/discourse-k8s-charm/latest/how-to/upgrade/index.html.md#how-to-upgrade) |<br/>[Integrations](https://canonical.com/juju/docs/discourse-k8s-charm/latest/reference/integrations/index.html.md#reference-integrations)                                                                                           |
| **Design**      | [Charm architecture](https://canonical.com/juju/docs/discourse-k8s-charm/latest/reference/charm-architecture/index.html.md#reference-charm-architecture) | [Versioning](https://canonical.com/juju/docs/discourse-k8s-charm/latest/reference/versioning/index.html.md#reference-versioning) | [External access](https://canonical.com/juju/docs/discourse-k8s-charm/latest/reference/external-access/index.html.md#reference-external-access) |<br/>[Plugins](https://canonical.com/juju/docs/discourse-k8s-charm/latest/reference/plugins/index.html.md#reference-plugins)                                                                                                         |
| **Security**    | [Overview](https://canonical.com/juju/docs/discourse-k8s-charm/latest/explanation/security/index.html.md#explanation-security)                                                                                                                                                                                                                                                                                                                                                                                      |

## How this documentation is organized

This documentation uses the
[Diátaxis documentation structure](https://diataxis.fr/).

* The [Tutorial](https://canonical.com/juju/docs/discourse-k8s-charm/latest/tutorial/index.html.md#tutorial) takes you step-by-step through your first deployment of the Discourse charm.
* The [How-to guides](https://canonical.com/juju/docs/discourse-k8s-charm/latest/how-to/index.html.md#how-to-index) cover practical tasks for configuring, integrating, and maintaining your Discourse deployment.
* [Reference](https://canonical.com/juju/docs/discourse-k8s-charm/latest/reference/index.html.md#reference-index) provides technical details on actions, configurations, plugins, integrations, and charm architecture.
* [Explanation](https://canonical.com/juju/docs/discourse-k8s-charm/latest/explanation/index.html.md#explanation-index) 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](https://canonical.com/juju/docs/discourse-k8s-charm/latest/how-to/contribute/index.html.md#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](https://github.com/canonical/discourse-k8s-operator/issues).

## 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.

- [Code of conduct](https://ubuntu.com/community/code-of-conduct)
- [File a bug](https://github.com/canonical/discourse-k8s-operator/issues)
- Get support through the [Discourse forum](https://discourse.charmhub.io/)
- Join our [online chat](https://matrix.to/#/#charmhub-charmdev:ubuntu.com)
- [Contribute](https://canonical.com/juju/docs/discourse-k8s-charm/latest/how-to/contribute/index.html.md#how-to-contribute)

Thinking about using the Discourse Operator for your next project?
[Get in touch](https://matrix.to/#/#charmhub-charmdev:ubuntu.com)!