Skip to content

Commit 787b337

Browse files
authored
Fix the TLS YAML format error in Manual (#289)
* fix the TLS yaml format error * minor fix
1 parent c7376df commit 787b337

File tree

2 files changed

+20
-16
lines changed

2 files changed

+20
-16
lines changed

docs/Manual.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1018,20 +1018,22 @@ TLS ping to remote endpoint, can probe for revoked or expired certificates
10181018
10191019
```YAML
10201020
tls:
1021-
- name: expired test
1021+
- name: expired test
10221022
host: expired.badssl.com:443
10231023
proxy: socks5://proxy.server:1080 # Optional. Only support socks5.
1024-
# Also support the `ALL_PROXY` environment.
1025-
insecure_skip_verify: true # dont check cert validity
1026-
expire_skip_verify: true # dont check cert expire date
1027-
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.
1024+
# Also support the `ALL_PROXY` environment.
1025+
insecure_skip_verify: true # don't check cert validity
1026+
expire_skip_verify: true # don't check cert expire date
1027+
alert_expire_before: 168h # alert if cert expire date is before X, the value is a Duration,
1028+
# see https://pkg.go.dev/time#ParseDuration. example: 1h, 1m, 1s.
1029+
# expire_skip_verify must be false to use this feature.
10281030
# root_ca_pem_path: /path/to/root/ca.pem # ignore if root_ca_pem is present
10291031
# root_ca_pem: |
10301032
# -----BEGIN CERTIFICATE-----
1031-
- name: untrust test
1033+
- name: untrust test
10321034
host: untrusted-root.badssl.com:443
1033-
# insecure_skip_verify: true # dont check cert validity
1034-
# expire_skip_verify: true # dont check cert expire date
1035+
# insecure_skip_verify: true # don't check cert validity
1036+
# expire_skip_verify: true # don't check cert expire date
10351037
# root_ca_pem_path: /path/to/root/ca.pem # ignore if root_ca_pem is present
10361038
# root_ca_pem: |
10371039
# -----BEGIN CERTIFICATE-----

resources/config.yaml

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -142,20 +142,22 @@ http: # http probes
142142
# --------------------- TLS Probe Configuration ---------------------
143143
#
144144
# tls:
145-
# - name: expired test
145+
# - name: expired test
146146
# host: expired.badssl.com:443
147147
# proxy: socks5://proxy.server:1080 # Optional. Only support socks5.
148-
# # Also support the `ALL_PROXY` environment.
149-
# insecure_skip_verify: true # dont check cert validity
150-
# expire_skip_verify: true # dont check cert expire date
151-
# 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.
148+
# # Also support the `ALL_PROXY` environment.
149+
# insecure_skip_verify: true # don't check cert validity
150+
# expire_skip_verify: true # don't check cert expire date
151+
# alert_expire_before: 168h # alert if cert expire date is before X, the value is a Duration,
152+
# # see https://pkg.go.dev/time#ParseDuration. example: 1h, 1m, 1s.
153+
# # expire_skip_verify must be false to use this feature.
152154
# # root_ca_pem_path: /path/to/root/ca.pem # ignore if root_ca_pem is present
153155
# # root_ca_pem: |
154156
# # -----BEGIN CERTIFICATE-----
155-
# - name: untrust test
157+
# - name: untrust test
156158
# host: untrusted-root.badssl.com:443
157-
# # insecure_skip_verify: true # dont check cert validity
158-
# # expire_skip_verify: true # dont check cert expire date
159+
# # insecure_skip_verify: true # don't check cert validity
160+
# # expire_skip_verify: true # don't check cert expire date
159161
# # root_ca_pem_path: /path/to/root/ca.pem # ignore if root_ca_pem is present
160162
# # root_ca_pem: |
161163
# # -----BEGIN CERTIFICATE-----

0 commit comments

Comments
 (0)