Skip to content

Commit 4a554f7

Browse files
committed
docs: update the gmail notification service to reflect the correct configs
Signed-off-by: Afzal Ansari <[email protected]>
1 parent e3fe626 commit 4a554f7

File tree

1 file changed

+17
-4
lines changed

1 file changed

+17
-4
lines changed

docs/services/email.md

+17-4
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,19 @@ The Email notification service sends email notifications using SMTP protocol and
1212
* `html` - optional bool, true or false
1313
* `insecure_skip_verify` - optional bool, true or false
1414

15+
### Using Gmail
16+
17+
When configuring Gmail as the SMTP service:
18+
19+
* `username` - Must be your Gmail address.
20+
* `password` - Use an App Password, not your regular Gmail password.
21+
22+
To Generate an app password, follow this link https://myaccount.google.com/apppasswords
23+
24+
!!! note
25+
This applies to personal Gmail accounts (non-Google Workspace). For Google Workspace users, SMTP settings
26+
and authentication methods may differ.
27+
1528
## Example
1629

1730
The following snippet contains sample Gmail service configuration:
@@ -23,11 +36,11 @@ metadata:
2336
name: argocd-notifications-cm
2437
data:
2538
service.email.gmail: |
26-
username: $email-username
27-
password: $email-password
39+
username: $username
40+
password: $password
2841
host: smtp.gmail.com
2942
port: 465
30-
from: $email-username
43+
from: $email-address
3144
```
3245
3346
Without authentication:
@@ -41,7 +54,7 @@ data:
4154
service.email.example: |
4255
host: smtp.example.com
4356
port: 587
44-
from: $email-username
57+
from: $email-address
4558
```
4659
4760
## Template

0 commit comments

Comments
 (0)