# Synapse charm

> Documentation for the Synapse charm, a Juju charm that deploys and manages Synapse, a Matrix homeserver, on Kubernetes. It covers deployment, SMTP integration, backup and restore, scaling and charm architecture.


2026

## Pages

- [Synapse charm](https://canonical.com/juju/docs/synapse-charm/latest/index.html.md): Learn how to deploy, configure and operate the Synapse charm using Juju.
- [Tutorial](https://canonical.com/juju/docs/synapse-charm/latest/tutorial/index.html.md): Follow step-by-step tutorials to get started with the Synapse charm.
- [Deploy the Synapse charm for the first time](https://canonical.com/juju/docs/synapse-charm/latest/tutorial/getting-started/index.html.md): - Deploy the Synapse charm.
- [How-to guides](https://canonical.com/juju/docs/synapse-charm/latest/how-to/index.html.md): How-to guides for operating the Synapse charm, including SMTP, backups, and scaling.
- [How to back up and restore Synapse](https://canonical.com/juju/docs/synapse-charm/latest/how-to/backup-and-restore/index.html.md): This document shows how to back up and restore Synapse.
- [How to integrate with SMTP for sending notifications](https://canonical.com/juju/docs/synapse-charm/latest/how-to/configure-smtp/index.html.md): This document shows how to integrate Synapse with SMTP for sending
- [How to horizontally scale](https://canonical.com/juju/docs/synapse-charm/latest/how-to/horizontally-scale/index.html.md): A Synapse deployment can scale horizontally by running multiple Synapse processes called workers.
- [How to contribute](https://canonical.com/juju/docs/synapse-charm/latest/how-to/contribute/index.html.md): Familiarize yourself with contributing to the synapse charm documentation.
- [Reference](https://canonical.com/juju/docs/synapse-charm/latest/reference/index.html.md): Technical reference documentation for the Synapse charm, including actions, configurations, and integrations.
- [Actions](https://canonical.com/juju/docs/synapse-charm/latest/reference/actions/index.html.md): See Actions.
- [Configurations](https://canonical.com/juju/docs/synapse-charm/latest/reference/configurations/index.html.md): See Configurations.
- [External access](https://canonical.com/juju/docs/synapse-charm/latest/reference/external-access/index.html.md): Synapse charm requires external access depending on configuration options or Federation required.
- [Integrations](https://canonical.com/juju/docs/synapse-charm/latest/reference/integrations/index.html.md): *Interface*: `s3`
- [Charm architecture](https://canonical.com/juju/docs/synapse-charm/latest/reference/charm-architecture/index.html.md): Synapse is a drop in replacement for other chat servers like Mattermost and
- [Changelog](https://canonical.com/juju/docs/synapse-charm/latest/changelog/index.html.md): All notable changes to this project will be documented in this file.