From d07d3434a61134b739cdf2a5d7c80d1ab9f7307f Mon Sep 17 00:00:00 2001 From: TwinProduction Date: Sat, 5 Jun 2021 16:35:18 -0400 Subject: [PATCH] #120: Add documentation for STARTTLS --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 729d317d..2129da88 100644 --- a/README.md +++ b/README.md @@ -57,6 +57,7 @@ For more details, see [Usage](#usage) - [Monitoring a TCP service](#monitoring-a-tcp-service) - [Monitoring a service using ICMP](#monitoring-a-service-using-icmp) - [Monitoring a service using DNS queries](#monitoring-a-service-using-dns-queries) + - [Monitoring a service using STARTTLS](#monitoring-a-service-using-starttls) - [Basic authentication](#basic-authentication) - [disable-monitoring-lock](#disable-monitoring-lock) - [Reloading configuration on the fly](#reloading-configuration-on-the-fly) @@ -810,10 +811,24 @@ There are two placeholders that can be used in the conditions for services of ty `NOERROR`, `FORMERR`, `SERVFAIL`, `NXDOMAIN`, etc. +### Monitoring a service using STARTTLS + +If you have an email server that you want to ensure there are no problems with, monitoring it through STARTTLS +will serve as a good initial indicator: +```yaml +services: + - name: starttls-smtp-example + url: "starttls://smtp.gmail.com:587" + interval: 30m + conditions: + - "[CONNECTED] == true" + - "[CERTIFICATE_EXPIRATION] > 48h" +``` + + ### Basic authentication You can require Basic authentication by leveraging the `security.basic` configuration: - ```yaml security: basic: