Skip to content

Commit c0d38e8

Browse files
modified: docs/reference/integrations.md
1 parent 6b9fe9e commit c0d38e8

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

docs/reference/integrations.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,18 @@
11
# Integrations
22

3+
### backup
4+
5+
_Interface_: s3
6+
_Supported charms_: [s3-integrator](https://charmhub.io/s3-integrator/)
7+
8+
In order to perform backups, Synapse has to be integrated with the s3-integrator charm using the
9+
endpoint backup. Backups will be stored, listed and recovered from the location
10+
indicated in the S3 compatible object storage provider configuration provided by the integration.
11+
The Synapse charm will back up the media files, signing keys and sqlite database file if applicable.
12+
If Synapse database integration is used, the Synapse charm will not back up the related database.
13+
14+
Example backup integrate command: `juju integrate synapse:backup s3-integrator`
15+
316
### db
417

518
_Interface_: pgsql
@@ -59,6 +72,17 @@ relation becomes active. For more information about the metrics exposed, refer t
5972

6073
Metrics-endpoint integrate command: `juju integrate synapse prometheus-k8s`
6174

75+
### redis
76+
77+
_Interface_: redis
78+
_Supported charms_: [redis-k8s](https://charmhub.io/redis-k8s)
79+
80+
Integrating Synapse with Redis is required by horizontal scaling the charm.
81+
82+
See more information in [Scaling synapse via workers](https://matrix-org.github.io/synapse/latest/workers.html) in documentation repository for Synapse.
83+
84+
Example redis integrate command: `juju integrate synapse redis-k8s`
85+
6286
### saml
6387

6488
_Interface_: saml
@@ -73,4 +97,24 @@ Note that `public_baseurl` configuration set the public-facing base URL that
7397
clients use to access this Homeserver. It's used as `entity_id` if set instead of
7498
https://server_name.
7599

100+
See more information in [Charm Architecture](https://charmhub.io/synapse/docs/explanation-charm-architecture).
101+
102+
103+
### smtp
104+
105+
_Interface_: smtp
106+
_Supported charms_: [smtp-integrator](https://charmhub.io/smtp-integrator/)
107+
108+
Integrating Synapse with SMTP Integrator provides SMTP configuration details so
109+
a smtp server can be used in Synapse.
110+
111+
Example smtp integrate command: `juju integrate synapse smtp-integrator:smtp`
112+
113+
Note that the smtp-integrator provides two interfaces, `smtp` and `smtp-legacy`.
114+
Only use the first one if the Juju version used supports secrets. The "From" email
115+
is set with the Synapse configuration option `notif_from`.
116+
117+
For the smtp-integrator, insecure configurations with `transport_security=none` or not
118+
authenticated connections with `auth_type=none` are not supported.
119+
76120
See more information in [Charm Architecture](https://charmhub.io/synapse/docs/explanation-charm-architecture).

0 commit comments

Comments
 (0)