Merge pull request #2634 from YingjieQiao/docs/cert_reqs

docs: add examples for cert-reqs
benoitc · May 11, 2023 · f859de4 · f859de4
2 parents f955a0c + 0215f5d
commit f859de4
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/docs/source/settings.rst b/docs/source/settings.rst
@@ -554,6 +554,16 @@ TLS_SERVER    Auto-negotiate the highest protocol version like TLS,
 
 Whether client certificate is required (see stdlib ssl module's)
 
+**Options:** 
+
+`--cert-reqs=0` --- no client veirifcation
+
+`--cert-reqs=1` --- ssl.CERT_OPTIONAL
+
+`--cert-reqs=2` --- ssl.CERT_REQUIRED
+
+
+
 .. _ca-certs:
 
 ``ca_certs``

diff --git a/gunicorn/config.py b/gunicorn/config.py
@@ -2149,6 +2149,13 @@ class CertReqs(Setting):
     default = ssl.CERT_NONE
     desc = """\
     Whether client certificate is required (see stdlib ssl module's)
+    ==============  ===========================
+    `--cert-reqs=0` --- no client veirifcation
+
+    `--cert-reqs=1` --- ssl.CERT_OPTIONAL
+
+    `--cert-reqs=2` --- ssl.CERT_REQUIRED
+    ==============  ===========================
     """