diff --git a/docs/docs/rad-lab-ui/troubleshooting.md b/docs/docs/rad-lab-ui/troubleshooting.md index d336c01c..c2be1851 100644 --- a/docs/docs/rad-lab-ui/troubleshooting.md +++ b/docs/docs/rad-lab-ui/troubleshooting.md @@ -3,10 +3,19 @@ sidebar_position: 4 --- # Troubleshooting -### Email Server setup -Email notifications are customizable,Admins can `enable` or `disable` email notifications on `Global Variables` setup. -Inorder to proceed with email notifications admin has to store the email server (smtp server or a dedicated e-mail) credentials as part of `Global Variables`. +Please feel free to reach out and to create a [GitHub issue](https://github.com/GoogleCloudPlatform/rad-lab/issues) in case of any issues or concerns. -`MAIL SERVER EMAIL` will be stored in `firestore` and `MAIL SERVER PASSWORD` will be securly stored on `Google Secret Manager` +## Email Notifications +You can optionally enable RAD Lab notification for deployment events. This includes deployment creations, updates, and deletions. + +If enabled, the following users/groups (defined in the module's Terraform variables) will receive email notifications: +- The individual taking the action +- `trusted_users` +- `trusted_groups` +- `owner_users` +- `owner_groups` + +Currently only sending via gmail is supported. It is recommended to [create a new gmail address](https://support.google.com/mail/answer/56256?hl=en) for this purpose only. Do **not** enable two factor authentication (2FA) on this account. You will then provide this email and its password to RAD Lab UI via the `Global Variables` setup. + +The email address will be store in Firestore, and email password will be securely stored in Google's [Secret Manager](https://cloud.google.com/secret-manager) -Please feel free to reach out and to create a [GitHub issue](https://github.com/GoogleCloudPlatform/rad-lab/issues) in case of any issues or concerns.