Synapse charm

A Juju charm deploying and managing Synapse on Kubernetes. Synapse is a drop-in replacement for other chat servers like Mattermost and Slack.

This charm simplifies the deployment and ongoing operations of Synapse on Kubernetes, such as integration with SSO, access to S3 for redundant file storage 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 Synapse straightforward through Juju’s clean interface. It will allow easy deployment into multiple environments for testing of changes.

In this documentation

Get started

Guided tutorial

Deployment

Integrate with SMTP | Configurations | Actions

Operations

Back up and restore | Horizontally scale | Relation endpoints

Design

Charm architecture

Security

Federation and external access

How this documentation is organized

This documentation uses the Diátaxis documentation structure.

  • The Tutorial takes you step-by-step through deploying the Synapse charm for the first time.

  • How-to guides assume basic familiarity with the Synapse charm. They cover key operations and common tasks such as backups, scaling, and SMTP integration.

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

  • The Changelog holds a record of all notable changes to the charm.

Project and community

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