Synapse
- Canonical IS DevOps
Channel | Revision | Published | Runs on |
---|---|---|---|
latest/stable | 426 | 20 Sep 2024 | |
latest/edge | 495 | 28 Nov 2024 | |
2/edge | 518 | 20 Dec 2024 | |
1/stable | 303 | 30 Jul 2024 | |
1/edge | 345 | 31 Jul 2024 |
juju deploy synapse
Deploy Kubernetes operators easily with Juju, the Universal Operator Lifecycle Manager. Need a Kubernetes cluster? Install MicroK8s to create a full CNCF-certified Kubernetes system in under 60 seconds.
Platform:
-
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://<server_name>/. 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