Zum Hauptinhalt springen
Version: Weekly Build

E-Mail-Zustellung

Codesphere verwendet E-Mails für Konto- und Resource-Group-Workflows wie Einladungen und Authentifizierungsnachrichten. Die E-Mail-Zustellung ist optional, allerdings versenden diese Workflows keine Nachrichten, solange weder SendGrid noch ein eigener SMTP-Server konfiguriert ist.

Einen eigenen SMTP-Server verwenden​

Füge die SMTP-Verbindungseinstellungen unter codesphere.email in config.yaml hinzu:

codesphere:
  email:
    provider: smtp
    smtp:
      host: smtp.example.com
      port: 587
      secure: false
      username: codesphere

provider muss smtp sein. Setze secure: true für implizites TLS, üblicherweise auf Port 465. Setze den Wert auf false für eine Verbindung, die per STARTTLS aufgewertet werden kann, üblicherweise auf Port 587. Lasse username weg, wenn der Server keine Authentifizierung erfordert.

Wenn der SMTP-Server ein Passwort erfordert, füge es in prod.vault.yaml hinzu; platziere es niemals in config.yaml:

secrets:
  - name: smtpPassword
    fields:
      password: <smtp-password>

Konfiguriere username, sobald smtpPassword vorhanden ist. Das Passwort ist optional, wenn der gewählte Server oder Authentifizierungsmechanismus keines benötigt.

Das SMTP-Relay von SendGrid verwenden​

Bestehende Installationen können ihren SendGrid-API-Schlüssel weiterhin im Vault hinterlegen:

secrets:
  - name: sendGridApiKey
    fields:
      password: <sendgrid-api-key>

Für diese Option ist kein email-Block erforderlich. Der Installer konfiguriert das SMTP-Relay von SendGrid unter smtp.sendgrid.net mit dem Benutzernamen apikey, Port 587 und secure: false. Wenn sowohl sendGridApiKey als auch eigene SMTP-Einstellungen vorhanden sind, hat SendGrid Vorrang. Entferne sendGridApiKey aus dem Vault, um eine bestehende Installation auf den eigenen SMTP-Server umzustellen.

Sowohl sendGridApiKey als auch smtpPassword sind optionale Installer-Secrets. Ist weder ein SendGrid-API-Schlüssel noch ein SMTP-Host konfiguriert, startet Codesphere normal, stellt jedoch keine E-Mails zu. Es wird eine Warnung protokolliert und lediglich vermerkt, dass eine E-Mail hätte gesendet werden sollen; der Inhalt der Nachricht wird nicht protokolliert.

Das vollständige Schema und die Übersicht aller Secrets findest du unter Referenz zur Installer-Konfiguration für Private Cloud und Vault-Secrets des Private-Cloud-Installers.