Configure Email Service¶

Introduction¶

This article will demonstrate how to configure the email alert service for Guance.

Prerequisites¶

• Guance has been fully initialized.
• You have the information of the email service:
  • host
  • port
  • useTLS
  • user
  • password
  • useSSL
  • usePlainAuth

Configuration Steps¶

Step One: Test Email Service Information¶

Execute the following Python script in the message-desk-worker pod under middleware, modify the host, port, sender, password, use_tls, recipient, useSSL, usePlainAuth parameters, and run it to test if the configuration is correct.

cat <<EOF> test-maile.py
from mailer import Mailer
from mailer import Message

host = 'smtp.example.com'
port = 587
sender = 'your_email@example.com'
password = 'your_email_password'
use_tls = True
recipient = 'recipient@example.com'
use_ssl = False
use_plain_auth = False

message = Message(From=sender, To=recipient)
message.Subject = 'Test email'
message.Body = 'This is a test email'

mailer = Mailer(host=host, port=587, use_tls=use_tls, usr=sender, pwd=password, use_plain_auth=use_plain_auth, use_ssl=use_ssl)

try:
    mailer.send(message)
    print('Email sent successfully.')
except Exception as e:
    print('Error:', e)
EOF

Run the Python script:

python test-maile.py

Check the execution result:

Step Two: Modify Service Configuration¶

1. Log in to Launcher, click on the configuration in the top-right corner.
2. Select "Modify Service Configuration"

# Email SMTP, please fill in the following configuration values according to your email service information
CUSTOM_MESSAGE_DESK_MAIL_HOST: 'smtpdm.aliyun.com'
CUSTOM_MESSAGE_DESK_MAIL_PORT: 465
CUSTOM_MESSAGE_DESK_MAIL_USE_SSL: true
CUSTOM_MESSAGE_DESK_MAIL_USE_TLS: false
CUSTOM_MESSAGE_DESK_MAIL_USE_PLAIN_AUTH: true
CUSTOM_MESSAGE_DESK_MAIL_FROM: 'xxxxx <noreply@xxxxx.cn>'
CUSTOM_MESSAGE_DESK_MAIL_USER: 'xxxxx@xxxxx.cn'
CUSTOM_MESSAGE_DESK_MAIL_PASSWORD: 'xxxxx'

Step Three: Testing and Troubleshooting¶

You can create incorrect alert configurations to manually trigger alert settings.

You can refer to Monitor Troubleshooting to troubleshoot issues.