api/email.yaml at main · compliance-framework/api · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
enabled: true
provider: "smtp"
providers:
  smtp:
    name: SMTP
    provider: "smtp"
    enabled: true
    host: "localhost"
    port: 2525
    username: "testuser"
    password: "testpass"
    from: "noreply@compliance-framework.local"
    from_name: "Compliance Framework"
    use_ssl: false
    use_tls: false

  # AWS SES Configuration
  ses:
    name: "AWS SES"
    enabled: false
    region: "us-east-1"
    ### Programmatic key support
    ## these can be added as enviornment variables
    #( CCF_EMAIL_PROVIDERS_SES_ACCESS_KEY_ID,
    # CCF_EMAIL_PROVIDERS_SES_SECRET_ACCESS_KEY,
    # CCF_EMAIL_PROVIDERS_SES_SESSION_TOKEN)
    ## Alternatively, if you are using any sort of Workload Identity (Pod Identity, IRSA)
    ## the API will default to use those credentials instead
    ## In that case, leave these empty
    access_key_id: "your-access-key"
    secret_access_key: "your-secret-key"
    session_token: "your-session-token"
    from: "noreply@compliance-framework.local"
    from_name: "Compliance Framework"

  # Example for SendGrid (not implemented yet)
  # sendgrid:
  #   name: "SendGrid"
  #   provider: "sendgrid"
  #   enabled: false
  #   host: ""  # API key would be configured here
  #   port: 0
  #   username: ""
  #   password: ""
  #   use_tls: false
  #   use_ssl: false