Fix the TLS YAML format error in Manual (#289)

* fix the TLS yaml format error * minor fix
megaease · Feb 20, 2023 · 787b337 · 787b337
1 parent c7376df
commit 787b337
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 16 deletions.
diff --git a/docs/Manual.md b/docs/Manual.md
@@ -1018,20 +1018,22 @@ TLS ping to remote endpoint, can probe for revoked or expired certificates
 
 ```YAML
 tls:
-- name: expired test
+  - name: expired test
     host: expired.badssl.com:443
     proxy: socks5://proxy.server:1080 # Optional. Only support socks5.
-                                    # Also support the `ALL_PROXY` environment.
-    insecure_skip_verify: true # dont check cert validity
-    expire_skip_verify: true # dont check cert expire date
-    alert_expire_before: 168h # alert if cert expire date is before X, the value is a Duration, see https://pkg.go.dev/time#ParseDuration. example: 1h, 1m, 1s. expire_skip_verify must be false to use this feature.
+                                      # Also support the `ALL_PROXY` environment.
+    insecure_skip_verify: true # don't check cert validity
+    expire_skip_verify: true   # don't check cert expire date
+    alert_expire_before: 168h  # alert if cert expire date is before X, the value is a Duration,
+                               # see https://pkg.go.dev/time#ParseDuration. example: 1h, 1m, 1s.
+                               # expire_skip_verify must be false to use this feature.
     # root_ca_pem_path: /path/to/root/ca.pem # ignore if root_ca_pem is present
     # root_ca_pem: |
     #   -----BEGIN CERTIFICATE-----
-- name: untrust test
+  - name: untrust test
     host: untrusted-root.badssl.com:443
-    # insecure_skip_verify: true # dont check cert validity
-    # expire_skip_verify: true # dont check cert expire date
+    # insecure_skip_verify: true # don't check cert validity
+    # expire_skip_verify: true   # don't check cert expire date
     # root_ca_pem_path: /path/to/root/ca.pem # ignore if root_ca_pem is present
     # root_ca_pem: |
     #   -----BEGIN CERTIFICATE-----

diff --git a/resources/config.yaml b/resources/config.yaml
@@ -142,20 +142,22 @@ http: # http probes
 # --------------------- TLS Probe Configuration ---------------------
 #
 # tls:
-# - name: expired test
+#   - name: expired test
 #     host: expired.badssl.com:443
 #     proxy: socks5://proxy.server:1080 # Optional. Only support socks5.
-#                                     # Also support the `ALL_PROXY` environment.
-#     insecure_skip_verify: true # dont check cert validity
-#     expire_skip_verify: true # dont check cert expire date
-#     alert_expire_before: 168h # alert if cert expire date is before X, the value is a Duration, see https://pkg.go.dev/time#ParseDuration. example: 1h, 1m, 1s. expire_skip_verify must be false to use this feature.
+#                                       # Also support the `ALL_PROXY` environment.
+#     insecure_skip_verify: true # don't check cert validity
+#     expire_skip_verify: true   # don't check cert expire date
+#     alert_expire_before: 168h  # alert if cert expire date is before X, the value is a Duration,
+#                                # see https://pkg.go.dev/time#ParseDuration. example: 1h, 1m, 1s.
+#                                # expire_skip_verify must be false to use this feature.
 #     # root_ca_pem_path: /path/to/root/ca.pem # ignore if root_ca_pem is present
 #     # root_ca_pem: |
 #     #   -----BEGIN CERTIFICATE-----
-# - name: untrust test
+#   - name: untrust test
 #     host: untrusted-root.badssl.com:443
-#     # insecure_skip_verify: true # dont check cert validity
-#     # expire_skip_verify: true # dont check cert expire date
+#     # insecure_skip_verify: true # don't check cert validity
+#     # expire_skip_verify: true   # don't check cert expire date
 #     # root_ca_pem_path: /path/to/root/ca.pem # ignore if root_ca_pem is present
 #     # root_ca_pem: |
 #     #   -----BEGIN CERTIFICATE-----