Skip to content

Commit 434d60f

Browse files
committed
Update README For Changed SMTP Configuration
Signed-off-by: Yannik Fuhrmeister <yannik.fuhrmeister@iteratec.com>
1 parent 39e7d43 commit 434d60f

2 files changed

Lines changed: 37 additions & 22 deletions

File tree

‎hooks/notification-hook/README.md‎

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -109,21 +109,28 @@ To configure an email notification set the `type` to `email` and the `endPoint`
109109
You can use one of the following default templates:
110110
* email
111111
112-
Additional to this configuration you will have to provide a special smtp configuration.
113-
This config reflects the transporter configuration of nodemailer (See [nodemailer | SMTP Transport](https://nodemailer.com/smtp/)) and should be written in `YAML`.
114-
To provide the `from` field of the email we extended the nodemailer configuration with the `from` field in the transporter configuration.
112+
Additional to this configuration you will have to provide a special smtp configuration URL.
113+
This config reflects the transporter configuration of nodemailer (See [nodemailer | SMTP Transport](https://nodemailer.com/smtp/)).
115114
This configuration needs to be specified under `env` in the values yaml.
116115
The identifier for this config has to be `SMTP_CONFIG`.
117116
A basic configuration could look like this:
118117
119-
```yaml
120-
host: smtp.ethereal.email
121-
port: 587
122-
secure: false
123-
auth:
124-
user: some_user
125-
pass: some_password
126-
from: secureCodeBox <mail@from.someone>
118+
```
119+
...
120+
env:
121+
- name: SMTP_CONFIG
122+
value: "smtp://kaden.lueilwitz48@ethereal.email:pezuHHseu8sS2QGcRS@smtp.ethereal.email/"
123+
```
124+
125+
To provide a custom `from` field for your email you can specify `EMAIL_FROM` under env.
126+
For example:
127+
128+
```
129+
env:
130+
- name: SMTP_CONFIG
131+
value: "smtp://kaden.lueilwitz48@ethereal.email:pezuHHseu8sS2QGcRS@smtp.ethereal.email/"
132+
- name: EMAIL_FROM
133+
value: secureCodeBox
127134
```
128135
129136
## Custom Message Templates

‎hooks/notification-hook/README.md.gotmpl‎

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -109,22 +109,30 @@ To configure an email notification set the `type` to `email` and the `endPoint`
109109
You can use one of the following default templates:
110110
* email
111111

112-
Additional to this configuration you will have to provide a special smtp configuration.
113-
This config reflects the transporter configuration of nodemailer (See [nodemailer | SMTP Transport](https://nodemailer.com/smtp/)) and should be written in `YAML`.
114-
To provide the `from` field of the email we extended the nodemailer configuration with the `from` field in the transporter configuration.
112+
Additional to this configuration you will have to provide a special smtp configuration URL.
113+
This config reflects the transporter configuration of nodemailer (See [nodemailer | SMTP Transport](https://nodemailer.com/smtp/)).
115114
This configuration needs to be specified under `env` in the values yaml.
116115
The identifier for this config has to be `SMTP_CONFIG`.
117116
A basic configuration could look like this:
118117

119-
```yaml
120-
host: smtp.ethereal.email
121-
port: 587
122-
secure: false
123-
auth:
124-
user: some_user
125-
pass: some_password
126-
from: secureCodeBox <mail@from.someone>
127118
```
119+
...
120+
env:
121+
- name: SMTP_CONFIG
122+
value: "smtp://kaden.lueilwitz48@ethereal.email:pezuHHseu8sS2QGcRS@smtp.ethereal.email/"
123+
```
124+
125+
To provide a custom `from` field for your email you can specify `EMAIL_FROM` under env.
126+
For example:
127+
128+
```
129+
env:
130+
- name: SMTP_CONFIG
131+
value: "smtp://kaden.lueilwitz48@ethereal.email:pezuHHseu8sS2QGcRS@smtp.ethereal.email/"
132+
- name: EMAIL_FROM
133+
value: secureCodeBox
134+
```
135+
128136

129137
## Custom Message Templates
130138

0 commit comments

Comments
 (0)