---
title: Charmhub | Deploy Synapse using Charmhub - The Open Operator Collection
description: Deploy the latest version of Synapse as a Kubernetes Operator on any
  cloud. Matrix synapse chat server.
url: https://charmhub.io/synapse
---

# Synapse

[Canonical IS DevOps](https://charmhub.io/publisher/canonical-is-devops "View all packages from Canonical IS DevOps")

* [Canonical IS DevOps](https://charmhub.io/publisher/canonical-is-devops "View all packages from Canonical IS DevOps")

Platform:

stable 426

```
juju deploy synapse
```

[Learn to deploy on juju >](https://juju.is/docs/juju/manage-applications)

---

#### Relevant links

* [Homepage](https://github.com/canonical/synapse-operator)
* [Contact](https://launchpad.net/~canonical-is-devops)

---

#### Contacts

##### Maintainers

+ [Launchpad Team](https://launchpad.net/~canonical-is-devops)

* [Submit a bug](https://github.com/canonical/synapse-operator/issues)

---

Share your thoughts on this charm with the community on discourse.

[Join the discussion](https://discourse.charmhub.io/)

# Synapse Operator

A Juju charm deploying and managing [Synapse](https://github.com/matrix-org/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](https://microk8s.io) to [Charmed Kubernetes](https://ubuntu.com/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.

## [In this documentation](https://charmhub.io/synapse#p-26952-in-this-documentation)

|  |  |
| --- | --- |
| [Tutorials](https://charmhub.io/synapse/docs/tutorial-getting-started)  Get started - a hands-on introduction to using the charm for new users | [How-to guides](https://charmhub.io/synapse/docs/how-to-configure-smtp)   Step-by-step guides covering key operations and common tasks |
| [Reference](https://charmhub.io/synapse/docs/reference-actions)   Technical information - specifications, APIs, architecture | [Explanation](https://charmhub.io/synapse/docs/explanation-charm-architecture)   Concepts - discussion and clarification of key topics |

## [Contributing to this documentation](https://charmhub.io/synapse#p-26952-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](https://discourse.charmhub.io/) 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](https://github.com/canonical/synapse-operator/issues).

## [Project and community](https://charmhub.io/synapse#p-26952-project-and-community)

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

* [Read our Code of Conduct](https://ubuntu.com/community/code-of-conduct)
* [Join the Discourse forum](https://discourse.charmhub.io/tag/synapse)
* [Discuss on the Matrix chat service](https://matrix.to/#/#charmhub-charmdev:ubuntu.com)
* Contribute and report bugs to [the Synapse operator](https://github.com/canonical/synapse-operator)
* Check the [release notes](https://github.com/canonical/synapse-operator/releases)

---

[Help improve this document in the forum](https://discourse.charmhub.io/t/synapse-documentation-overview/11358) ([guidelines](https://discourse.charmhub.io/t/how-to-write-docs-our-documentation-guidelines-for-contributors/1245)). Last updated 1 year, 1 month ago.