Add SMTP via the smtp-integrator charm

.github/workflows/integration_test.yaml

@@ -12,5 +12,5 @@ jobs:
  chaos-enabled: false
  chaos-experiments: pod-delete
  trivy-image-config: "trivy.yaml"
- self-hosted-runner: true
- self-hosted-runner-label: "edge"
+ juju-channel: 3.1/stable
+ channel: 1.28-strict/stable

config.yaml

@@ -36,6 +36,10 @@ options:
  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.
+ notif_from:
+ type: string
+ description: 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:
  type: string
  description: |
@@ -53,31 +57,6 @@ options:
  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.
- smtp_enable_tls:
- type: boolean
- description: If enabled, STARTTLS will be used to use an encrypted SMTP
- connection.
- default: true
- smtp_host:
- type: string
- description: The hostname of the SMTP host used for sending emails.
- default: ''
- smtp_notif_from:
- type: string
- description: defines the "From" address to use when sending emails.
- It must be set if email sending is enabled. Defaults to server_name.
- smtp_pass:
- type: string
- description: The password if the SMTP server requires authentication.
- default: ''
- smtp_port:
- type: int
- description: The port of the SMTP server used for sending emails.
- default: 25
- smtp_user:
- type: string
- description: The username if the SMTP server requires authentication.
- default: ''
  trusted_key_servers:
  type: string
  description: Comma separated list of trusted servers to download signing

docs/how-to/configure-smtp.md

@@ -0,0 +1,36 @@
+# How to integrate with SMTP for sending notifications
+
+This document shows how to integrate Synapse with SMTP for sending
+emails. Synapse should be deployed beforehand.
+
+## Deploy smtp-integrator charm
+
+For synapse to use SMTP, it uses the smtp-integrator charm. Replace the configuration options with your specific configuration.
+Configuring SMTP without tls or starttls or without authentication is not supported.
+
+```
+juju deploy smtp-integrator --channel edge
+juju config smtp-integrator host=<smtp host> port=<smtp port> user=<smtp auth user> password=<smtp auth password> auth_type=plain transport_security=tls
+```
+
+## Configure email to use in `From`
+
+Configure the "From" mail for Synapse with:
+```
+juju config synapse notif_from=<email to use in the "From" address>
+```
+
+## Integrate with Synapse
+
+You can run it with the legacy integration `smtp-legacy` or with
+the new integration using secrets `smtp`. A Juju version
+with secrets is required for the `smtp` integration.
+
+With the old integration without using secrets, run:
+```
+juju integrate smtp-integrator:smtp-legacy synapse:smtp
+```
+For the new integration with secrets, run:
+```
+juju integrate smtp-integrator:smtp synapse:smtp
+```

docs/how-to/contribute.md

@@ -84,7 +84,7 @@ the registry:
  skopeo --insecure-policy copy oci-archive:synapse_1.0_amd64.rock docker-daemon:localhost:32000/synapse:latest
  docker push localhost:32000/synapse:latest
  cd [project_dir]/nginx_rock && rockcraft pack rockcraft.yaml
- skopeo --insecure-policy copy oci-archive:synapse_nginx_1.0_amd64.rock docker-daemon:localhost:32000/synapse-nginx:latest
+ skopeo --insecure-policy copy oci-archive:synapse-nginx_1.0_amd64.rock docker-daemon:localhost:32000/synapse-nginx:latest
  docker push localhost:32000/synapse-nginx:latest
 
 ### Deploy

docs/index.md

@@ -28,7 +28,8 @@ If there’s a particular area of documentation that you’d like to see that’
 1. [Tutorial](tutorial)
  1. [Getting Started](tutorial/getting-started.md)
 1. [How to](how-to)
- 1. [Contribute](how-to/contribute.md)
+ 1. [Configure SMTP](how-to/configure-smtp.md)
+ 2. [Contribute](how-to/contribute.md)
 1. [Reference](reference)
  1. [Actions](reference/actions.md)
  1. [Integrations](reference/integrations.md)

docs/reference/integrations.md

@@ -73,4 +73,24 @@ Note that `public_baseurl` configuration set the public-facing base URL that
 clients use to access this Homeserver. It's used as `entity_id` if set instead of
 https://server_name.
 
-See more information in [Charm Architecture](https://charmhub.io/synapse/docs/explanation-charm-architecture).
+See more information in [Charm Architecture](https://charmhub.io/synapse/docs/explanation-charm-architecture).
+
+
+### smtp
+
+_Interface_: smtp
+_Supported charms_: [smtp-integrator](https://charmhub.io/smtp-integrator/)
+
+Integrating Synapse with SMTP Integrator provides SMTP configuration details so
+a smtp server can be used in Synapse.
+
+Example smtp integrate command: `juju integrate synapse smtp-integrator:smtp`
+
+Note that the smtp-integrator provides two interfaces, `smtp` and `smtp-legacy`. 
+Only use the first one if the Juju version used supports secrets. The "From" email
+is set with the Synapse configuration option `notif_from`.
+
+For the smtp-integrator, insecure configurations with `transport_security=none` or not
+authenticated connections with `auth_type=none` are not supported.
+
+See more information in [Charm Architecture](https://charmhub.io/synapse/docs/explanation-charm-architecture).