Added support to SMTP server for password recovery (#5)

orb-community · Dec 1, 2021 · 93ac087 · 93ac087
1 parent 463d28d
commit 93ac087
Show file tree

Hide file tree

Showing 4 changed files with 34 additions and 1 deletion.
diff --git a/charts/orb/Chart.yaml b/charts/orb/Chart.yaml
@@ -10,7 +10,7 @@ name: orb
 description: Orb Observability Platform
 icon: https://avatars1.githubusercontent.com/u/13207490
 type: application
-version: 1.0.6
+version: 1.0.7
 appVersion: "0.9.0"
 home: https://getorb.io
 sources:

diff --git a/charts/orb/README.md b/charts/orb/README.md
@@ -71,8 +71,19 @@ helm install cert-manager jetstack/cert-manager --namespace cert-manager --creat
   * `kubectl create -f issuers/production-issuer.yaml -n orb`
 
 * Install orb. Replace `my-orb` with your helm release name.
+Check the [optional variables](#optional-variables-to-set) for more options. 
 
 ```
 helm install --set ingress.hostname=HOSTNAME -n orb my-orb .
 ```
 
+### Optional variables to set
+- **SMTP**
+
+   Set the following variables to enable SMTP support for password recovery:
+  - `smtp.host`: SMTP server hostname to send e-mails to.
+  - `smtp.port`: SMTP server port, defaults to `25`.
+  - `smtp.fromName`: E-mail sender display name. Defaults to `Orb`.
+  - `smtp.fromAddress`: E-mail address of the sender.
+  - `smtp.usernmame`: username used when authenticating to the SMTP server used for sending e-emails. 
+  - `smtp.password`: password used when authenticating to the SMTP server used for sending e-emails.
diff --git a/charts/orb/templates/users-deployment.yaml b/charts/orb/templates/users-deployment.yaml
@@ -65,6 +65,23 @@ spec:
                 secretKeyRef:
                   name: {{ .Values.users.admin.secretName }}
                   key: {{ .Values.users.admin.passwordSecretKey }}
+
+            {{- if .Values.orb.smtp.host }}
+            - name: MF_EMAIL_HOST
+              value: {{ .Values.orb.smtp.host | quote }}
+            - name: MF_EMAIL_PORT
+              value: {{ .Values.orb.smtp.port | quote }}
+            - name: MF_EMAIL_USERNAME
+              value: {{ required "A valid .Values.orb.smtp.username is required!" .Values.orb.smtp.username | quote }}
+            - name: MF_EMAIL_PASSWORD
+              value: {{ required "A valid .Values.orb.smtp.password is required!" .Values.orb.smtp.password | quote }}
+            - name: MF_EMAIL_FROM_ADDRESS
+              value: {{ required "A valid .Values.orb.smtp.fromAddress is required!" .Values.orb.smtp.fromAddress | quote }}
+            - name: MF_EMAIL_FROM_NAME
+              value: {{ .Values.orb.smtp.fromName | quote }}
+            - name: MF_EMAIL_TEMPLATE
+              value: "/email.tmpl"
+            {{- end }}
           image: "{{ default .Values.defaults.image.mfRepository .Values.users.image.repository }}/users:{{ default .Values.defaults.image.mfTag .Values.users.image.tag }}"
           imagePullPolicy: {{ default .Values.defaults.image.pullPolicy .Values.users.image.pullPolicy }}
           name: {{ .Release.Name }}-users

diff --git a/charts/orb/values.yaml b/charts/orb/values.yaml
@@ -19,6 +19,11 @@ defaults:
   natsPort: 4222
   jaegerPort: 6831
 
+orb:
+  smtp:
+    port: 25
+    fromName: Orb
+
 ingress:
   issuer: "letsencrypt-prod"
   hostname: ""