Starting with version 2.7.0, the Resilio Connect Management Console can send an e-mail to the Admin when a job run is complete and when files in a Sync job are synced. Resilio Connect v2.11 also allows to send an e-mail when some events happens in MC.
It is done in two steps - setting mail server and configuring mail notifications.
Set up mail server
To start with, admin shall setup mail server in Management Console General settings.
Starting with v3.0.0, SMTP configuration allows choice of encryption method, depending on which method is support by the SMTP server itself.
Use anonymous SMTP server
Enable this option if your SMTP server accepts non-authenticated login. Otherwise, an authentication error will be reported. For better Security, Resilio, Inc. always recommends to set up an authenticated SMTP Server.
Starting with Resilio Connect v2.9 self-signed certificates can be verified through Management Console advanced settings. Add a certificate to the trusted CA and put the Console's address with port (8443 by default) there. Use DNS name for MC to be reached out through it, otherwise IP address will be used by default.
Verify Server certificate
Deprecated in version 2.9
Many SMTP servers make use of (self-signed) certificates. If such a cert cannot be verified for any reason, a connection to the SMTP server will not be possible. Uncheck this parameter to skip cert verification.
SMTP server configuration peculiarities
While configuring SMTP server please keep in mind following peculiarities:
- While it is common to use port 25 for non-TLS encrypted connections and port 465 for TLS-encrypted connections, it is not mandatory and up to your server configuration. The port number does not specify protection.
- The SMTP server hostname MUST match the hostname of your server certificate
- the "Use TLS" checkbox only controls if TLS channel is established from the very beginning of the session. Your SMTP server may demand to establish TLS later to accept credentials regardless of unchecked "Use TLS" checkbox.
- Anonymous authentication not supported, you must supply username and password.
- If your SMTP server is using a self-signed certificate, ensure Management Console is aware of this certificate. To do it, place it in PEM format anywhere on Management Server and set a global environment variable "NODE_EXTRA_CA_CERTS=<path_to_file>"
Resilio Connect does not in any way perform verification of the mail server or the e-mail addresses that will be used in job notifications. If a configured e-mail address is not valid or bounces mails, MC is not going to report it.
Connection without TLS over port 25Some email servers allow connecting over port 25 without TLS, though in some cases email server can tell Connect server that it supports TLS. Connect server will try to verify the certificate from the email server and it might not work if the certificate is self-signed. Adding an email server's self-signed certificate as an environment variable (NODE_EXTRA_CA_CERTS=file) containing a path to the PEM file might help. Check the following article: Adding self-signed certificates in NodeJS
Configure e-mail notifications
It's possible to send a notification to a Management Console user, or simply any e-mail address not necessarily related to MC user. Even "View Only" users can receive e-mails.
A webhook can be also used as a recipient of a notification.
Job run e-mails
Each job can send a notification to inform the Admin about job run completions. They mainly reflect the job run summary from the Management Console. To set up an e-mail notification go to Jobs -> Configure job.
Starting with Resilio Connect v2.9, it's also possible to configure notifications from MC Settings -> Notifications tab, for All jobs or for a specific job. Multi select of several jobs is not supported though.
Trigger fires an e-mail or webhook notification. Depending on a selected trigger additional context settings apply.
Job run finished:
Meaning that all online Agents completed the transfer and executed scripts. There are no Agents with 'failed' status. Available for all jobs. For sync jobs notifications are sent when new or updated files are synced, basically when job's status changes from 'syncing' to 'synced'.
There's also a checkbox to not send an email if no data was transferred during the run. This is especially useful for jobs that are scheduled to run periodically but they don't necessarily have new data to transfer.
This trigger will also send e-mail if the job run was aborted manually or timed out honoring the timeout setting in job profile.
Job run finished with errors:
Meaning that job completed but some of the Agents are with status 'failed' and/or have some error. This trigger is not available for Sync jobs.
Job run not complete:
It will send a notification if a job (or a job run) didn't reach status 'Finished' or 'Synced' within the configured time period. It's useful in cases when Admin knows the approximate time required for job completion to be notified about it taking more than expected. Available for all types of jobs.
A notification will be sent on every new error that appears on an agent in a job run. There's an option to delay the notification by some time and send it only if the error is pending for more than a configured number of minutes. It's also possible to set up a notification about error being cleared.
If an error is ignored, it won't trigger an e-mail or webhook.
Errors are added here per error code mentioned in this guide. Multi select is not available though.
Starting with Resilio Connect v2.11, e-mails can be sent after an event in Management Console. These can be configured only from MC settings -> Notifications. Select "Add event subscription and choose one of the events.
Agent pending approval:
If there's a new request for approval, e-mail or webhook notification is triggered. It contains information about the agent, it's name.
Means that a new agent with new agentID appeared on Management Console or an agent was removed from the Management Console. This event may be sent after a backup was restored even though no new agents were added actually.
Proxy/tracker not reachable
If a proxy server or a tracker server lose connection to the Management Console. Default timeout for this e-mail is 10 minutes.