--- 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/configurations --- # 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) * [allow\_public\_rooms\_over\_federation](https://charmhub.io/synapse/configurations#allow_public_rooms_over_federation) * [backup\_passphrase](https://charmhub.io/synapse/configurations#backup_passphrase) * [block\_non\_admin\_invites](https://charmhub.io/synapse/configurations#block_non_admin_invites) * [enable\_email\_notifs](https://charmhub.io/synapse/configurations#enable_email_notifs) * [enable\_mjolnir](https://charmhub.io/synapse/configurations#enable_mjolnir) * [enable\_password\_config](https://charmhub.io/synapse/configurations#enable_password_config) * [enable\_room\_list\_search](https://charmhub.io/synapse/configurations#enable_room_list_search) * [experimental\_alive\_check](https://charmhub.io/synapse/configurations#experimental_alive_check) * [federation\_domain\_whitelist](https://charmhub.io/synapse/configurations#federation_domain_whitelist) * [invite\_checker\_blocklist\_allowlist\_url](https://charmhub.io/synapse/configurations#invite_checker_blocklist_allowlist_url) * [invite\_checker\_policy\_rooms](https://charmhub.io/synapse/configurations#invite_checker_policy_rooms) * [ip\_range\_whitelist](https://charmhub.io/synapse/configurations#ip_range_whitelist) * [limit\_remote\_rooms\_complexity](https://charmhub.io/synapse/configurations#limit_remote_rooms_complexity) * [notif\_from](https://charmhub.io/synapse/configurations#notif_from) * [public\_baseurl](https://charmhub.io/synapse/configurations#public_baseurl) * [publish\_rooms\_allowlist](https://charmhub.io/synapse/configurations#publish_rooms_allowlist) * [rc\_joins\_remote\_burst\_count](https://charmhub.io/synapse/configurations#rc_joins_remote_burst_count) * [rc\_joins\_remote\_per\_second](https://charmhub.io/synapse/configurations#rc_joins_remote_per_second) * [report\_stats](https://charmhub.io/synapse/configurations#report_stats) * [server\_name](https://charmhub.io/synapse/configurations#server_name) * [trusted\_key\_servers](https://charmhub.io/synapse/configurations#trusted_key_servers) * [workers\_ignore\_list](https://charmhub.io/synapse/configurations#workers_ignore_list) [Learn about configurations >](https://juju.is/docs/juju/configuration#heading--application-configuration) * allow\_public\_rooms\_over\_federation | boolean Allows any other homeserver to fetch the server's public rooms directory via federation. * backup\_passphrase | string Passphrase used to encrypt a backup using gpg with symmetric key. * block\_non\_admin\_invites | boolean When enabled, room invites to users on this server will be blocked (except those sent by local server admins). * enable\_email\_notifs | boolean Configures whether to enable e-mail notifications. Requires SMTP integration. * enable\_mjolnir | boolean Configures whether to enable Mjolnir - moderation tool for Matrix. Reference: https://github.com/matrix-org/mjolnir * enable\_password\_config | boolean Default: True Defaults to true. If Synapse uses a single sign-on provider for authentication, this option can be used to disable the regular login flow. * enable\_room\_list\_search | boolean Default: True When disabled, blocks searching local and remote room lists for local and remote users by always returning an empty list for all queries. * experimental\_alive\_check | string Default: 2m,5,20s Comma separated list of period,threshold and timeout for Synapse pebble alive check. Refer to https://github.com/canonical/pebble/#layer-specification to more details about allowed values. This is an experimental feature and may be removed in future releases. * federation\_domain\_whitelist | string Comma separated list of domains to be allowed to federate. * invite\_checker\_blocklist\_allowlist\_url | string URL to fetch the JSON file containing the allowlist and blocklist. * invite\_checker\_policy\_rooms | string Comma separated list of rooms to be used by the invite checker module. * ip\_range\_whitelist | string Comma separated list of IP address CIDR ranges that should be allowed for federation, identity servers, push servers, and for checking key validity for third-party invite events. * limit\_remote\_rooms\_complexity | float if set, the room "complexity" will be checked before a user joins a new remote room. If the complexity is higher, the user will not be able to join the room. * notif\_from | string defines the "From" address to use when sending emails. It must be set if the SMTP integration is enabled. Defaults to server\_name. * public\_baseurl | string The public-facing base URL that clients use to access this Homeserver. Defaults to https:///. Only used if there is integration with SAML integrator charm. * publish\_rooms\_allowlist | string Comma separated list of users allowed to publish rooms. Once is set, no other users will be allowed to publish rooms. This takes the form of user1:domainX.com,user2:domainY.com... * rc\_joins\_remote\_burst\_count | int Default: 10 Allows for ratelimiting number of remote rooms a user can join before being throttled. * rc\_joins\_remote\_per\_second | float Default: 0.01 Allows for ratelimiting number of remote rooms a user can join per second. * report\_stats | boolean Configures whether to report statistics. * server\_name | string Synapse server name. Must be set to deploy the charm. Corresponds to the server\_name option on Synapse configuration file and sets the public-facing domain of the server. * trusted\_key\_servers | string Comma separated list of trusted servers to download signing keys from. Synapse configuration sets default to matrix.org. * workers\_ignore\_list | string Comma separated list of workers that should be ignored while setting instance\_map and stream writers. This configuration should be used in case of unrecoverable broken units and takes the form of worker0,worker1