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

# 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)

* [anonymize-user](https://charmhub.io/synapse/actions#anonymize-user)
* [create-backup](https://charmhub.io/synapse/actions#create-backup)
* [delete-backup](https://charmhub.io/synapse/actions#delete-backup)
* [list-backups](https://charmhub.io/synapse/actions#list-backups)
* [promote-user-admin](https://charmhub.io/synapse/actions#promote-user-admin)
* [register-user](https://charmhub.io/synapse/actions#register-user)
* [reset-instance](https://charmhub.io/synapse/actions#reset-instance)
* [restore-backup](https://charmhub.io/synapse/actions#restore-backup)

[Learn about actions >](https://juju.is/docs/juju/action)

* anonymize-user

  Anonymizes an user in order to make it GDPR compliant.
* create-backup

  Creates a backup to s3 storage.
* delete-backup

  Delete a backup in s3 storage by backup-id.

  Params

  + backup-id
    string

    The backup-id to identify the backup to delete.

  Required

  backup-id
* list-backups

  Lists backups in s3 storage.
* promote-user-admin

  Promote a user as a server administrator.
  You need to supply a user name.
* register-user

  Registers a user for the Synapse server.
  You need to supply a user name and whether that user should be an admin or not.
* reset-instance

  Set a new server\_name before running this action.
  Once a server\_name is configured, you must start a new instance if you wish a different one.
  This actions will erase all data and create a instance with the new server\_name.
* restore-backup

  Restore a Synapse backup.
  S3 credentials are retrieved from the relation with the S3 integrator charm.
  The server\_name and filesystem configuration for the application should be
  identical to the application restored.

  Params

  + backup-id
    string

    The backup-id to identify the backup to restore.

  Required

  backup-id