Synapse Documentation Overview

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 initial deployment and “day N” 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.

As such, the charm makes it easy for those looking to take control of their own Chat server whilst keeping operations simple, and gives them the freedom to deploy on the Kubernetes platform of their choice.

For DevOps or SRE teams this charm will make operating Synapse simple and straightforward through Juju’s clean interface. It will allow easy deployment into multiple environments for testing of changes.

Project and community

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

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, or 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.

Navigation

Level Path Navlink
1 tutorial Tutorial
2 tutorial-getting-started Getting Started
1 how-to How to
2 how-to-configure-smtp Configure SMTP
2 how-to-backup-and-restore Backup and Restore
2 how-to-contribute Contribute
2 how-to-horizontally-scale How to horizontally scale
1 reference Reference
2 reference-actions Actions
2 reference-external-access External access
2 reference-integrations Integrations
1 explanation Explanation
2 explanation-charm-architecture Charm architecture