Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

652 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CharmHub Badge Publish to edge Promote charm Discourse Status

Discourse Operator

A Juju charm deploying and managing Discourse on Kubernetes. Discourse is the 100% open source discussion platform. Use it as a mailing list, discussion forum or long-form chat room.

Like any Juju charm, this charm supports one-line deployment, configuration, integration, scaling and more. For Charmed Discourse, this includes:

  • Scaling
  • Integration with SSO
  • Integration with S3 for redundant file storage

It allows for deployment on many different Kubernetes platforms, from MicroK8s to Charmed Kubernetes to public cloud Kubernetes offerings.

For information about how to deploy, integrate and manage this charm, see the Official Discourse Operator Documentation.

Get started

You can follow the tutorial here.

Basic operations

The following actions are available for this charm:

  • anonymize-user: anonymize a user
  • create-user: create a new user
  • promote-user: promote a user to admin

You can check out the full list of actions here.

Integrations

This charm can be integrated with other Juju charms and services:

  • Redis: Redis is an open source (BSD licensed), in-memory data structure store, used as a database, cache and message broker.
  • Saml: SAML is an open standard used for authentication.
  • PostgreSQL: PostgreSQL is a powerful, open source object-relational database system.

For a full list of integrations, see the Charmhub documentation.

Learn more

Documentation

Our documentation is stored in the docs directory and can be viewed at https://canonical.com/juju/docs/discourse-k8s-charm/. It is based on the Canonical Sphinx Stack and hosted on Read the Docs. In structuring, the documentation employs the Diátaxis approach.

You may open a pull request with your documentation changes, or you can file a bug to provide constructive feedback or suggestions.

To run the documentation locally before submitting your changes:

cd docs
make run

GitHub runs automatic checks on the documentation to verify spelling, validate links and style guide compliance.

You can (and should) run the same checks locally:

make spelling
make linkcheck
make vale
make lint-md

Project and community

Releases

Packages

Contributors

Languages